通过

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

az apic metadata

Note

此参考是 Azure CLI（版本 2.57.0 或更高版本）的 apic-extension 扩展的一部分。 该扩展将在首次运行 az apic metadata 命令时自动安装。 了解更多关于扩展的信息。

用于在 API 中心管理元数据架构的命令。

命令

名称 说明 类型 Status
az apic metadata create

创建新的元数据架构或更新现有元数据架构。

 Extension GA
az apic metadata delete

删除指定的元数据架构。

 Extension GA
az apic metadata export

导出元数据架构。

 Extension GA
az apic metadata list

列出元数据架构的集合。

 Extension GA
az apic metadata show

获取元数据架构的详细信息。

 Extension GA
az apic metadata update

更新现有元数据架构。

 Extension GA

az apic metadata create

创建新的元数据架构或更新现有元数据架构。

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

示例

创建元数据示例 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

创建元数据示例 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

使用 json 文件架构和分配示例创建元数据

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

必需参数

--assignments

定义自定义元数据的分配范围，例如“[{entity：api，required：true，deprecated：false}]”。 可用的实体值包括：api、部署、环境。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--metadata-name

元数据架构的名称。

--resource-group -g

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

--schema

定义类型的 JSON 架构。

属性 值
参数组: Properties Arguments
--service-name -n

Azure API 中心服务的名称。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az apic metadata delete

删除指定的元数据架构。

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

示例

删除元数据架构

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

删除架构

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--metadata-name

元数据架构的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--service-name -n

Azure API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--yes -y

不要提示确认。

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

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az apic metadata export

导出元数据架构。

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

示例

导出分配给 API 的元数据架构

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

导出分配给部署的元数据架构

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

导出分配给环境的元数据架构

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

仅导出自定义元数据架构

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json --custom-metadata-only

必需参数

--assignments

请求元数据架构的实体。

属性 值
参数组: Payload Arguments
接受的值: api, deployment, environment
--file-name

要在其中导出元数据架构的文件的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--custom-metadata-only

仅导出自定义元数据。

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--service-name -n

API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az apic metadata list

列出元数据架构的集合。

az apic metadata list --resource-group
                      --service-name
                      [--filter]
                      [--max-items]
                      [--next-token]

示例

列出架构

az apic metadata list -g api-center-test -n contosoeuap

必需参数

--resource-group -g

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

--service-name -n

Azure API 中心服务的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--filter

OData 筛选器参数。

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性 值
参数组: Pagination Arguments
--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性 值
参数组: Pagination Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az apic metadata show

获取元数据架构的详细信息。

az apic metadata show [--ids]
                      [--metadata-name]
                      [--resource-group]
                      [--service-name]
                      [--subscription]

示例

显示架构详细信息 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

显示架构详细信息 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--metadata-name

元数据架构的名称。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--service-name -n

Azure API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az apic metadata update

更新现有元数据架构。

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

示例

更新架构

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

使用架构 json 文件更新架构

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

属性 值
参数组: Generic Update Arguments
--assignments

定义自定义元数据的分配范围，例如“[{entity：api，required：true，deprecated：false}]”。 可用的实体值包括：api、部署、环境。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性 值
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
参数组: Resource Id Arguments
--metadata-name

元数据架构的名称。

属性 值
参数组: Resource Id Arguments
--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性 值
参数组: Generic Update Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--schema

定义类型的 YAML 架构。

属性 值
参数组: Properties Arguments
--service-name -n

Azure API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

属性 值
参数组: Generic Update Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False