az iot hub device-identity
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot hub device-identity コマンドを 初めて実行するときに自動的に インストールされます。 拡張機能の詳細をご覧ください。
IoT デバイスを管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az iot hub device-identity children |
IoT エッジ デバイスの子デバイスリレーションシップを管理します。 |
拡張子 | GA |
az iot hub device-identity children add |
デバイスを子としてターゲット エッジ デバイスに追加します。 |
拡張子 | GA |
az iot hub device-identity children list |
割り当てられた子デバイスのコレクションを出力します。 |
拡張子 | GA |
az iot hub device-identity children remove |
ターゲット エッジ デバイスから子デバイスを削除します。 |
拡張子 | GA |
az iot hub device-identity connection-string |
IoT デバイスの接続文字列を管理します。 |
拡張子 | GA |
az iot hub device-identity connection-string show |
特定の IoT Hub デバイス 接続文字列を表示します。 |
拡張子 | GA |
az iot hub device-identity create |
IoT Hub にデバイスを作成します。 |
拡張子 | GA |
az iot hub device-identity delete |
IoT Hub デバイスを削除します。 |
拡張子 | GA |
az iot hub device-identity export |
IoT Hub から Azure Storage BLOB コンテナーにすべてのデバイス ID をエクスポートします。 |
拡張子 | GA |
az iot hub device-identity import |
ストレージ コンテナー BLOB から IoT Hub にデバイス ID をインポートします。 |
拡張子 | GA |
az iot hub device-identity list |
IoT Hub 内のデバイスを一覧表示します。 |
拡張子 | GA |
az iot hub device-identity parent |
IoT デバイスの親デバイスのリレーションシップを管理します。 |
拡張子 | GA |
az iot hub device-identity parent set |
ターゲット デバイスの親デバイスを設定します。 |
拡張子 | GA |
az iot hub device-identity parent show |
ターゲット デバイスの親デバイスを取得します。 |
拡張子 | GA |
az iot hub device-identity renew-key |
Sas 認証を使用して IoT Hub デバイスのターゲット キーを更新します。 |
拡張子 | GA |
az iot hub device-identity show |
IoT Hub デバイスの詳細を取得します。 |
拡張子 | GA |
az iot hub device-identity update |
IoT Hub デバイスを更新します。 |
拡張子 | GA |
az iot hub device-identity create
IoT Hub にデバイスを作成します。
shared_private_keyの認証方法 (対称キーとも呼ばれます) を使用する場合、カスタム キーが提供されていない場合、サービスによってデバイス用に生成されます。
エッジ デバイスのデバイス スコープが指定されている場合、値は自動的に親スコープに変換されます。
az iot hub device-identity create --device-id
[--am {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--device-scope]
[--edge-enabled {false, true}]
[--hub-name]
[--login]
[--od]
[--pk]
[--primary-thumbprint]
[--resource-group]
[--secondary-key]
[--secondary-thumbprint]
[--sta {disabled, enabled}]
[--star]
[--valid-days]
例
既定の認可 (共有秘密キー) を使用して、エッジ対応 IoT デバイスを作成します。
az iot hub device-identity create -n {iothub_name} -d {device_id} --ee
自己署名証明書の承認を使用して IoT デバイスを作成し、10 日間有効な証明書を生成し、その拇印を使用します。
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10
自己署名証明書の承認を使用して IoT デバイスを作成し、既定の有効期限 (365 日) の証明書を生成し、ターゲット ディレクトリに出力します。
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output
自己署名証明書の承認を使用して IoT デバイスを作成し、プライマリとセカンダリの拇印を明示的に提供します。
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}
状態と理由が無効になっているルート CA 承認を使用して IoT デバイスを作成します。
az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'
デバイス スコープを持つ IoT デバイスを作成します。
az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
エンティティの作成に使用する承認方法。
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
デバイスのスコープ。 エッジ デバイスの場合、これは自動生成され、変更できません。 リーフ デバイスの場合は、これを設定して子/親リレーションシップを作成します。
エッジの有効化を示すフラグ。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
自己署名証明書を生成し、その拇印を使用します。 指定したターゲット ディレクトリへの出力。
base64 形式で格納されている主対称共有アクセス キー。
プライマリ拇印に使用する自己署名証明書の拇印。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
base64 形式で格納されているセカンダリ対称共有アクセス キー。
セカンダリ拇印に使用する自己署名証明書の拇印。
作成時にデバイスの状態を設定します。
デバイスの状態の説明。
自己署名証明書を生成し、その拇印を使用します。 指定した日数有効です。 既定値: 365。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity delete
IoT Hub デバイスを削除します。
az iot hub device-identity delete --device-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity export
IoT Hub から Azure Storage BLOB コンテナーにすべてのデバイス ID をエクスポートします。
デバイス ID を含む出力 BLOB は、"devices.txt" という名前のテキスト ファイルです。
アクセス許可が必要 - "レジストリの読み取りおよびレジストリ書き込み" をサポートする IoT Hub 共有アクセス ポリシーか、IoT Hub で "IoT Hub データ共同作成者" ロールを持つプリンシパル。
ストレージ アカウント名と BLOB コンテナー名のパラメーターは、ストレージ アカウントが入力 IoT Hub と同じサブスクリプションにある場合にのみ使用できます。 インライン BLOB コンテナーの SAS URI 入力については、環境の入力規則を確認してください。
詳細については、https://aka.ms/iothub-device-exportimportを参照してください。
az iot hub device-identity export [--auth-type {key, login}]
[--bc]
[--bcu]
[--hub-name]
[--identity]
[--ik {false, true}]
[--login]
[--resource-group]
[--sa]
例
構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートし、デバイス キーを含めます。 BLOB コンテナー名とストレージ アカウント名は、コマンドのパラメーターとして提供されます。
az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}
構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートし、デバイス キーを含めます。 インライン SAS URI の例を使用します。
az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'
SAS URI を含むファイル パスを使用して、構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートします。
az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}
構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートし、デバイス キーを含めます。 ストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つシステム割り当て ID を使用します。 BLOB コンテナー名とストレージ アカウント名は、コマンドのパラメーターとして提供されます。
az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]
構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートし、デバイス キーを含めます。 ストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つシステム割り当て ID を使用します。 BLOB コンテナー URI には、BLOB SAS トークンは必要ありません。
az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]
構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートし、デバイス キーを含めます。 ストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つユーザー割り当てマネージド ID を使用します。 BLOB コンテナー名とストレージ アカウント名は、コマンドのパラメーターとして提供されます。
az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}
構成済みの BLOB コンテナーにすべてのデバイス ID をエクスポートし、デバイス キーを含めます。 ストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つユーザー割り当てマネージド ID を使用します。 BLOB コンテナー URI には、BLOB SAS トークンは必要ありません。
az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
この BLOB コンテナーは、デバイス ID インポート ジョブの状態と結果を出力するために使用されます。 blob_container_uriが指定されている場合、パラメーターは無視されます。 この BLOB コンテナーには、書き込み、読み取り、削除のアクセスが必要です。
BLOB コンテナーへの書き込み、読み取り、および削除アクセスを含む BLOB Shared Access Signature URI。 これは、ジョブの状態と結果を出力するために使用されます。 注: ID ベースの認証を使用する場合、https:// URI は引き続き必要ですが、SAS トークンは必要ありません。 この引数の入力は、インラインまたはファイル パスから指定できます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
システム割り当てマネージド ID またはユーザー割り当てマネージド ID のどちらを使用するかを決定するマネージド ID の種類。 システム割り当てマネージド ID の場合は、[system] を使用します。 ユーザー割り当てマネージド ID の場合は、ユーザー割り当てマネージド ID リソース ID を指定します。この ID には、ストレージ アカウントのストレージ BLOB データ共同作成者ロールが必要です。
設定すると、キーは通常どおりにエクスポートされます。 それ以外の場合、エクスポート出力ではキーが null に設定されます。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
出力 BLOB コンテナーを含む Azure Storage アカウントの名前。blob_container_uriが指定されている場合、パラメーターは無視されます。 書き込み、読み取り、削除のアクセス権が必要です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity import
ストレージ コンテナー BLOB から IoT Hub にデバイス ID をインポートします。
デバイス ID を含む予想される入力ファイルには、"devices.txt" という名前を付ける必要があります。 インポートが成功すると、出力ログ ファイル 'importErrors.log' は空になり、インポートエラーが発生した場合のエラー ログが含まれます。
アクセス許可が必要 - "レジストリの読み取りおよびレジストリ書き込み" をサポートする IoT Hub 共有アクセス ポリシーか、IoT Hub で "IoT Hub データ共同作成者" ロールを持つプリンシパル。
ストレージ アカウント名と BLOB コンテナー名のパラメーターは、ストレージ アカウントが入力 IoT Hub と同じサブスクリプションにある場合にのみ使用できます。 インライン BLOB コンテナーの SAS URI 入力については、環境の入力規則を確認してください。
詳細については、https://aka.ms/iothub-device-exportimportを参照してください。
az iot hub device-identity import [--auth-type {key, login}]
[--hub-name]
[--ibc]
[--ibcu]
[--identity]
[--input-storage-account]
[--login]
[--obc]
[--obcu]
[--osa]
[--resource-group]
例
入力 BLOB コンテナーとストレージ アカウントのコマンド パラメーターと、出力 BLOB コンテナーとストレージ アカウントを指定して、BLOB からすべてのデバイス ID をインポートします。
az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}
インライン SAS URI を使用して、BLOB からすべてのデバイス ID をインポートします。
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}
SAS URI を含むファイル パスを使用して、BLOB からすべてのデバイス ID をインポートします。
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}
両方のストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つシステム割り当て ID を使用して、BLOB からすべてのデバイス ID をインポートします。 入力 BLOB コンテナーとストレージ アカウント、および出力 BLOB コンテナーとストレージ アカウントは、コマンドのパラメーターとして提供されます
az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]
両方のストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つシステム割り当て ID を使用して、BLOB からすべてのデバイス ID をインポートします。 BLOB コンテナー URI には、BLOB SAS トークンは必要ありません。
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]
両方のストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つユーザー割り当てマネージド ID を使用して、BLOB からすべてのデバイス ID をインポートします。 入力 BLOB コンテナーとストレージ アカウント、および出力 BLOB コンテナーとストレージ アカウントは、コマンドのパラメーターとして提供されます
az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}
両方のストレージ アカウントのストレージ BLOB データ共同作成者ロールを持つユーザー割り当てマネージド ID を使用して、BLOB からすべてのデバイス ID をインポートします。 BLOB コンテナー URI には、BLOB SAS トークンは必要ありません。
az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
この BLOB コンテナーには、ID レジストリで実行する操作を定義するファイルが格納されます。 パラメーターは、input_blob_container_uriが指定されている場合は無視されます。 この BLOB コンテナーには読み取りアクセスが必要です。
BLOB コンテナーへの読み取りアクセス権を持つ BLOB Shared Access Signature URI。 この BLOB には、ID レジストリに対して実行される操作が含まれています。 注: ID ベースの認証を使用する場合、https:// URI は引き続き必要ですが、SAS トークンは必要ありません。 この引数の入力は、インラインまたはファイル パスから指定できます。
システム割り当てマネージド ID またはユーザー割り当てマネージド ID のどちらを使用するかを決定するマネージド ID の種類。 システム割り当てマネージド ID の場合は、[system] を使用します。 ユーザー割り当てマネージド ID の場合は、ユーザー割り当てマネージド ID リソース ID を指定します。この ID には、ターゲット ストレージ アカウントのストレージ BLOB データ共同作成者ロールと、IoT Hub の共同作成者ロールが必要です。
入力 BLOB コンテナーを含む Azure Storage アカウントの名前。input_blob_container_uriが指定されていない場合にのみ必要です。 読み取りアクセスが必要です。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
この BLOB コンテナーは、デバイス ID インポート ジョブの状態と結果を出力するために使用されます。 input_blob_container_uriが指定されていない場合にのみ必要です。 この BLOB コンテナーには書き込みアクセスが必要です。
BLOB コンテナーへの書き込みアクセス権を持つ BLOB Shared Access Signature URI。 これは、ジョブの状態と結果を出力するために使用されます。 注: ID ベースの認証を使用する場合は、SAS トークンのない https:// URI が必要です。 この引数の入力は、インラインまたはファイル パスから指定できます。
出力 BLOB コンテナーを含む Azure Storage アカウントの名前。パラメーターは、output_blob_container_uriが指定されている場合は無視されます。 書き込みアクセス権が必要です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity list
IoT Hub 内のデバイスを一覧表示します。
このコマンドはエイリアス az iot hub device-twin list
であり、このコマンドよりも強くお勧めします。 今後、この az iot hub device-identity list
コマンドは変更または非推奨になる可能性があります。
az iot hub device-identity list [--auth-type {key, login}]
[--edge-enabled {false, true}]
[--hub-name]
[--login]
[--resource-group]
[--top]
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
エッジの有効化を示すフラグ。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
返される要素の最大数。 無制限の場合は -1 を使用します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity renew-key
Sas 認証を使用して IoT Hub デバイスのターゲット キーを更新します。
az iot hub device-identity renew-key --device-id
--hub-name
--key-type {primary, secondary, swap}
[--auth-type {key, login}]
[--etag]
[--login]
[--resource-group]
例
主キーを更新します。
az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary
プライマリ キーとセカンダリ キーを交換します。
az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap
必須のパラメーター
ターゲット デバイス ID。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
再生成するターゲット キーの種類。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity show
IoT Hub デバイスの詳細を取得します。
az iot hub device-identity show --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub device-identity update
IoT Hub デバイスを更新します。
--set の後に、デバイスを更新するためのプロパティの割り当てを使用します。 "iot hub device-identity show" から返されるパラメーターを活用します。
az iot hub device-identity update --device-id
[--add]
[--am {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--edge-enabled {false, true}]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--pk]
[--primary-thumbprint]
[--remove]
[--resource-group]
[--secondary-key]
[--secondary-thumbprint]
[--set]
[--sta {disabled, enabled}]
[--star]
例
デバイスのエッジ機能を有効にする
az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true
便利な引数を使用して、デバイスのエッジ機能を有効にします。
az iot hub device-identity update -d {device_id} -n {iothub_name} --ee
デバイスの状態を無効にする
az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled
便利な引数を使用してデバイスの状態を無効にします。
az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled
1 つのコマンドで
az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true
必須のパラメーター
ターゲット デバイス ID。
省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
エンティティの作成に使用する承認方法。
操作でポリシー キーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。 認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>
既定値を構成できます。
エッジの有効化を示すフラグ。
リソースの最後の状態に対応する Etag またはエンティティ タグ。 etag が指定されていない場合は、値 '*' が使用されます。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
このコマンドは、アクションを実行する権限を持つエンティティ 接続文字列をサポートします。 "az login" によるセッション ログインを回避するために使用します。 エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。
base64 形式で格納されている主対称共有アクセス キー。
プライマリ拇印に使用する自己署名証明書の拇印。
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
base64 形式で格納されているセカンダリ対称共有アクセス キー。
セカンダリ拇印に使用する自己署名証明書の拇印。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
作成時にデバイスの状態を設定します。
デバイスの状態の説明。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI