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

az iot dps policy

注释

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。安装每个扩展，使其受益于其扩展功能。了解更多关于扩展的信息。

管理 Azure IoT 中心设备预配服务实例中的共享访问策略。

命令

名称	说明	类型	Status
az iot dps policy create	在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略。	Core	GA
az iot dps policy create (azure-iot 扩展)	在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略。	Extension	GA
az iot dps policy delete	删除 Azure IoT 中心设备预配服务实例中的共享访问策略。	Core	GA
az iot dps policy delete (azure-iot 扩展)	删除 Azure IoT 中心设备预配服务实例中的共享访问策略。	Extension	GA
az iot dps policy list	列出 Azure IoT 中心设备预配服务实例中的所有共享访问策略。	Core	GA
az iot dps policy list (azure-iot 扩展)	列出 Azure IoT 中心设备预配服务实例中的所有共享访问策略。	Extension	GA
az iot dps policy show	在Azure IoT 中心设备预配服务实例中显示共享访问策略的详细信息。	Core	GA
az iot dps policy show (azure-iot 扩展)	在Azure IoT 中心设备预配服务实例中显示共享访问策略的详细信息。	Extension	GA
az iot dps policy update	更新 Azure IoT 中心设备预配服务实例中的共享访问策略。	Core	GA
az iot dps policy update (azure-iot 扩展)	更新 Azure IoT 中心设备预配服务实例中的共享访问策略。	Extension	GA

az iot dps policy create

编辑

在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略。

az iot dps policy create --dps-name
                         --pn --policy-name
                         --rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}
                         [--no-wait]
                         [--primary-key]
                         [--resource-group]
                         [--secondary-key]

示例

使用 EnrollmentRead 权限在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略

az iot dps policy create --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --rights EnrollmentRead

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

--rights -r

IoT 中心设备预配服务的访问权限。对多个权限使用空格分隔的列表。

属性	值
接受的值:	DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

可选参数

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

--no-wait

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

属性	值
默认值:	False

--primary-key

主 SAS 密钥值（如果未提供）将由服务生成。

--resource-group -g

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

--secondary-key

辅助 SAS 密钥值（如果未提供）将由服务生成。

全局参数

--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 iot dps policy create (azure-iot 扩展)

在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略。

az iot dps policy create --dps-name
                         --pn --policy-name
                         --rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}
                         [--no-wait]
                         [--primary-key]
                         [--resource-group]
                         [--secondary-key]

示例

使用 EnrollmentRead 权限在 Azure IoT 中心设备预配服务实例中创建新的共享访问策略

az iot dps policy create --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --rights EnrollmentRead

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

--rights -r

IoT 中心设备预配服务的访问权限。对多个权限使用空格分隔的列表。

属性	值
接受的值:	DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

可选参数

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

--no-wait

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

属性	值
默认值:	False

--primary-key

主 SAS 密钥值（如果未提供）将由服务生成。

--resource-group -g

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

--secondary-key

辅助 SAS 密钥值（如果未提供）将由服务生成。

全局参数

--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 iot dps policy delete

编辑

删除 Azure IoT 中心设备预配服务实例中的共享访问策略。

az iot dps policy delete --dps-name
                         --pn --policy-name
                         [--no-wait]
                         [--resource-group]

示例

在 Azure IoT 中心设备预配服务实例“MyDps”中删除共享访问策略“MyPolicy”

az iot dps policy delete --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

可选参数

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

--no-wait

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

属性	值
默认值:	False

--resource-group -g

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

全局参数

--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 iot dps policy delete (azure-iot 扩展)

删除 Azure IoT 中心设备预配服务实例中的共享访问策略。

az iot dps policy delete --dps-name
                         --pn --policy-name
                         [--no-wait]
                         [--resource-group]

示例

在 Azure IoT 中心设备预配服务实例“MyDps”中删除共享访问策略“MyPolicy”

az iot dps policy delete --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

可选参数

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

--no-wait

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

属性	值
默认值:	False

--resource-group -g

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

全局参数

--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 iot dps policy list

编辑

列出 Azure IoT 中心设备预配服务实例中的所有共享访问策略。

