Set-AzureRmApiManagementBackend
Updates a Backend.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Set-AzureRmApiManagementBackend
-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>] Description
Updates an existing backend in the Api Management.
Examples
Updates the Description of the Backend 123
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThruParameters
-BackendId
Identifier of new backend. This parameter is required.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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: | 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 |
-PassThru
Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Protocol
Backend Communication protocol (http or soap). This parameter is optional
| Type: | String |
| Accepted values: | http, soap |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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. 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 |
| 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 optional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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
Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
PsApiManagementBackendCredential