Set-AzApiManagementBackend
Syntax
ContextParameterSet (Default)
Set-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>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzApiManagementBackend
-InputObject <PsApiManagementBackend>
[-Protocol <String>]
[-Url <String>]
[-ResourceId <String>]
[-Title <String>]
[-Description <String>]
[-SkipCertificateChainValidation <Boolean>]
[-SkipCertificateNameValidation <Boolean>]
[-Credential <PsApiManagementBackendCredential>]
[-Proxy <PsApiManagementBackendProxy>]
[-ServiceFabricCluster <PsApiManagementServiceFabric>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates an existing backend in the Api Management.
Examples
Example 1: Updates the Description of the Backend 123
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru
Example 2
Updates a Backend. (autogenerated)
Set-AzApiManagementBackend -BackendId 123 -Context <PsApiManagementContext> -Credential <PsApiManagementBackendCredential> -Protocol http -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso -Url 'https://contoso.com/awesomeapi'
Parameters
-BackendId
Identifier of new backend.
This parameter is required.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ContextParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Context
Instance of PsApiManagementContext.
This parameter is required.
Parameter properties
Parameter sets
ContextParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False
-Credential
Credential details which should be used when talking to the Backend.
This parameter is optional.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Description
Backend Description.
This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
Instance of PsApiManagementBackend. This parameter is required.
ByInputObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Protocol
Backend Communication protocol (http or soap).
This parameter is optional
Parameter properties
Type: String
Default value: None Accepted values: http, soap Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Proxy
Proxy Server details to be used while sending request to the Backend.
This parameter is optional.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceId
Management Uri of the Resource in External System.
The absolute http URL of the Azure Resource. This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ServiceFabricCluster
Service Fabric Cluster Backend details. This parameter is optional.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SkipCertificateChainValidation
Whether to Skip Certificate Chain Validation when talking to the Backend.
This parameter is optional.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SkipCertificateNameValidation
Whether to skip Certificate Name Validation when talking to the Backend.
This parameter is optional.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Title
Backend Title.
This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Url
Runtime Url for the Backend.
This parameter is optional.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
