Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzApiManagementBackend
- Module:
- Az.ApiManagement Module
Updates a Backend.
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>]
ByInputObject
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
-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
-Context
Instance of PsApiManagementContext. This parameter is required.
Parameter properties
| Type: | PsApiManagementContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Credential
Credential details which should be used when talking to the Backend. This parameter is optional.
Parameter properties
| Type: | PsApiManagementBackendCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Description
Backend Description. This parameter is optional.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Instance of PsApiManagementBackend. This parameter is required.
Parameter properties
| Type: | PsApiManagementBackend |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-Proxy
Proxy Server details to be used while sending request to the Backend. This parameter is optional.
Parameter properties
| Type: | PsApiManagementBackendProxy |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-ServiceFabricCluster
Service Fabric Cluster Backend details. This parameter is optional.
Parameter properties
| Type: | PsApiManagementServiceFabric |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkipCertificateChainValidation
Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkipCertificateNameValidation
Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Title
Backend Title. This parameter is optional.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Url
Runtime Url for the Backend. This parameter is optional.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
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.
Inputs
PsApiManagementContext
String
Nullable<T>
PsApiManagementBackendCredential
PsApiManagementBackendProxy
PsApiManagementServiceFabric
SwitchParameter
Outputs
PsApiManagementBackend
Related Links
Azure PowerShell
Feedback
Was this page helpful?