你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-AzApiManagement

获取列表或特定的 API 管理服务说明。

语法

GetBySubscription (默认值)

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>]

说明

Get-AzApiManagement cmdlet 获取订阅或指定资源组或特定 API 管理下的所有 API 管理服务的列表。

示例

示例 1:获取所有 API 管理服务

Get-AzApiManagement

此命令获取订阅中的所有 API 管理服务。

示例 2:按特定名称获取 API 管理服务

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

此命令按名称获取所有 API 管理服务。

参数

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

指定 API 管理服务的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

GetByResource
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceGroupName

指定此 cmdlet 获取 API 管理服务时所在的资源组的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

GetByResourceGroup
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False
GetByResource
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceId

API 管理服务的 Arm ResourceId。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ByResourceId
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

String

输出

PsApiManagement