Share via

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

az apim api schema

  • 参考

管理 Azure API 管理 API 架构。

命令

名称 说明 类型 状态
az apim api schema create

创建API 管理 API 架构。

 核心 GA
az apim api schema delete

删除API 管理 API 架构。

 核心 GA
az apim api schema get-etag

获取API 管理 API 架构的 etag。

 核心 GA
az apim api schema list

列出API 管理 API 架构。

 核心 GA
az apim api schema show

显示API 管理 API 架构的详细信息。

 核心 GA
az apim api schema wait

将 CLI 置于等待状态，直到满足 apim API 架构的条件。

 核心 GA

az apim api schema create

编辑

创建API 管理 API 架构。

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

示例

创建 API 架构。

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

必需参数

--api-id

需要为其创建架构的 API 的唯一名称。

API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--schema-id

要创建的 API 架构的唯一名称。

架构标识符。 在当前API 管理服务实例中必须是唯一的。

--schema-type

架构类型（例如 application/json、application/vnd.ms-azure-apim.graphql.schema）。

必须是在 RFC 2616 中定义的 Content-Type 标头中使用的有效媒体类型。 架构文档的媒体类型。

--service-name -n

API 管理服务实例的名称。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False
--resource-type

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”。

--schema-content

定义表示架构的文档的 Json 转义字符串。

指定 --schema-path 或 --schema-content，而不同时指定这两者。

--schema-name

架构资源的名称。

--schema-path

指定用于导入 API 架构的文件路径。

指定 --schema-path 或 --schema-content，而不同时指定这两者。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az apim api schema delete

编辑

删除API 管理 API 架构。

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

示例

删除 API 架构。

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--schema-id

架构标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--service-name -n

API 管理服务实例的名称。

可选参数

--if-match

实体的 ETag。

--no-wait

不等待长时间运行的操作完成。

默认值: False
--yes -y

不提示确认。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az apim api schema get-etag

编辑

获取API 管理 API 架构的 etag。

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

示例

获取架构实体标记。

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--schema-id

架构标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--service-name -n

API 管理服务实例的名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az apim api schema list

编辑

列出API 管理 API 架构。

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

示例

获取与 API ID 关联的架构的列表。

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--service-name -n

API 管理服务实例的名称。

可选参数

--filter-display-name

按 displayName 筛选 API。

--skip

要跳过的记录数。

--top

要返回的记录数。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az apim api schema show

编辑

显示API 管理 API 架构的详细信息。

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

示例

获取 API 架构。

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--schema-id

架构标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--service-name -n

API 管理服务实例的名称。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az apim api schema wait

编辑

将 CLI 置于等待状态，直到满足 apim API 架构的条件。

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

示例

将 CLI 置于等待状态，直到满足 apim API 架构的条件。

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

必需参数

--api-id

API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。 必需。

--name -n

API 管理服务实例的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--schema-id

架构 ID 标识符。 在当前API 管理服务实例中必须是唯一的。 必需。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--interval

轮询间隔（以秒为单位）。

默认值: 30
--timeout

最大等待（以秒为单位）。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。