Set-​Azure​Rm​Api​Management​Backend

Updates a Backend.

Syntax

Set-AzureRmApiManagementBackend
   -BackendId <String>
   -Context <PsApiManagementContext>
   [-Credential <PsApiManagementBackendCredential>]
   [-Description <String>]
   [-PassThru]
   [-Protocol <String>]
   [-Proxy <PsApiManagementBackendProxy>]
   [-ResourceId <String>]
   [-SkipCertificateChainValidation <Boolean>]
   [-SkipCertificateNameValidation <Boolean>]
   [-Title <String>]
   [-Url <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Updates an existing backend in the Api Management.

Examples

Updates the Description of the Backend 123

Set-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru

Required Parameters

-BackendId

Identifier of new backend. This parameter is required.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Context

Instance of PsApiManagementContext. This parameter is required.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Description

Backend Description. This parameter is optional.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Protocol

Backend Communication protocol (http or soap). This parameter is optional

Type:String
Parameter Sets:http, soap
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceId

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SkipCertificateChainValidation

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

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SkipCertificateNameValidation

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

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Title

Backend Title. This parameter is optional.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Url

Runtime Url for the Backend. This parameter is optional.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Outputs

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