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

az iot central

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。

管理 IoT Central 资源。

IoT Central 是一个 IoT 应用程序平台,可减轻开发、管理和维护企业级 IoT 解决方案的负担和成本。 选择使用 IoT Central 进行构建可将时间、金钱和精力集中于使用 IoT 数据转换业务,而不仅仅是维护和更新复杂且不断发展的 IoT 基础结构。 Azure IoT CLI 扩展中提供了 https://aka.ms/iotcentral-documentation IoT Central 综合数据平面功能中的 IoT Central 文档。 有关如何安装访问 https://github.com/Azure/azure-iot-cli-extension的详细信息。

命令

名称 说明 类型 状态
az iot central api-token

管理 IoT Central 应用程序的 API 令牌。

扩展 GA
az iot central api-token create

生成与 IoT Central 应用程序关联的 API 令牌。

扩展 GA
az iot central api-token delete

删除与 IoT Central 应用程序关联的 API 令牌。

分机 GA
az iot central api-token list

获取与 IoT Central 应用程序关联的 API 令牌列表。

扩展 GA
az iot central api-token show

获取与 IoT Central 应用程序关联的 API 令牌的详细信息。

分机 GA
az iot central app

管理 IoT Central 应用程序。

核心 GA
az iot central app create

创建 IoT Central 应用程序。

核心 GA
az iot central app delete

删除 IoT Central 应用程序。

核心 GA
az iot central app identity

管理 IoT Central 应用程序标识。

核心 GA
az iot central app identity assign

将托管标识分配给 IoT Central 应用程序。

核心 GA
az iot central app identity remove

从 IoT Central 应用程序中删除托管标识。

核心 GA
az iot central app identity show

显示 IoT Central 应用程序的标识属性。

核心 GA
az iot central app list

列出 IoT Central 应用程序。

核心 GA
az iot central app private-endpoint-connection

管理 IoT Central 应用程序的专用终结点连接。

核心 GA
az iot central app private-endpoint-connection approve

批准 IoT Central 应用程序的专用终结点连接请求。

核心 GA
az iot central app private-endpoint-connection delete

删除 IoT Central 应用程序的专用终结点连接。

核心 GA
az iot central app private-endpoint-connection list

列出 IoT Central 应用程序的所有专用终结点连接。

核心 GA
az iot central app private-endpoint-connection reject

拒绝 IoT Central 应用程序的专用终结点连接请求。

核心 GA
az iot central app private-endpoint-connection show

显示 IoT Central 应用程序的专用终结点连接请求的详细信息。

核心 GA
az iot central app private-link-resource

管理 IoT Central 应用程序专用链接资源。

核心 GA
az iot central app private-link-resource list

列出指定帐户中的所有 IoT Central 应用程序专用链接资源。

核心 GA
az iot central app private-link-resource show

显示指定 IoT Central 应用程序中专用链接资源的详细信息。

核心 GA
az iot central app show

获取 IoT Central 应用程序的详细信息。

核心 GA
az iot central app update

更新 IoT Central 应用程序的元数据。

核心 GA
az iot central device

管理和配置 IoT Central 设备。

扩展 GA
az iot central device-group

管理和配置 IoT Central 设备组。

扩展 GA
az iot central device-group create

创建设备组。

分机 GA
az iot central device-group delete

删除设备组。

扩展 GA
az iot central device-group list

获取 IoT Central 应用程序的设备组列表。

扩展 GA
az iot central device-group show

按 ID 获取设备组。

扩展 GA
az iot central device-group update

更新现有设备组。

分机 GA
az iot central device-template

管理和配置 IoT Central 设备模板。

扩展 GA
az iot central device-template create

在 IoT Central 中创建设备模板。

分机 GA
az iot central device-template delete

从 IoT Central 中删除设备模板。

分机 GA
az iot central device-template list

获取 IoT Central 应用程序的设备模板列表。

分机 GA
az iot central device-template show

从 IoT Central 获取设备模板。

分机 GA
az iot central device-template update

在 IoT Central 中更新设备模板。

扩展 GA
az iot central device attestation

管理和配置 IoT Central 设备证明。

扩展 GA
az iot central device attestation create

创建单个设备证明。

分机 GA
az iot central device attestation delete

删除单个设备证明。

分机 GA
az iot central device attestation show

获取设备证明。

扩展 GA
az iot central device attestation update

通过修补程序更新单个设备证明。

分机 GA
az iot central device c2d-message

运行设备云到设备的消息传送命令。

扩展 GA
az iot central device c2d-message purge

清除目标设备的云到设备消息队列。

