New-AzureRmApiManagementBackend

NAME New-AzureRmApiManagementBackend



SYNOPSIS

Creates a new backend entity.





SYNTAX

New-AzureRmApiManagementBackend [-BackendId <String>] -Context <PsApiManagementContext> [-Credential <PsApiManagementBackendCredential>]

[-DefaultProfile <IAzureContextContainer>] [-Description <String>] -Protocol {http | soap} [-Proxy <PsApiManagementBackendProxy>] [-ResourceId

<String>] [-SkipCertificateChainValidation <Boolean>] [-SkipCertificateNameValidation <Boolean>] [-Title <String>] -Url <String> [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

Creates a new backend entity in Api Management.





PARAMETERS

-BackendId <String>

Identifier of new backend. This parameter is optional. If not specified will be generated.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Context <PsApiManagementContext>

Instance of PsApiManagementContext. This parameter is required.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Credential <PsApiManagementBackendCredential>

Credential details which should be used when talking to the Backend. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

Backend Description. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Protocol <String>

Backend Communication protocol. This parameter is required. Valid values are 'http' and 'soap'.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Proxy <PsApiManagementBackendProxy>

Proxy Server details to be used while sending request to the Backend. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceId <String>

Management Uri of the Resource in External System. This parameter is optional. This url can be the Arm Resource Id of Logic Apps, Function

Apps or Api Apps.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SkipCertificateChainValidation <Boolean>

Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SkipCertificateNameValidation <Boolean>

Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Title <String>

Backend Title. This parameter is optional.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Url <String>

Runtime Url for the Backend. This parameter is required.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend







NOTES









Create Backend 123 with a Basic Authorization Scheme



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>$credential = New-AzureRmApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query

@{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')}



PS C:\\>$backend = New-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http

-Title "first backend" -SkipCertificateChainValidation $true -Credential $credential -Description "my backend"



Creates a new Backend







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... entbackend

Get-AzureRmApiManagementBackend

New-AzureRmApiManagementBackendCredential

New-AzureRmApiManagementBackendProxy

Set-AzureRmApiManagementBackend

Remove-AzureRmApiManagementBackend