az iot dps

Note

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

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

コマンド

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

az iot dps create

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

Azure IoT Hub Device Provisioning Service の概要については、https://learn.microsoft.com/azure/iot-dps/about-iot-dpsを参照してください。

az iot dps create --name
                  --resource-group
                  [--edr --enforce-data-residency {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>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

IoT Hub Device Provisioning Service 名。

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

IoT Hub Device Provisioning Service 名。

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

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"

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--force-string

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	False

--ids

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

プロパティ	値
Parameter group:	Resource Id Arguments

--name -n

IoT Hub Device Provisioning Service 名。

プロパティ	値
Parameter group:	Resource Id Arguments

--remove

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--resource-group -g

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

プロパティ	値
Parameter group:	Resource Id Arguments

--set

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--subscription

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

プロパティ	値
Parameter group:	Resource Id Arguments

--tags

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

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False