分机 GA
az iot central device command

运行设备命令。

分机 GA
az iot central device command history

获取发送到设备的最新命令请求和响应的详细信息。

分机 GA
az iot central device command run

在设备上运行命令并查看关联的响应。 不监视命令可能执行的属性更新。

分机 GA
az iot central device compute-device-key

生成派生的设备 SAS 密钥。

扩展 GA
az iot central device create

在 IoT Central 中创建设备。

扩展 GA
az iot central device delete

从 IoT Central 中删除设备。

分机 GA
az iot central device edge

管理和配置 IoT Central Edge 设备。

分机 GA
az iot central device edge children

管理 IoT Edge 设备子设备。

扩展 GA
az iot central device edge children add

将设备作为子级添加到目标边缘设备。

扩展 预览
az iot central device edge children list

获取 IoT Edge 设备的子级列表。

分机 GA
az iot central device edge children remove

从目标边缘设备中删除子设备。

分机 预览
az iot central device edge manifest

管理 IoT Edge 设备清单。

分机 预览版
az iot central device edge manifest show

获取与指定的 IoT Edge 设备关联的部署清单。

分机 预览
az iot central device edge module

管理 IoT Edge 设备模块。

分机 预览版
az iot central device edge module list

获取 IoT Edge 设备中的模块列表。

分机 预览版
az iot central device edge module restart

在 IoT Edge 设备中重启模块。

扩展 预览
az iot central device edge module show

获取 IoT Edge 设备中的模块。

分机 预览版
az iot central device list

获取 IoT Central 应用程序的设备列表。

分机 GA
az iot central device list-components

列出设备中存在的组件。

分机 GA
az iot central device list-modules

列出设备中存在的模块。

分机 GA
az iot central device manual-failback

通过将设备移回其原始IoT 中心来还原以前执行的故障转移命令。

分机 GA
az iot central device manual-failover

跨多个IoT 中心执行设备的手动故障转移,以验证设备固件使用 DPS 重新连接到其他IoT 中心的能力。

分机 GA
az iot central device registration-info

从 IoT Central 获取有关设备的注册信息。

分机 GA
az iot central device show

从 IoT Central 获取设备。

分机 GA
az iot central device show-credentials

从 IoT Central 获取设备凭据。

分机 GA
az iot central device telemetry

查询 IoT Central 设备上次遥测值。

扩展 GA
az iot central device telemetry show

从设备获取最后一个遥测值。

分机 GA
az iot central device twin

管理 IoT Central 设备孪生。

分机 GA
az iot central device twin replace

替换设备、设备组件或设备模块或设备模块组件的可写属性值。

扩展 GA
az iot central device twin show

获取设备、设备组件、设备模块或设备模块组件的所有属性值。

分机 GA
az iot central device twin update

更新设备、设备组件、设备模块或设备模块组件的可写属性值。

扩展 GA
az iot central device update

更新 IoT Central 中的设备。

分机 GA
az iot central diagnostics

执行应用程序和设备级别诊断。

分机 预览版
az iot central diagnostics monitor-events

查看发送到 IoT Central 应用的设备遥测消息。

分机 预览
az iot central diagnostics monitor-properties

查看发送到 IoT Central 应用或从 IoT Central 应用发送的所需属性和报告属性。

分机 预览
az iot central diagnostics registration-summary

查看应用中所有设备的注册摘要。

分机 预览版
az iot central diagnostics validate-messages

验证发送到 IoT Central 应用的IoT 中心的消息。

扩展 预览版
az iot central diagnostics validate-properties

验证发送到 IoT Central 应用程序的报告属性。

分机 预览
az iot central enrollment-group

管理和配置 IoT Central 注册组。

分机 GA
az iot central enrollment-group create

创建注册组。

分机 GA
az iot central enrollment-group delete

按 ID 删除注册组。

分机 GA
az iot central enrollment-group generate-verification-code

为注册组的主证书或辅助 x509 证书生成验证码。

分机 GA
az iot central enrollment-group list

获取应用程序中的注册组列表。

扩展 GA
az iot central enrollment-group show

按 ID 获取有关注册组的详细信息。

分机 GA
az iot central enrollment-group update

更新注册组。

扩展 GA
az iot central enrollment-group verify-certificate

验证注册组的主证书或辅助 x509 证书。

扩展 GA
az iot central export

管理和配置 IoT Central 数据导出。

扩展 预览
az iot central export create

为 IoT Central 应用程序创建导出。

分机 预览
az iot central export delete

删除 IoT Central 应用程序的导出。

扩展 预览版
az iot central export destination

管理和配置 IoT Central 导出目标。

扩展 预览
az iot central export destination create

为 IoT Central 应用程序创建导出目标。

分机 预览
az iot central export destination delete

删除 IoT Central 应用程序的导出目标。

分机 预览
az iot central export destination list

获取 IoT Central 应用程序导出目标的完整列表。

扩展 预览
az iot central export destination show

获取导出目标详细信息。

扩展 预览
az iot central export destination update

更新 IoT Central 应用程序的导出目标。

分机 预览
az iot central export list

获取 IoT Central 应用程序导出的完整列表。

分机 预览
az iot central export show

获取导出详细信息。

分机 预览
az iot central export update

更新 IoT Central 应用程序的导出。

分机 预览版
az iot central file-upload-config

管理和配置 IoT Central 文件上传。

分机 GA
az iot central file-upload-config create

创建文件上传存储帐户配置。

分机 GA
az iot central file-upload-config delete

删除文件上传存储帐户配置。

分机 GA
az iot central file-upload-config show

获取文件上传存储帐户配置的详细信息。

扩展 GA
az iot central file-upload-config update

更新文件上传存储帐户配置。

分机 GA
az iot central job

管理和配置 IoT Central 应用程序的作业。

扩展 GA
az iot central job create

通过作业定义创建和执行作业。

扩展 GA
az iot central job get-devices

获取作业设备状态。

分机 GA
az iot central job list

获取 IoT Central 应用程序的作业列表。

分机 GA
az iot central job rerun

在所有失败的设备上重新运行作业。

分机 GA
az iot central job resume

恢复已停止的作业。

扩展 GA
az iot central job show

按 ID 获取作业的详细信息。

分机 GA
az iot central job stop

停止正在运行的作业。

分机 GA
az iot central organization

管理和配置 IoT Central 应用程序的组织。

分机 GA
az iot central organization create

在应用程序中创建组织。

扩展 GA
az iot central organization delete

按 ID 删除组织。

扩展 GA
az iot central organization list

获取 IoT Central 应用程序的组织列表。

分机 GA
az iot central organization show

按 ID 获取组织的详细信息。

分机 GA
az iot central organization update

更新应用程序中的组织。

分机 GA
az iot central query

使用 IoT Central 查询语言查询设备遥测或属性数据。

扩展 预览
az iot central role

管理和配置 IoT Central 应用程序的角色。

分机 GA
az iot central role list

获取 IoT Central 应用程序的角色列表。

分机 GA
az iot central role show

按 ID 获取角色的详细信息。

扩展 GA
az iot central scheduled-job

管理和配置 IoT Central 计划作业。

分机 GA
az iot central scheduled-job create

按 ID 创建计划作业。

扩展 GA
az iot central scheduled-job delete

按 ID 删除现有的计划作业。

分机 GA
az iot central scheduled-job list

获取应用程序中的计划作业定义列表。

扩展 GA
az iot central scheduled-job list-runs

获取计划作业定义的作业实例列表。

扩展 GA
az iot central scheduled-job show

按 ID 获取有关计划作业的详细信息。

扩展 GA
az iot central scheduled-job update

按 ID 更新计划作业。

分机 GA
az iot central user

管理和配置 IoT Central 用户。

扩展 GA
az iot central user create

将用户添加到应用程序。

分机 GA
az iot central user delete

从应用程序中删除用户。

扩展 GA
az iot central user list

获取 IoT Central 应用程序的用户列表。

分机 GA
az iot central user show

按 ID 获取用户的详细信息。

分机 GA
az iot central user update

更新应用程序中用户的角色。

扩展 GA

az iot central query

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

使用 IoT Central 查询语言查询设备遥测或属性数据。

有关查询语法详细信息,请访问 https://docs.microsoft.com/en-us/azure/iot-central/core/howto-query-with-rest-api

az iot central query --app-id
                     --qs
                     [--api-version {2022-06-30-preview}]
                     [--central-api-uri]
                     [--token]

示例

查询设备遥测

az iot central query --app-id {appid} --query-string {query_string}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在应用程序“关于”页面的帮助菜单下找到应用 ID。

--qs --query-string

用于检索遥测或属性数据的查询子句。

可选参数

--api-version --av
已放弃

参数“api_version”已弃用,将在将来的版本中删除。

所请求操作的 API 版本。

接受的值: 2022-06-30-preview
默认值: 2022-06-30-preview
--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com
--token

如果想要在不对 Azure CLI 进行身份验证的情况下提交请求,可以指定有效的用户令牌对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi

全局参数
--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 获取完整的调试日志。