Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureApiManagement

Get-AzureApiManagement

microsoft.azure.commands.apimanagement.dll

Synopsis

Gets a list or a particular API Management Service description.

Syntax

Get-AzureApiManagement [-Profile] [<CommonParameters>]

Get-AzureApiManagement [-ResourceGroupName] [-Name] [-Profile] [<CommonParameters>]

Get-AzureApiManagement [-ResourceGroupName] [-Profile] [<CommonParameters>]

Detailed Description

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

Parameters

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ResourceGroupName <String>

Name of resource group under which want to create API Management service.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Name of API Management service.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

Get all API Management services within subscription.

PS C:\> Get-AzureApiManagement

-------------------------- Example 2 --------------------------

Get API Management service by name.

PS C:\> Get-AzureApiManagement –ResourceGroupName ContosoGroup –Name ContosoApi