az iot dps

Note

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

Azure IoT Hub Device Provisioning Service を管理します。

コマンド

名前	説明	型	状態
az iot dps certificate	Azure IoT Hub Device Provisioning Service インスタンスの証明書を管理します。	コア	GA
az iot dps certificate create	Azure IoT Hub Device Provisioning Service インスタンスに証明書を作成/アップロードします。	コア	GA
az iot dps certificate delete	Azure IoT Hub Device Provisioning Service インスタンス内の証明書を削除します。	コア	GA
az iot dps certificate generate-verification-code	Azure IoT Hub Device Provisioning Service インスタンスで証明書の検証コードを生成します。	コア	GA
az iot dps certificate list	Azure IoT Hub Device Provisioning Service インスタンスに含まれるすべての証明書を一覧表示します。	コア	GA
az iot dps certificate show	Azure IoT Hub Device Provisioning Service インスタンス内の特定の証明書に関する情報を表示します。	コア	GA
az iot dps certificate update	Azure IoT Hub Device Provisioning Service インスタンスの証明書を更新します。	コア	GA
az iot dps certificate verify	Azure IoT Hub Device Provisioning Service インスタンス内の証明書を確認します。	コア	GA
az iot dps compute-device-key	派生デバイス SAS キーを生成します。	拡張子	"非推奨"
az iot dps connection-string	Azure IoT Hub Device Provisioning Service インスタンスの接続文字列を管理します。	拡張子	GA
az iot dps connection-string show	指定したポリシー名とキーを使用して、指定した Device Provisioning Services の接続文字列を表示します。	拡張子	GA
az iot dps create	Azure IoT Hub Device Provisioning Service インスタンスを作成します。	コア	GA
az iot dps delete	Azure IoT Hub Device Provisioning Service インスタンスを削除します。	コア	GA
az iot dps enrollment	Azure IoT Hub Device Provisioning Service で個々のデバイス登録を管理します。	拡張子	GA
az iot dps enrollment-group	Azure IoT Hub Device Provisioning Service で登録グループを管理します。	拡張子	GA
az iot dps enrollment-group compute-device-key	Azure IoT Hub Device Provisioning Service の登録グループの派生デバイス SAS キーを生成します。	拡張子	GA
az iot dps enrollment-group create	Azure IoT Hub Device Provisioning Service に登録グループを作成します。	拡張子	GA
az iot dps enrollment-group delete	Azure IoT Hub Device Provisioning Service の登録グループを削除します。	拡張子	GA
az iot dps enrollment-group list	Azure IoT Hub Device Provisioning Service の登録グループを一覧表示します。	拡張子	GA
az iot dps enrollment-group registration	Azure IoT Hub Device Provisioning Service の登録グループのサービス側デバイス登録を管理します。	拡張子	GA
az iot dps enrollment-group registration delete	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を削除します。	拡張子	GA
az iot dps enrollment-group registration list	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を一覧表示します。	拡張子	GA
az iot dps enrollment-group registration show	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を取得します。	拡張子	GA
az iot dps enrollment-group show	Azure IoT Hub Device Provisioning Service で登録グループの詳細を取得します。	拡張子	GA
az iot dps enrollment-group update	Azure IoT Hub Device Provisioning Service の登録グループを更新します。	拡張子	GA
az iot dps enrollment create	Azure IoT Hub Device Provisioning Service で個々のデバイス登録を作成します。	拡張子	GA
az iot dps enrollment delete	Azure IoT Hub Device Provisioning Service で個々のデバイス登録を削除します。	拡張子	GA
az iot dps enrollment list	Azure IoT Hub Device Provisioning Service で個々のデバイス登録を一覧表示します。	拡張子	GA
az iot dps enrollment registration	Azure IoT Hub Device Provisioning Service での個々の登録のサービス側デバイス登録を管理します。	拡張子	GA
az iot dps enrollment registration delete	Azure IoT Hub Device Provisioning Service での個々の登録のデバイス登録を削除します。	拡張子	GA
az iot dps enrollment registration show	Azure IoT Hub Device Provisioning Service での個々の登録のデバイス登録を取得します。	拡張子	GA
az iot dps enrollment show	Azure IoT Hub Device Provisioning Service で個々のデバイス登録の詳細を取得します。	拡張子	GA
az iot dps enrollment update	Azure IoT Hub Device Provisioning Service で個々のデバイス登録を更新します。	拡張子	GA
az iot dps linked-hub	Azure IoT Hub Device Provisioning Service インスタンスでリンクされた IoT Hub を管理します。	コア	GA
az iot dps linked-hub create	Azure IoT Hub Device Provisioning Service インスタンス内にリンク済み IoT ハブを作成します。	コア	GA
az iot dps linked-hub delete	Azure IoT Hub Device Provisioning Service インスタンス内にあるリンク済み IoT ハブを更新します。	コア	GA
az iot dps linked-hub list	Azure IoT Hub Device Provisioning Service インスタンス内にあるすべてのリンク済み IoT ハブを一覧表示します。	コア	GA
az iot dps linked-hub show	Azure IoT Hub Device Provisioning Service インスタンス内にあるリンク済み IoT ハブの詳細を表示します。	コア	GA
az iot dps linked-hub update	Azure IoT Hub Device Provisioning Service インスタンス内にあるリンク済み IoT ハブを更新します。	コア	GA
az iot dps list	Azure IoT Hub Device Provisioning Service インスタンスを一覧表示します。	コア	GA
az iot dps policy	Azure IoT Hub Device Provisioning Service インスタンスの共有アクセス ポリシーを管理します。	コア	GA
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 registration	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を管理します。	拡張子	"非推奨"
az iot dps registration delete	Azure IoT Hub Device Provisioning Service でデバイス登録を削除します。	拡張子	"非推奨"
az iot dps registration list	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を一覧表示します。	拡張子	"非推奨"
az iot dps registration show	Azure IoT Hub Device Provisioning Service の登録グループのデバイス登録を取得します。	拡張子	"非推奨"
az iot dps show	Azure IoT Hub Device Provisioning Service インスタンスの詳細を取得します。	コア	GA
az iot dps update	Azure IoT Hub Device Provisioning Service インスタンスを更新します。	コア	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}

