Partager via


Get-AzApiManagement

Obtient une liste ou une description particulière du service gestion des API.

Syntaxe

GetBySubscription (Par défaut)

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

L’applet de commande Get-AzApiManagement obtient une liste de tous les services Gestion des API sous abonnement ou groupe de ressources spécifié ou gestion des API spécifique.

Exemples

Exemple 1 : Obtenir tous les services Gestion des API

Get-AzApiManagement

Cette commande obtient tous les services Gestion des API au sein d’un abonnement.

Exemple 2 : Obtenir un service Gestion des API par un nom spécifique

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

Cette commande obtient tout le service Gestion des API par nom.

Paramètres

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

Spécifie le nom du service Gestion des API.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

GetByResource
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ResourceGroupName

Spécifie le nom du groupe de ressources sous lequel cette applet de commande obtient le service Gestion des API.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

GetByResourceGroup
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False
GetByResource
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ResourceId

Arm ResourceId du service Gestion des API.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByResourceId
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

String

Sorties

PsApiManagement