New-AzApiManagementBackend

Module:

Az.ApiManagement

Creates a new backend entity.

Syntax

New-AzApiManagementBackend
   -Context <PsApiManagementContext>
   [-BackendId <String>]
   -Protocol <String>
   -Url <String>
   [-ResourceId <String>]
   [-Title <String>]
   [-Description <String>]
   [-SkipCertificateChainValidation <Boolean>]
   [-SkipCertificateNameValidation <Boolean>]
   [-Credential <PsApiManagementBackendCredential>]
   [-Proxy <PsApiManagementBackendProxy>]
   [-ServiceFabricCluster <PsApiManagementServiceFabric>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates a new backend entity in Api Management.

Examples

Example 1: Create Backend 123 with a Basic Authorization Scheme

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$credential = New-AzApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')}

$backend = New-AzApiManagementBackend -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

Parameters

-BackendId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Context

Instance of PsApiManagementContext. This parameter is required.

Type:	PsApiManagementContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Credential

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

Type:	PsApiManagementBackendCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Backend Description. This parameter is optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Protocol

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

Type:	String
Accepted values:	http, soap
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Proxy

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

Type:	PsApiManagementBackendProxy
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

Management Uri of the Resource in External System. The absolute http URL of the Azure Resource. This parameter is optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ServiceFabricCluster

Service Fabric Cluster Backend details. This parameter is optional.

Type:	PsApiManagementServiceFabric
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SkipCertificateChainValidation

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

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SkipCertificateNameValidation

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

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Title

Backend Title. This parameter is optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Url

Runtime Url for the Backend. This parameter is required.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementBackendCredential

PsApiManagementBackendProxy

PsApiManagementServiceFabric

Outputs

PsApiManagementBackend

Related Links

• Get-AzApiManagementBackend
• New-AzApiManagementBackendCredential
• New-AzApiManagementBackendProxy
• Set-AzApiManagementBackend
• Remove-AzApiManagementBackend