Get-AzApiManagement
Obtém uma lista ou uma descrição específica do Serviço de Gerenciamento de API.
Sintaxe
GetBySubscription (Predefinição)
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
O cmdlet Get-AzApiManagement obtém uma lista de todos os serviços de Gerenciamento de API em assinatura ou grupo de recursos especificado ou um Gerenciamento de API específico.
Exemplos
Exemplo 1: Obter todos os serviços de gerenciamento de API
Get-AzApiManagement
Este comando obtém todos os serviços de Gerenciamento de API em uma assinatura.
Exemplo 2: Obter um serviço de gerenciamento de API por um nome específico
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 : glfeokti@microsoft.com
OrganizationName : fsdfsdfs
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
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
Este comando obtém todo o serviço de Gerenciamento de API por nome.
Parâmetros
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.
Propriedades dos parâmetros
| Tipo: | IAzureContextContainer |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Name
Especifica o nome do serviço de Gerenciamento de API.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
GetByResource
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-ResourceGroupName
Especifica o nome do grupo de recursos no qual esse cmdlet obtém o serviço de Gerenciamento de API.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
GetByResourceGroup
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
GetByResource
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-ResourceId
Arm ResourceId do serviço de Gerenciamento de API.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
ByResourceId
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