az iot dps policy list --dps-name
                       [--resource-group]

示例

列出 Azure IoT 中心设备预配服务实例“MyDps”中 MyDps 中的所有共享访问策略

az iot dps policy list --dps-name MyDps --resource-group MyResourceGroup

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

可选参数

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

--resource-group -g

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

全局参数

--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 iot dps policy list (azure-iot 扩展)

列出 Azure IoT 中心设备预配服务实例中的所有共享访问策略。

az iot dps policy list --dps-name
                       [--resource-group]

示例

列出 Azure IoT 中心设备预配服务实例“MyDps”中 MyDps 中的所有共享访问策略

az iot dps policy list --dps-name MyDps --resource-group MyResourceGroup

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

可选参数

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

--resource-group -g

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

全局参数

--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 iot dps policy show

编辑

在Azure IoT 中心设备预配服务实例中显示共享访问策略的详细信息。

az iot dps policy show --dps-name
                       --pn --policy-name
                       [--resource-group]

示例

显示 Azure IoT 中心设备预配服务实例“MyDps”中共享访问策略“MyPolicy”的详细信息

az iot dps policy show --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

可选参数

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

--resource-group -g

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

全局参数

--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 iot dps policy show (azure-iot 扩展)

在Azure IoT 中心设备预配服务实例中显示共享访问策略的详细信息。

az iot dps policy show --dps-name
                       --pn --policy-name
                       [--resource-group]

示例

显示 Azure IoT 中心设备预配服务实例“MyDps”中共享访问策略“MyPolicy”的详细信息

az iot dps policy show --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

可选参数

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

--resource-group -g

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

全局参数

--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 iot dps policy update

编辑

更新 Azure IoT 中心设备预配服务实例中的共享访问策略。

az iot dps policy update --dps-name
                         --pn --policy-name
                         [--no-wait]
                         [--primary-key]
                         [--resource-group]
                         [--rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}]
                         [--secondary-key]

示例

使用 EnrollmentWrite 权限更新 Azure IoT 中心设备预配服务实例中的共享访问策略“MyPolicy”

az iot dps policy update --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --rights EnrollmentWrite

通过将密钥更新为空值，重新生成访问策略“MyPolicy”的密钥

az iot dps policy update --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --primary-key "" --secondary-key ""

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

可选参数

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

--no-wait

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

属性	值
默认值:	False

--primary-key

主 SAS 密钥值。设置为空字符串，以便重新生成新的主键。

--resource-group -g

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

--rights -r

IoT 中心设备预配服务的访问权限。对多个权限使用空格分隔的列表。

属性	值
接受的值:	DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

--secondary-key

辅助 SAS 密钥值。设置为空字符串，以便重新生成新的辅助密钥。

全局参数

--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 iot dps policy update (azure-iot 扩展)

更新 Azure IoT 中心设备预配服务实例中的共享访问策略。

az iot dps policy update --dps-name
                         --pn --policy-name
                         [--no-wait]
                         [--primary-key]
                         [--resource-group]
                         [--rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}]
                         [--secondary-key]

示例

使用 EnrollmentWrite 权限更新 Azure IoT 中心设备预配服务实例中的共享访问策略“MyPolicy”

az iot dps policy update --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --rights EnrollmentWrite

通过将密钥更新为空值，重新生成访问策略“MyPolicy”的密钥

az iot dps policy update --dps-name MyDps --resource-group MyResourceGroup --policy-name MyPolicy --primary-key "" --secondary-key ""

必需参数

--dps-name -n

IoT 中心设备预配服务名称。

--pn --policy-name

DPS 访问策略的友好名称。

可选参数

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

--no-wait

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

属性	值
默认值:	False

--primary-key

主 SAS 密钥值。设置为空字符串，以便重新生成新的主键。

--resource-group -g

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

--rights -r

IoT 中心设备预配服务的访问权限。对多个权限使用空格分隔的列表。

属性	值
接受的值:	DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

--secondary-key

辅助 SAS 密钥值。设置为空字符串，以便重新生成新的辅助密钥。

全局参数

--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

反馈

此页面是否有帮助？