Edit

Get-AzApiManagementBackend

  • Reference
Module:
Az.ApiManagement

Get the details of the Backend.

Syntax

Get-AzApiManagementBackend
   -Context <PsApiManagementContext>
   [-BackendId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementBackend
   [-BackendId <String>]
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get the details of the Backend.

Examples

Example 1: Get all Backends

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementBackend -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

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementBackend -Context $apimContext -backendId 123

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

Parameters

-BackendId

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Instance of PsApiManagementContext. This parameter is required.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

Arm Resource Identifier of the backend. If specified will try to find backend by the identifier. This parameter is required.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PsApiManagementContext

String

Outputs

PsApiManagementBackend