必須のパラメーター

--registration-id

デバイス登録の ID。

省略可能のパラメーター

--auth-type

操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iotdps-data-auth-type=<auth-type-value>既定値を構成できます。

指定可能な値: key, login

規定値: key

--dps-name -n

Azure IoT Hub Device Provisioning Service の名前またはホスト名。 --login が指定されていない場合は必須。

--eid --enrollment-id --gid --group-id

登録グループ ID。

--key --symmetric-key

登録グループの対称共有アクセス キー。 これにより、Device Provisioning Service レジストリがバイパスされ、追加の検証なしで、指定された対称キーから直接 SAS トークンが生成されます。 登録 ID 以外の他のすべてのコマンド パラメーターは無視されます。

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --dps-name が指定されていない場合は必須です。

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

Azure IoT Hub Device Provisioning Service インスタンスを作成します。

Azure IoT Hub Device Provisioning Service の概要については、次を参照してください 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]

例

リソース グループのリージョンに、Standard 価格レベル S1 を使用して Azure IoT Hub Device Provisioning Service を作成します。

az iot dps create --name MyDps --resource-group MyResourceGroup

"eastus" リージョンに、Standard 価格レベル S1 を使用して Azure IoT Hub Device Provisioning Service を作成します。

az iot dps create --name MyDps --resource-group MyResourceGroup --location eastus

データ所在地が適用された Azure IoT Hub Device Provisioning Service を作成します。 これにより、リージョン間のディザスター リカバリーが無効になります。

az iot dps create --name MyDps --resource-group MyResourceGroup --edr

必須のパラメーター

--name -n

IoT Hub Device Provisioning Service 名。

--resource-group -g

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

省略可能のパラメーター

--edr --enforce-data-residency

geo ペア間のディザスター リカバリーを無効にして、この IoT Hub Device Provisioning Service のデータ所在地を強制します。 このプロパティは、リソースに設定されると変更できません。 一部のリージョンでのみ使用できます。 詳細については、https://aka.ms/dpsdr をご覧ください。

指定可能な値: false, true

--location -l

IoT Hub Device Provisioning Service の場所。 既定値は、ターゲット リソース グループの場所です。

--sku

IoT Hub Device Provisioning Service の価格レベル。

指定可能な値: S1

規定値: S1

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--unit

IoT Hub Device Provisioning Service のユニット。

規定値: 1

グローバル パラメーター

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

Azure IoT Hub Device Provisioning Service インスタンスを削除します。

az iot dps delete [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

例

Azure IoT Hub Device Provisioning Service 'MyDps' を削除する

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

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

IoT Hub Device Provisioning Service 名。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

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

Azure IoT Hub Device Provisioning Service インスタンスを一覧表示します。

az iot dps list [--resource-group]

例

サブスクリプション内のすべての Azure IoT Hub Device Provisioning Services を一覧表示します。

az iot dps list

リソース グループ 'MyResourceGroup' 内のすべての Azure IoT Hub Device Provisioning Services を一覧表示する

az iot dps list --resource-group MyResourceGroup

省略可能のパラメーター

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

Azure IoT Hub Device Provisioning Service インスタンスの詳細を取得します。

az iot dps show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

例

Azure IoT Hub Device Provisioning Service 'MyDps' の詳細を表示する

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

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

IoT Hub Device Provisioning Service 名。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

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

Azure IoT Hub Device Provisioning Service インスタンスを更新します。

az iot dps update [--add]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]
                  [--tags]

例

Azure IoT Hub Device Provisioning Service 'MyDps' の割り当てポリシーを 'GeoLatency' に更新する

az iot dps update --name MyDps --resource-group MyResourceGroup --set properties.allocationPolicy="GeoLatency"

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

規定値: []

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

IoT Hub Device Provisioning Service 名。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

規定値: []

--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

規定値: []

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

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