通过

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

Get-AzApiManagementApiSchema

  • 参考
模块:
Az.ApiManagement

获取 API 架构的详细信息

语法

Get-AzApiManagementApiSchema
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-SchemaId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementApiSchema
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Get-AzApiManagementApiSchema cmdlet 获取 API 架构的详细信息

示例

示例 1：获取 Api 的所有 API 架构的详细信息

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163
Get-AzApiManagementApiSchema -Context $context -ApiId wsdlapitest

SchemaId           : 2a03e1b4-1826-4e59-b372-4711f575db28
Api Id             : wsdlapitest
Schema ContentType : xsdschema
Schema Document    : <s:schema elementFormDefault="qualified"....

SchemaId           : b6e5497d-f65a-4851-9f5b-b5684cdae688
Api Id             : wsdlapitest
Schema ContentType : xsdschema
Schema Document    : <?xml version=""1.0"" encoding=""UTF-8""....

此命令获取与特定 ApiManagement 上下文的 Api 关联的所有 API swagger-petstore-extensive 架构。

示例 2：获取与 Api 关联的特定架构

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163
Get-AzApiManagementApiSchema -Context $context -ApiId swagger-petstore-extensive -SchemaId 5cc9cf67e6ed3b1154e638bd

SchemaId           : 5cc9cf67e6ed3b1154e638bd
Api Id             : swagger-petstore-extensive
Schema ContentType : swaggerdefinition
Schema Document    : {
                       "definitions": {
                         "pet": {
                        ....

此命令获取与特定 ApiManagement 上下文的 API 关联的 API swagger-petstore-extensive 架构5cc9cf67e6ed3b1154e638bd。

参数

-ApiId

要查找的 API 标识符。 如果指定，将尝试按 ID 获取 API。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Context

PsApiManagementContext 的实例。 此参数是必需的。

类型:PsApiManagementContext
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-DefaultProfile

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

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceId

Api 架构的 Arm 资源标识符。 如果指定，将尝试按标识符查找 API 架构。 此参数是必需的。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-SchemaId

架构的标识符。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

PsApiManagementContext

String

输出

PsApiManagementApiSchema