Get-AzureRmApiManagement

NAME Get-AzureRmApiManagement



SYNOPSIS

Gets a list or a particular API Management Service description.





SYNTAX

Get-AzureRmApiManagement [-DefaultProfile <IAzureContextContainer>] -Name <String> -ResourceGroupName <String> [<CommonParameters>]



Get-AzureRmApiManagement [-DefaultProfile <IAzureContextContainer>] -ResourceGroupName <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.





PARAMETERS

-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



-Name <String>

Specifies the name of API Management service.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

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

System.Collections.Generic.List`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement]







NOTES









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.







RELATED LINKS

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

Backup-AzureRmApiManagement

New-AzureRmApiManagement

Remove-AzureRmApiManagement

Restore-AzureRmApiManagement