< Back
Set-AzureRmApiManagementBackend
Post
NAME Set-AzureRmApiManagementBackend
SYNOPSIS
Updates a Backend.
SYNTAX
Set-AzureRmApiManagementBackend -BackendId <String> -Context <PsApiManagementContext> [-Credential <PsApiManagementBackendCredential>]
[-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-PassThru] [-Protocol {http | soap}] [-Proxy <PsApiManagementBackendProxy>]
[-ResourceId <String>] [-SkipCertificateChainValidation <Boolean>] [-SkipCertificateNameValidation <Boolean>] [-Title <String>] [-Url <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Updates an existing backend in the Api Management.
PARAMETERS
-BackendId <String>
Identifier of new backend. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Instance of PsApiManagementContext. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PsApiManagementBackendCredential>
Credential details which should be used when talking to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Backend Description. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Backend Communication protocol (http or soap). This parameter is optional
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Proxy <PsApiManagementBackendProxy>
Proxy Server details to be used while sending request to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SkipCertificateChainValidation <Boolean>
Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SkipCertificateNameValidation <Boolean>
Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Title <String>
Backend Title. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Url <String>
Runtime Url for the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend
NOTES
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" -PassThru
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entbackend
Get-AzureRmApiManagementBackend
New-AzureRmApiManagementBackend
New-AzureRmApiManagementBackendCredential
New-AzureRmApiManagementBackendProxy
Remove-AzureRmApiManagementBackend
SYNOPSIS
Updates a Backend.
SYNTAX
Set-AzureRmApiManagementBackend -BackendId <String> -Context <PsApiManagementContext> [-Credential <PsApiManagementBackendCredential>]
[-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-PassThru] [-Protocol {http | soap}] [-Proxy <PsApiManagementBackendProxy>]
[-ResourceId <String>] [-SkipCertificateChainValidation <Boolean>] [-SkipCertificateNameValidation <Boolean>] [-Title <String>] [-Url <String>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Updates an existing backend in the Api Management.
PARAMETERS
-BackendId <String>
Identifier of new backend. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Instance of PsApiManagementContext. This parameter is required.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PsApiManagementBackendCredential>
Credential details which should be used when talking to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Backend Description. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Backend Communication protocol (http or soap). This parameter is optional
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Proxy <PsApiManagementBackendProxy>
Proxy Server details to be used while sending request to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SkipCertificateChainValidation <Boolean>
Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SkipCertificateNameValidation <Boolean>
Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Title <String>
Backend Title. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Url <String>
Runtime Url for the Backend. This parameter is optional.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend
NOTES
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" -PassThru
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... entbackend
Get-AzureRmApiManagementBackend
New-AzureRmApiManagementBackend
New-AzureRmApiManagementBackendCredential
New-AzureRmApiManagementBackendProxy
Remove-AzureRmApiManagementBackend