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

az iot ops schema registry

注意

此参考是 Azure CLI(版本 2.53.0 或更高版本)azure-iot-ops 扩展的一部分。 该扩展会在首次运行 az iot ops schema registry 命令时自动安装。 详细了解扩展

命令组“iot ops schema”处于预览状态,正在开发中。 参考和支持级别:https://aka.ms/CLI_refstatus

架构注册表管理。

架构注册表是用于管理架构的集中式存储库。 架构注册表支持在边缘和云中生成和检索架构。 它通过为架构定义提供单一事实来源来确保跨系统的一致性和兼容性。

命令

名称 说明 类型 Status
az iot ops schema registry create

创建架构注册表。

外延 预览
az iot ops schema registry delete

删除目标架构注册表。

外延 预览
az iot ops schema registry list

列出资源组或订阅中的架构注册表。

外延 预览
az iot ops schema registry show

显示架构注册表的详细信息。

外延 预览

az iot ops schema registry create

预览

命令组“iot ops schema”处于预览状态,正在开发中。 参考和支持级别:https://aka.ms/CLI_refstatus

创建架构注册表。

此操作将创建启用了系统托管标识的架构注册表。

然后,它会针对存储帐户容器范围默认分配内置的“存储 Blob 数据参与者”角色。 如有必要,可以通过 --custom-role-id 提供自定义角色来改用。

如果指定的存储帐户容器不存在,则会使用默认设置创建该容器。

如果未注册,此操作还将注册 Microsoft.DeviceRegistry 资源提供程序。

az iot ops schema registry create --name
                                  --registry-namespace
                                  --resource-group
                                  --sa-resource-id
                                  [--custom-role-id]
                                  [--desc]
                                  [--display-name]
                                  [--location]
                                  [--sa-container]
                                  [--tags]

示例

使用最小输入创建名为“myregistry”的架构注册表。

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID

使用其他自定义在 westus2 区域中创建名为“myregistry”的架构注册表。

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID --sa-container myschemacontainer -l westus2 --desc 'Contoso factory X1 schemas' --display-name 'Contoso X1' --tags env=prod

必需参数

--name -n

架构注册表名称。

--registry-namespace --rn

架构注册表命名空间。 唯一标识租户中的架构注册表。

--resource-group -g

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

--sa-resource-id

要用于架构注册表的存储帐户资源 ID。

可选参数

--custom-role-id

完全限定的角色定义 ID 采用以下格式:/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}。

--desc

架构注册表的说明。

--display-name

架构注册表的显示名称。

--location -l

要创建架构注册表的区域。 如果未提供任何位置,将使用资源组位置。

--sa-container

存储架构的存储帐户容器名称。

默认值: schemas
--tags

架构注册表标记。 采用以下格式的键值对中的属性包:a=b c=d。 使用 --tags “” 删除所有标记。

全局参数
--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 iot ops schema registry delete

预览

命令组“iot ops schema”处于预览状态,正在开发中。 参考和支持级别:https://aka.ms/CLI_refstatus

删除目标架构注册表。

az iot ops schema registry delete --name
                                  [--resource-group]
                                  [--yes {false, true}]

示例

删除架构注册表“myregistry”。

az iot ops schema registry delete -n myregistry -g myresourcegroup

必需参数

--name -n

架构注册表名称。

可选参数

--resource-group -g

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

--yes -y

在没有提示的情况下确认 [y]es。 适用于 CI 和自动化方案。

接受的值: false, true
全局参数
--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 iot ops schema registry list

预览

命令组“iot ops schema”处于预览状态,正在开发中。 参考和支持级别:https://aka.ms/CLI_refstatus

列出资源组或订阅中的架构注册表。

az iot ops schema registry list [--resource-group]

示例

列出资源组“myresourcegroup”中的架构注册。

az iot ops schema registry list -g myresourcegroup

列出特定标记上默认订阅筛选中的架构注册。

az iot ops schema registry list --query "[?tags.env == 'prod']"

可选参数

--resource-group -g

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

全局参数
--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 iot ops schema registry show

预览

命令组“iot ops schema”处于预览状态,正在开发中。 参考和支持级别:https://aka.ms/CLI_refstatus

显示架构注册表的详细信息。

az iot ops schema registry show --name
                                --resource-group

示例

显示目标架构注册表“myregistry”的详细信息。

az iot ops schema registry show --name myregistry -g myresourcegroup

必需参数

--name -n

架构注册表名称。

--resource-group -g

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

全局参数
--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。