Set-AzApiManagementBackend
Updates a Backend.
Syntax
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
PS C:\>$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru
Example 2
Updates a Backend. (autogenerated)
Set-AzApiManagementBackend -BackendId 123 -Context -Credential -Protocol http -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso -Url 'https://contoso.com/awesomeapi'
Parameters
Identifier of new backend. This parameter is required.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
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 |
Instance of PsApiManagementContext. This parameter is required.
Type: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
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 |
Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with azure.
Type: | Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Backend Description. This parameter is optional.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Instance of PsApiManagementBackend. This parameter is required.
Type: | PsApiManagementBackend |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Backend Communication protocol (http or soap). This parameter is optional
Type: | String |
Accepted values: | http, soap |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
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 |
Accept wildcard characters: | False |
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 |
Accept wildcard characters: | False |
Service Fabric Cluster Backend details. This parameter is optional.
Type: | PsApiManagementServiceFabric |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional.
Type: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional.
Type: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Backend Title. This parameter is optional.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Runtime Url for the Backend. This parameter is optional.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
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 |
Inputs
Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
PsApiManagementBackendCredential