你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az iot ops
注意
此参考是 Azure CLI(版本 2.53.0 或更高版本)的 azure-iot-ops 扩展的一部分。 该扩展将在首次运行 az iot ops 命令时自动安装。 详细了解扩展。
此命令组处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
管理 Azure IoT 操作。
Azure IoT 操作是一组高度一致的、但松散耦合的第一方 Kubernetes 服务,使你能够将本地资产中的数据聚合到工业级 MQTT 代理,添加边缘计算,并使用云中的各种服务设置双向数据流。
默认情况下,IoT 操作 CLI 命令将定期检查是否有新的扩展版本可用。
可以使用 .. 禁用 az config set iotops.check_latest=false
此行为。
命令
az iot ops check
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
评估已部署 IoT Operations 服务的群集端就绪性和运行时运行状况。
默认情况下,该命令显示所有服务的高级别用户友好 摘要 视图。
使用“--svc”选项指定对单个服务的检查,并通过参数配置详细程度 --detail-level
。
注意:资源类型(--resources)和名称(--resource-name)筛选只能与“--svc”参数一起使用。
{支持的服务 API}
- deviceregistry.microsoft.com/[v1beta2]
- mqttbroker.iotoperations.azure.com/[v1beta1]
- opcuabroker.iotoperations.azure.com/[v1beta1]
- connectivity.iotoperations.azure.com/[v1beta1]
有关群集要求的详细信息,请查看 https://aka.ms/iot-ops-cluster-requirements。
az iot ops check [--as-object {false, true}]
[--context]
[--detail-level {0, 1, 2}]
[--ops-service {akri, broker, dataflow, deviceregistry, opcua}]
[--post {false, true}]
[--pre {false, true}]
[--resource-name]
[--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, dataflow, dataflowendpoint, dataflowprofile}]
示例
基本用法。 使用摘要输出检查总体 IoT 操作运行状况。
az iot ops check
检查包含详细输出的“broker”服务运行状况和配置。
az iot ops check --svc broker --detail-level 1
仅评估为 CI 优化的输出的“数据流”服务。
az iot ops check --svc dataflow --as-object
使用详细输出检查“deviceregistry”运行状况,但将结果限制为“资产”资源。
az iot ops check --svc deviceregistry --detail-level 2 --resources asset
使用资源名称将结果限制为带有“my-asset-”名称前缀的“资产”资源
az iot ops check --svc deviceregistry --resources asset --resource-name 'my-asset-*'
可选参数
输出检查 CI 友好数据结构中的内容和验证。
用于 k8s 群集通信的 Kubeconfig 上下文名称。 如果未current_context提供上下文。
控制检查输出中显示的详细信息级别。 选择 0 作为摘要视图(最小输出)、1 作为详细视图(更全面的信息),或 2 作为详细视图(所有可用信息)。
将评估的 IoT 操作服务部署。
运行部署后检查。
运行先决条件检查以确定是否满足服务部署的最低要求。
仅运行检查特定资源名称。 此名称不区分大小写。 支持 Glob 模式“”和“?”。注意:只允许字母数字字符、连字符、“?”和“”。
仅对特定资源类型运行检查。 使用空格分隔的值。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops create
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
创建 IoT 操作实例。
运行此命令之前,需要执行 init。
该命令的结果将 IoT 操作实例与一组配置为一致函数的默认资源进行 net。
az iot ops create --cluster
--name
--resource-group
--sr-resource-id
[--add-insecure-listener {false, true}]
[--bp]
[--br]
[--broker-backend-workers]
[--broker-config-file]
[--broker-frontend-replicas]
[--broker-frontend-workers]
[--broker-listener-type {ClusterIp, LoadBalancer, NodePort}]
[--broker-mem-profile {High, Low, Medium, Tiny}]
[--cluster-namespace]
[--custom-location]
[--description]
[--df-profile-instances]
[--enable-rsync {false, true}]
[--kubernetes-distro {K3s, K8s, MicroK8s}]
[--location]
[--no-progress {false, true}]
[--ops-config]
[--ops-version]
[--runtime-socket]
[--tags]
[--trust-settings]
示例
使用最小输入创建目标实例。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID
以下示例将自定义添加到默认中转站实例资源以及实例说明和标记。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --broker-mem-profile High --broker-backend-workers 4 --description 'Contoso Factory' --tags tier=testX1
此示例演示如何部署为服务类型负载均衡器端口 1883 配置的附加不安全(无身份验证或 authz)中转站侦听器。 可用于测试和/或演示。 请勿在生产中使用不安全选项。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --add-insecure-listener
此窗体演示如何为实例部署启用资源同步。 若要在目标资源组上启用资源同步角色分配写入,必须执行。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --enable-rsync
此示例突出显示用户提供的证书管理器配置的信任设置。请注意,群集必须已使用“--user-trust”进行初始化,并且必须存在用户证书管理器部署。
az iot ops create --cluster mycluster -g myresourcegroup --name myinstance --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID --trust-settings configMapName=example-bundle configMapKey=trust-bundle.pem issuerKind=ClusterIssuer issuerName=trust-manager-selfsigned-issuer
必需参数
IoT 操作部署的目标群集名称。
IoT 操作实例名称。 必须提供实例名称才能在初始化业务流程期间部署实例。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
要用于 IoT 操作的架构注册表资源 ID。
可选参数
启用 mqtt 中转站部署时,将包含服务类型 LoadBalancer 的侦听器,该侦听器绑定到端口 1883 且没有身份验证或身份验证Z。 仅适用于非生产工作负荷。
Mqtt 中转站后端分区。 最小值:1,最大值:16。
Mqtt 中转站后端冗余因素。 最小值:1,最大值:5。
Mqtt 中转站后端辅助角色。 最小值:1,最大值:16。
包含自定义中转站配置属性的 json 文件的路径。 文件配置内容用于各个中转站配置参数。 适用于高级方案。 预期格式在 https://aka.ms/aziotops-broker-config.
Mqtt 中转站前端副本。 最小值:1,最大值:16。
Mqtt 中转站前端辅助角色。 最小值:1,最大值:16。
与默认 mqtt 中转站侦听器关联的服务类型。
Mqtt Broker 内存配置文件。
群集命名空间 IoT 操作基础结构将部署到该基础结构。 必须为小写。
对应于 IoT 操作部署的自定义位置名称。 默认值采用“location-{hash(5)}”格式。
IoT 操作实例的说明。
与默认数据流配置文件关联的实例计数。
资源同步规则将包含在 IoT 操作部署中。
用于 Akri 配置的 Kubernetes 发行版。 所选发行版表示未提供 --runtime-socket 值时的默认容器运行时套接字路径。
将用于预配资源抵押的区域。 如果未提供,将使用连接的群集位置。
禁用工作的视觉表示形式。
IoT Operations arc 扩展自定义配置。 格式是空格分隔的键=值对。 --ops-config 可以一次或多次使用。 对于高级用例。
参数“ops_version”已弃用,将在将来的版本中删除。
用于替代内置 IoT 操作 arc 扩展版本。
容器运行时套接字的默认节点路径。 如果未提供(默认值),则套接字路径由 --kubernetes-distro 决定。
实例标记。 采用以下格式的键值对中的属性包:a=b c=d。 使用 --tags “” 删除所有标记。
用户提供的信任捆绑包的设置。 用于组件 TLS。 格式是空格分隔的键=值对。 以下密钥是必需的:configMapName
、、issuerKind
configMapKey
issuerName
。 如果未使用,则配置系统提供的自签名信任捆绑包。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops delete
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
从群集中删除 IoT 操作。
必须提供实例或群集的名称。
该操作使用 Azure Resource Graph 来确定相关资源。 资源图最终保持一致不能保证在执行时处于同步状态。
az iot ops delete --resource-group
[--cluster]
[--force {false, true}]
[--include-deps {false, true}]
[--name]
[--no-progress {false, true}]
[--yes {false, true}]
示例
完成删除的最小输入。
az iot ops delete -n myinstance -g myresourcegroup
跳过确认提示并继续删除过程。 适用于 CI 方案。
az iot ops delete -n myinstance -g myresourcegroup -y
强制删除,而不考虑警告。 可能会导致错误。
az iot ops delete -n myinstance -g myresourcegroup --force
使用群集名称而不是实例进行查找。
az iot ops delete --cluster mycluster -g myresourcegroup
init 的反向应用。
az iot ops delete -n myinstance -g myresourcegroup --include-deps
必需参数
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
用于删除 IoT 操作的目标群集名称。
强制执行操作。
指示命令应删除 IoT 操作依赖项。 此选项旨在反向应用 init。
IoT 操作实例名称。
禁用工作的视觉表示形式。
在没有提示的情况下确认 [y]es。 适用于 CI 和自动化方案。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops init
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
为 IoT 操作部署启动已启用 Arc 的群集。
部署 IoT 操作需要已启用 Arc 的群集。 有关详细信息 https://aka.ms/aziotops-arcconnect,请参阅以下资源。
init 操作将在安装和配置 IoT 操作部署所需的边缘服务基础层时执行工作。
安装基础层后, az iot ops create
应使用命令来部署实例。
az iot ops init --cluster
--resource-group
[--enable-fault-tolerance {false, true}]
[--ensure-latest {false, true}]
[--no-progress {false, true}]
[--user-trust {false, true}]
示例
使用最小输入。 此窗体将部署 IoT 操作基础层。
az iot ops init --cluster mycluster -g myresourcegroup
类似于前面的示例,但启用了 Arc 容器存储容错(至少需要 3 个节点)。
az iot ops init --cluster mycluster -g myresourcegroup --enable-fault-tolerance
此示例突出显示了为自定义证书管理器配置启用用户信任设置。这将跳过系统证书管理器和信任管理器的部署。
az iot ops init --cluster mycluster -g myresourcegroup --user-trust
必需参数
IoT 操作部署的目标群集名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
为 Azure Arc 容器存储启用容错。 至少需要 3 个群集节点。
确保正在使用最新的 IoT Ops CLI,如果升级可用,则会引发错误。
禁用工作的视觉表示形式。
跳过系统证书管理器和信任管理器的部署,以支持用户提供的配置。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops list
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
列出 IoT 操作实例。
使用具有所需 JMESPath 语法的 --query 查询结果。
az iot ops list [--resource-group]
示例
列出订阅中的所有实例。
az iot ops list
列出特定资源组的所有实例。
az iot ops list -g myresourcegroup
列出订阅中具有特定标记值的实例。
az iot ops list -g myresourcegroup --query "[?tags.env == 'prod']"
可选参数
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops show
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
显示 IoT 操作实例。
(可选)该命令可以输出表示针对支持群集的 IoT 操作部署的关联资源的树结构。
如果此命令失败,请使用 az iot ops upgrade
以下命令将实例升级到最新版本,然后再继续。
az iot ops show --name
--resource-group
[--tree {false, true}]
示例
显示实例的基本用法。
az iot ops show --name myinstance -g myresourcegroup
输出表示 IoT 操作部署的关联资源的树结构。
az iot ops show --name myinstance -g myresourcegroup --tree
必需参数
IoT 操作实例名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
用于可视化针对支持群集的 IoT 操作部署。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops update
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
更新 IoT 操作实例。
当前可以更新实例标记和说明。 如果要将实例升级到较新版本,请改用 az iot ops upgrade
。
az iot ops update --name
--resource-group
[--description]
[--tags]
示例
更新实例标记。 这相当于替换。
az iot ops update --name myinstance -g myresourcegroup --tags a=b c=d
删除实例标记。
az iot ops update --name myinstance -g myresourcegroup --tags ""
更新实例说明。
az iot ops update --name myinstance -g myresourcegroup --desc "Fabrikam Widget Factory B42"
必需参数
IoT 操作实例名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
IoT 操作实例的说明。
实例标记。 采用以下格式的键值对中的属性包:a=b c=d。 使用 --tags “” 删除所有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops upgrade
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
将 IoT 操作实例升级到最新版本。
警告:此命令可能会失败,并要求删除并重新创建群集和实例。
升级 IoT 操作实例,包括将扩展更新到最新版本。
如果 az iot ops show
或类似的命令失败,请使用此命令。
架构注册表资源 ID 是一个可选参数,在特定方案中可能是必需的。
az iot ops upgrade --name
--resource-group
[--no-progress {false, true}]
[--sr-resource-id]
[--yes {false, true}]
示例
使用最少的输入升级实例。
az iot ops upgrade --name myinstance -g myresourcegroup
在实例升级期间跳过一致性提示。
az iot ops upgrade --name myinstance -g myresourcegroup -y
升级实例并指定架构注册表资源 ID。
az iot ops upgrade --name myinstance -g myresourcegroup --sr-resource-id $SCHEMA_REGISTRY_RESOURCE_ID
必需参数
IoT 操作实例名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
禁用工作的视觉表示形式。
要用于 IoT 操作的架构注册表资源 ID。 如果 IoT 操作中不再找到架构注册表资源 ID,则为必需。
在没有提示的情况下确认 [y]es。 适用于 CI 和自动化方案。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot ops verify-host
命令组“iot ops”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
针对 IoT 操作部署兼容性运行一组群集主机验证。
旨在直接在目标群集主机上运行。 该命令可能会提示应用一组特权操作,例如安装依赖项。 在这种情况下,必须使用提升的权限运行 CLI。 例如,sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host
。
az iot ops verify-host [--no-progress {false, true}]
可选参数
禁用工作的视觉表示形式。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。