Get-​Azure​Rm​Api​Management

Gets a list or a particular API Management Service description.

Syntax

Get-AzureRmApiManagement
   -ResourceGroupName <String>
   -Name <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Get-AzureRmApiManagement
   -ResourceGroupName <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Get-AzureRmApiManagement cmdlet gets a list of all API Management services under subscription or specified resource group or a particular API Management.

Examples

Example 1: Get all API Management services

PS C:\>Get-AzureRmApiManagement

This command gets all API Management services within a subscription.

Example 2: Get all API Management services by a specific name

PS C:\>Get-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"

This command gets all API Management service by name.

Required Parameters

-Name

Specifies the name of API Management service.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group under in which this cmdlet gets the API Management service.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False