az iot dps policy

リファレンス

Azure IoT Hub Device Provisioning Service に対する共有アクセスポリシーを管理します。

コマンド

名前	説明	型	状態
az iot dps policy create	Azure IoT Hub Device Provisioning Service インスタンス内に新しい共有アクセスポリシーを作成します。	コア	GA
az iot dps policy delete	Azure IoT Hub Device Provisioning Service インスタンス内にある共有アクセスポリシーを削除します。	コア	GA
az iot dps policy list	Azure IoT Hub Device Provisioning Service インスタンス内にあるすべての共有アクセスポリシーを一覧表示します。	コア	GA
az iot dps policy show	Azure IoT Hub Device Provisioning Service インスタンスの共有アクセスポリシーの詳細を表示します。	コア	GA
az iot dps policy update	Azure IoT Hub Device Provisioning Service インスタンス内にある共有アクセスポリシーを更新します。	コア	GA

az iot dps policy create

編集

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

az iot dps policy create --dps-name
                         --pn
                         --rights {DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig}
                         [--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

IoT Hub Device Provisioning Service 名。

--pn --policy-name

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

--rights -r

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

指定可能な値: DeviceConnect, EnrollmentRead, EnrollmentWrite, RegistrationStatusRead, RegistrationStatusWrite, ServiceConfig

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--primary-key

プライマリ SAS キー値 (指定されていない場合) は、サービスによって生成されます。

--resource-group -g

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

--secondary-key

指定されていない場合は、セカンダリ SAS キー値がサービスによって生成されます。

グローバルパラメーター

--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 を使います。

az iot dps policy delete

編集

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

az iot dps policy delete --dps-name
                         --pn
                         [--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

IoT Hub Device Provisioning Service 名。

--pn --policy-name

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

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

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

グローバルパラメーター

--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 を使います。

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

IoT Hub Device Provisioning Service 名。

省略可能のパラメーター

--resource-group -g

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

グローバルパラメーター

--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 を使います。

az iot dps policy show

編集

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

az iot dps policy show --dps-name
                       --pn
                       [--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

IoT Hub Device Provisioning Service 名。

--pn --policy-name

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

省略可能のパラメーター

--resource-group -g

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

グローバルパラメーター

--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 を使います。

az iot dps policy update

編集

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

az iot dps policy update --dps-name
                         --pn
                         [--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

IoT Hub Device Provisioning Service 名。

--pn --policy-name

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

省略可能のパラメーター

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

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--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 を使います。

次の方法で共有

az iot dps policy

コマンド

az iot dps policy create

例

必須のパラメーター

省略可能のパラメーター

az iot dps policy delete

例

必須のパラメーター

省略可能のパラメーター

az iot dps policy list

例

必須のパラメーター

省略可能のパラメーター

az iot dps policy show

例

必須のパラメーター

省略可能のパラメーター

az iot dps policy update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース