你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az iot dps
注意
此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展,使其受益于其扩展功能。 详细了解扩展。
管理 Azure IoT 中心设备预配服务。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az iot dps certificate |
管理Azure IoT 中心设备预配服务实例的证书。 |
核心 | GA |
az iot dps certificate create |
创建/上传Azure IoT 中心设备预配服务实例的 certficate。 |
核心 | GA |
az iot dps certificate delete |
删除Azure IoT 中心设备预配服务实例中的证书。 |
核心 | GA |
az iot dps certificate generate-verification-code |
为Azure IoT 中心设备预配服务实例中的证书生成验证码。 |
核心 | GA |
az iot dps certificate list |
列出Azure IoT 中心设备预配服务实例中包含的所有证书。 |
核心 | GA |
az iot dps certificate show |
显示有关Azure IoT 中心设备预配服务实例中特定证书的信息。 |
核心 | GA |
az iot dps certificate update |
更新Azure IoT 中心设备预配服务实例中的证书。 |
核心 | GA |
az iot dps certificate verify |
验证Azure IoT 中心设备预配服务实例中的证书。 |
核心 | GA |
az iot dps compute-device-key |
生成派生的设备 SAS 密钥。 |
扩展 | 已放弃 |
az iot dps connection-string |
管理Azure IoT 中心设备预配服务实例的连接字符串。 |
扩展 | GA |
az iot dps connection-string show |
使用给定的策略名称和密钥显示指定设备预配服务的连接字符串。 |
扩展 | GA |
az iot dps create |
创建 Azure IoT 中心设备预配服务实例。 |
核心 | GA |
az iot dps delete |
删除 Azure IoT 中心设备预配服务实例。 |
核心 | GA |
az iot dps enrollment |
在Azure IoT 中心设备预配服务中管理单个设备注册。 |
扩展 | GA |
az iot dps enrollment-group |
管理Azure IoT 中心设备预配服务中的注册组。 |
扩展 | GA |
az iot dps enrollment-group compute-device-key |
为Azure IoT 中心设备预配服务中的注册组生成派生的设备 SAS 密钥。 |
扩展 | GA |
az iot dps enrollment-group create |
在Azure IoT 中心设备预配服务中创建注册组。 |
扩展 | GA |
az iot dps enrollment-group delete |
删除Azure IoT 中心设备预配服务中的注册组。 |
扩展 | GA |
az iot dps enrollment-group list |
列出Azure IoT 中心设备预配服务中的注册组。 |
扩展 | GA |
az iot dps enrollment-group registration |
在Azure IoT 中心设备预配服务中管理注册组的服务端设备注册。 |
扩展 | GA |
az iot dps enrollment-group registration delete |
删除Azure IoT 中心设备预配服务中注册组的设备注册。 |
扩展 | GA |
az iot dps enrollment-group registration list |
列出Azure IoT 中心设备预配服务中注册组的设备注册。 |
扩展 | GA |
az iot dps enrollment-group registration show |
获取Azure IoT 中心设备预配服务中注册组的设备注册。 |
扩展 | GA |
az iot dps enrollment-group show |
在Azure IoT 中心设备预配服务中获取注册组的详细信息。 |
扩展 | GA |
az iot dps enrollment-group update |
更新Azure IoT 中心设备预配服务中的注册组。 |
扩展 | GA |
az iot dps enrollment create |
在Azure IoT 中心设备预配服务中创建单个设备注册。 |
扩展 | GA |
az iot dps enrollment delete |
删除Azure IoT 中心设备预配服务中的单个设备注册。 |
扩展 | GA |
az iot dps enrollment list |
列出Azure IoT 中心设备预配服务中的单个设备注册。 |
扩展 | GA |
az iot dps enrollment registration |
在Azure IoT 中心设备预配服务中管理单个注册的服务端设备注册。 |
扩展 | GA |
az iot dps enrollment registration delete |
删除Azure IoT 中心设备预配服务中单个注册的设备注册。 |
扩展 | GA |
az iot dps enrollment registration show |
获取Azure IoT 中心设备预配服务中单个注册的设备注册。 |
扩展 | GA |
az iot dps enrollment show |
获取Azure IoT 中心设备预配服务中的单个设备注册详细信息。 |
扩展 | GA |
az iot dps enrollment update |
更新Azure IoT 中心设备预配服务中的单个设备注册。 |
扩展 | GA |
az iot dps linked-hub |
管理Azure IoT 中心设备预配服务实例中的链接IoT 中心。 |
核心 | GA |
az iot dps linked-hub create |
在 Azure IoT 中心设备预配服务实例中创建链接的 IoT 中心。 |
核心 | GA |
az iot dps linked-hub delete |
更新 Azure IoT 中心设备预配服务实例中链接的 IoT 中心。 |
核心 | GA |
az iot dps linked-hub list |
列出 Azure IoT 中心设备预配服务实例中所有链接的 IoT 中心。 |
核心 | GA |
az iot dps linked-hub show |
显示 Azure IoT 中心设备预配服务中实例链接的 IoT 中心的详细信息。 |
核心 | GA |
az iot dps linked-hub update |
更新 Azure IoT 中心设备预配服务实例中链接的 IoT 中心。 |
核心 | GA |
az iot dps list |
列出 Azure IoT 中心设备预配服务实例。 |
核心 | GA |
az iot dps policy |
管理Azure IoT 中心设备预配服务实例的共享访问策略。 |
核心 | GA |
az iot dps policy create |
在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略。 |
核心 | GA |
az iot dps policy delete |
删除 Azure IoT 中心设备预配服务实例中的共享访问策略。 |
核心 | GA |
az iot dps policy list |
列出 Azure IoT 中心设备预配服务实例中的所有共享访问策略。 |
核心 | GA |
az iot dps policy show |
在Azure IoT 中心设备预配服务实例中显示共享访问策略的详细信息。 |
核心 | GA |
az iot dps policy update |
更新 Azure IoT 中心设备预配服务实例中的共享访问策略。 |
核心 | GA |
az iot dps registration |
管理Azure IoT 中心设备预配服务中注册组的设备注册。 |
扩展 | 已放弃 |
az iot dps registration delete |
删除Azure IoT 中心设备预配服务中的设备注册。 |
扩展 | 已放弃 |
az iot dps registration list |
列出Azure IoT 中心设备预配服务中注册组的设备注册。 |
扩展 | 已放弃 |
az iot dps registration show |
获取Azure IoT 中心设备预配服务中注册组的设备注册。 |
扩展 | 已放弃 |
az iot dps show |
获取 Azure IoT 中心设备预配服务实例。 |
核心 | GA |
az iot dps update |
更新 Azure IoT 中心设备预配服务实例。 |
核心 | GA |
az iot dps compute-device-key
此命令已弃用,将在将来的版本中删除。 请改用“iot dps enrollment-group compute-device-key”。
生成派生的设备 SAS 密钥。
为 DPS 注册组生成派生的设备密钥。
az iot dps compute-device-key --registration-id
[--auth-type {key, login}]
[--dps-name]
[--eid]
[--key]
[--login]
[--resource-group]
示例
使用给定的对称密钥计算设备密钥。
az iot dps compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
使用给定的注册组计算设备密钥。
az iot dps compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}
必需参数
设备注册的 ID。
可选参数
指示操作是应自动派生策略密钥还是使用当前的 Azure AD 会话。 如果身份验证类型为登录,并且提供资源主机名,则除非需要,否则将跳过资源查找。可以使用 < a0/a0> 配置默认值 az configure --defaults iotdps-data-auth-type=<auth-type-value>
。
Azure IoT 中心设备预配服务的名称或主机名。 如果未提供 --login,则为必需。
注册组 ID。
注册组的对称共享访问密钥。 这会绕过设备预配服务注册表,并直接从提供的对称密钥生成 SAS 令牌,而无需进一步验证。 除了注册 ID 之外,所有其他命令参数将被忽略。
此命令支持具有执行操作权限的实体连接字符串。 用于避免通过“az login”进行会话登录。 如果同时提供实体连接字符串和名称,则连接字符串优先。 如果未提供 --dps-name,则为必需。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot dps create
创建 Azure IoT 中心设备预配服务实例。
有关Azure IoT 中心设备预配服务的简介,请参阅https://docs.microsoft.com/azure/iot-dps/about-iot-dps。
az iot dps create --name
--resource-group
[--edr {false, true}]
[--location]
[--sku {S1}]
[--tags]
[--unit]
示例
在资源组的区域中创建具有标准定价层 S1 的设备预配服务Azure IoT 中心。
az iot dps create --name MyDps --resource-group MyResourceGroup
在“eastus”区域中,使用标准定价层 S1 创建Azure IoT 中心设备预配服务。
az iot dps create --name MyDps --resource-group MyResourceGroup --location eastus
使用强制实施数据驻留创建Azure IoT 中心设备预配服务。 这将禁用跨区域灾难恢复。
az iot dps create --name MyDps --resource-group MyResourceGroup --edr
必需参数
IoT 中心设备预配服务名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
通过禁用跨异地对灾难恢复来强制实施此IoT 中心设备预配服务的数据驻留。 在资源上设置此属性后,此属性是不可变的。 仅在选择区域中可用。 更多信息请访问 https://aka.ms/dpsdr。
IoT 中心设备预配服务的位置。 默认值为目标资源组的位置。
IoT 中心设备预配服务的定价层。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
IoT 中心设备预配服务中的单位。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot dps delete
删除 Azure IoT 中心设备预配服务实例。
az iot dps delete [--ids]
[--name]
[--resource-group]
[--subscription]
示例
删除Azure IoT 中心设备预配服务“MyDps”
az iot dps delete --name MyDps --resource-group MyResourceGroup
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
IoT 中心设备预配服务名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot dps list
列出 Azure IoT 中心设备预配服务实例。
az iot dps list [--resource-group]
示例
列出订阅中的所有Azure IoT 中心设备预配服务。
az iot dps list
列出资源组“MyResourceGroup”中的所有Azure IoT 中心设备预配服务
az iot dps list --resource-group MyResourceGroup
可选参数
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot dps show
获取 Azure IoT 中心设备预配服务实例。
az iot dps show [--ids]
[--name]
[--resource-group]
[--subscription]
示例
显示Azure IoT 中心设备预配服务“MyDps”的详细信息
az iot dps show --name MyDps --resource-group MyResourceGroup
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
IoT 中心设备预配服务名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az iot dps update
更新 Azure IoT 中心设备预配服务实例。
az iot dps update [--add]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
示例
将分配策略更新为Azure IoT 中心设备预配服务“MyDps”的“GeoLatency”
az iot dps update --name MyDps --resource-group MyResourceGroup --set properties.allocationPolicy="GeoLatency"
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
IoT 中心设备预配服务名称。
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。