Remove-AzureRmApiManagementBackend

NAME Remove-AzureRmApiManagementBackend



SYNOPSIS

Removes a Backend.





SYNTAX

Remove-AzureRmApiManagementBackend -BackendId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-PassThru]

[-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

Removes a backend specified by the Identifier from the Api Management.





PARAMETERS

-BackendId <String>

Identifier of existing 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



-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



-PassThru [<SwitchParameter>]

If specified will write true in case operation succeeds. This parameter is optional. Default value is false.



Required? false

Position? named

Default value False

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

bool







NOTES









Example 1: Remove the Backend 123



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Remove-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -PassThru











RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... entbackend

Get-AzureRmApiManagementBackend

New-AzureRmApiManagementBackend

New-AzureRmApiManagementBackendCredential

New-AzureRmApiManagementBackendProxy

Set-AzureRmApiManagementBackend