Get-AzApiManagement
Gets a list or a particular API Management Service description.
Syntax
GetBySubscription (Default)
Get-AzApiManagement
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceGroup
Get-AzApiManagement
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResource
Get-AzApiManagement
-ResourceGroupName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByResourceId
Get-AzApiManagement
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzApiManagement 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
Get-AzApiManagement
This command gets all API Management services within a subscription.
Example 2: Get an API Management services by a specific name
Get-AzApiManagement -ResourceGroupName "contosogroup" -Name "contoso"
PublicIPAddresses : {52.143.79.150}
PrivateIPAddresses :
Id : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.ApiManagement/service/contoso
Name : contoso
Location : West US 2
Sku : Premium
Capacity : 1
CreatedTimeUtc : 10/13/2021 5:49:32 PM
ProvisioningState : Succeeded
RuntimeUrl : https://contoso.azure-api.net
RuntimeRegionalUrl : https://contoso-westus2-01.regional.azure-api.net
PortalUrl : https://contoso.portal.azure-api.net
DeveloperPortalUrl : https://contoso.developer.azure-api.net
ManagementApiUrl : https://contoso.management.azure-api.net
ScmUrl : https://contoso.scm.azure-api.net
PublisherEmail : [email protected]
OrganizationName : fsdfsdfs
NotificationSenderEmail : [email protected]
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {contoso.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity
EnableClientCertificate :
Zone :
DisableGateway : False
MinimalControlPlaneApiVersion :
PublicIpAddressId :
PlatformVersion : stv2
PublicNetworkAccess : Enabled
PrivateEndpointConnections : {kjoshipeconnection, kjoshipeeus}
ResourceGroupName : contosogroup
This command gets all API Management service by name.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of API Management service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByResource
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of the resource group under in which this cmdlet gets the API Management service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByResourceGroup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
GetByResource
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
Arm ResourceId of the API Management service.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByResourceId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
