az iot dps policy

このコマンド グループには、Azure CLIと少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細については、 を参照してください。

Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシーを管理します。

コマンド

名前 説明 状態
az iot dps policy create

Azure IoT Hub Device Provisioning Service インスタンスに新しい共有アクセス ポリシーを作成します。

Core GA
az iot dps policy create (azure-iot 拡張機能)

Azure IoT Hub Device Provisioning Service インスタンスに新しい共有アクセス ポリシーを作成します。

Extension GA
az iot dps policy delete

Azure IoT Hub Device Provisioning Service インスタンス内の共有アクセス ポリシーを削除します。

Core GA
az iot dps policy delete (azure-iot 拡張機能)

Azure IoT Hub Device Provisioning Service インスタンス内の共有アクセス ポリシーを削除します。

Extension GA
az iot dps policy list

Azure IoT Hub Device Provisioning Service インスタンス内のすべての共有アクセス ポリシーを一覧表示します。

Core GA
az iot dps policy list (azure-iot 拡張機能)

Azure IoT Hub Device Provisioning Service インスタンス内のすべての共有アクセス ポリシーを一覧表示します。

Extension GA
az iot dps policy show

Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシーの詳細を表示します。

Core GA
az iot dps policy show (azure-iot 拡張機能)

Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシーの詳細を表示します。

Extension GA
az iot dps policy update

Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシーを更新します。

Core GA
az iot dps policy update (azure-iot 拡張機能)

Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシーを更新します。

Extension GA

az iot dps policy create

Azure IoT Hub Device Provisioning Service インスタンスに新しい共有アクセス ポリシーを作成します。

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

EnrollmentRead 権限を持つ Azure IoT Hub Device Provisioning Service インスタンスに新しい共有アクセス ポリシーを作成する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

--rights -r

IoT Hub Device Provisioning Service のアクセス権。 複数の権限にスペース区切りリストを使用します。

プロパティ
指定可能な値: DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--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 Hub Device Provisioning Service インスタンスに新しい共有アクセス ポリシーを作成します。

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

EnrollmentRead 権限を持つ Azure IoT Hub Device Provisioning Service インスタンスに新しい共有アクセス ポリシーを作成する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

--rights -r

IoT Hub Device Provisioning Service のアクセス権。 複数の権限にスペース区切りリストを使用します。

プロパティ
指定可能な値: DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--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 Hub Device Provisioning Service インスタンス内の共有アクセス ポリシーを削除します。

az iot dps policy delete --dps-name
                         --pn --policy-name
                         [--acquire-policy-token]
                         [--change-reference]
                         [--no-wait]
                         [--resource-group]

Azure IoT Hub Device Provisioning Service インスタンス 'MyDps' の共有アクセス ポリシー 'MyPolicy' を削除する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--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 Hub Device Provisioning Service インスタンス内の共有アクセス ポリシーを削除します。

az iot dps policy delete --dps-name
                         --pn --policy-name
                         [--acquire-policy-token]
                         [--change-reference]
                         [--no-wait]
                         [--resource-group]

Azure IoT Hub Device Provisioning Service インスタンス 'MyDps' の共有アクセス ポリシー 'MyPolicy' を削除する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--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 Hub Device Provisioning Service インスタンス内のすべての共有アクセス ポリシーを一覧表示します。

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

Azure IoT Hub Device Provisioning Service インスタンス 'MyDps' 内の MyDps 内のすべての共有アクセス ポリシーを一覧表示する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--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 Hub Device Provisioning Service インスタンス内のすべての共有アクセス ポリシーを一覧表示します。

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

Azure IoT Hub Device Provisioning Service インスタンス 'MyDps' 内の MyDps 内のすべての共有アクセス ポリシーを一覧表示する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--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 Hub Device Provisioning Service インスタンスの共有アクセス ポリシーの詳細を表示します。

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

Azure IoT Hub Device Provisioning Service インスタンス 'MyDps' に共有アクセス ポリシー 'MyPolicy' の詳細を表示する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--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 Hub Device Provisioning Service インスタンスの共有アクセス ポリシーの詳細を表示します。

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

Azure IoT Hub Device Provisioning Service インスタンス 'MyDps' に共有アクセス ポリシー 'MyPolicy' の詳細を表示する

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

必須のパラメーター

--dps-name -n

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--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 Hub Device Provisioning Service インスタンスの共有アクセス ポリシーを更新します。

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

EnrollmentWrite 権限を使用して、Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシー '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

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--primary-key

プライマリ SAS キーの値。 新しい主キーを再生成するために空の文字列に設定します。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--rights -r

IoT Hub Device Provisioning Service のアクセス権。 複数の権限にスペース区切りリストを使用します。

プロパティ
指定可能な値: 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 Hub Device Provisioning Service インスタンスの共有アクセス ポリシーを更新します。

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

EnrollmentWrite 権限を使用して、Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシー '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

device Provisioning Service 名をIoT Hubします。

--pn --policy-name

DPS アクセス ポリシーのフレンドリ名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--primary-key

プライマリ SAS キーの値。 新しい主キーを再生成するために空の文字列に設定します。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--rights -r

IoT Hub Device Provisioning Service のアクセス権。 複数の権限にスペース区切りリストを使用します。

プロパティ
指定可能な値: 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