Get-AzureRmApiManagementBackend

NAME Get-AzureRmApiManagementBackend



SYNOPSIS

Get the details of the Backend.





SYNTAX

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

[<CommonParameters>]





DESCRIPTION

Get the details of the Backend.





PARAMETERS

-BackendId <String>

Identifier of a backend. If specified will try to find backend by the identifier. This parameter is optional.



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



<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

The details of the Backend configured in API Management service.



IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend>

The list of Backend configured in API Management service.





NOTES









Example 1: Get all Backends



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

PS C:\\>Get-AzureRmApiManagementBackend -Context $apimContext



Gets a list of all the Backends configured in the Api Management service.





Example 2: Get the Backend specified by the Identifier 123



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

PS C:\\>Get-AzureRmApiManagementBackend -Context $apimContext -backendId 123



Get the details of the specified Backend identified by the Identifier '123'







RELATED LINKS

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

New-AzureRmApiManagementBackend

New-AzureRmApiManagementBackendCredential

New-AzureRmApiManagementBackendProxy

Set-AzureRmApiManagementBackend

Remove-AzureRmApiManagementBackend