az iot hub module-identity
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot hub module-identity コマンドを 初めて実行するときに自動的に インストールされます。 拡張機能の詳細をご覧ください。
IoT デバイス モジュールを管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az iot hub module-identity connection-string |
IoT デバイス モジュールの接続文字列を管理します。 |
拡張子 | GA |
az iot hub module-identity connection-string show |
ターゲット IoT デバイス モジュールの接続文字列を表示します。 |
拡張子 | GA |
az iot hub module-identity create |
IoT Hub 内のターゲット IoT デバイスにモジュールを作成します。 |
拡張子 | GA |
az iot hub module-identity delete |
IoT Hub 内のデバイスを削除します。 |
拡張子 | GA |
az iot hub module-identity list |
IoT Hub 内の IoT デバイスにあるモジュールを一覧表示します。 |
拡張子 | GA |
az iot hub module-identity renew-key |
Sas 認証を使用して IoT Hub デバイス モジュールのターゲット キーを更新します。 |
拡張子 | GA |
az iot hub module-identity show |
IoT Hub 内の IoT デバイス モジュールの詳細を取得します。 |
拡張子 | GA |
az iot hub module-identity update |
IoT Hub デバイス モジュールを更新します。 |
拡張子 | GA |
az iot hub module-identity create
IoT Hub 内のターゲット IoT デバイスにモジュールを作成します。
shared_private_keyの認証方法 (対称キーとも呼ばれます) を使用する場合、カスタム キーが提供されていない場合、サービスによってモジュール用に生成されます。
az iot hub module-identity create --device-id
--module-id
[--am {shared_private_key, x509_ca, x509_thumbprint}]
[--auth-type {key, login}]
[--hub-name]
[--login]
[--od]
[--pk]
[--primary-thumbprint]
[--resource-group]
[--secondary-key]
[--secondary-thumbprint]
[--valid-days]
必須のパラメーター
ターゲット デバイス ID。
ターゲット モジュール 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 module-identity delete
IoT Hub 内のデバイスを削除します。
az iot hub module-identity delete --device-id
--module-id
[--auth-type {key, login}]
[--etag]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
ターゲット モジュール 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 module-identity list
IoT Hub 内の IoT デバイスにあるモジュールを一覧表示します。
az iot hub module-identity list --device-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
[--top]
必須のパラメーター
ターゲット デバイス 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>
を使用して、既定のグループを構成できます。
返される要素の最大数。 無制限の場合は -1 を使用します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot hub module-identity renew-key
Sas 認証を使用して IoT Hub デバイス モジュールのターゲット キーを更新します。
az iot hub module-identity renew-key --device-id
--hub-name
--key-type {primary, secondary, swap}
--module-id
[--auth-type {key, login}]
[--etag]
[--login]
[--resource-group]
例
主キーを更新します。
az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary
プライマリ キーとセカンダリ キーを交換します。
az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap
必須のパラメーター
ターゲット デバイス ID。
IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。
再生成するターゲット キーの種類。
ターゲット モジュール ID。
省略可能のパラメーター
操作でポリシー キーを自動的に派生させるか、現在の 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 module-identity show
IoT Hub 内の IoT デバイス モジュールの詳細を取得します。
az iot hub module-identity show --device-id
--module-id
[--auth-type {key, login}]
[--hub-name]
[--login]
[--resource-group]
必須のパラメーター
ターゲット デバイス ID。
ターゲット モジュール 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 module-identity update
IoT Hub デバイス モジュールを更新します。
モジュールを更新するために、--set の後にプロパティの割り当てを使用します。 "iot hub module-identity show" から返されるプロパティを活用します。
az iot hub module-identity update --device-id
--module-id
[--add]
[--auth-type {key, login}]
[--etag]
[--force-string]
[--hub-name]
[--login]
[--remove]
[--resource-group]
[--set]
例
モジュールの対称認証キーを再生成する
az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""
必須のパラメーター
ターゲット デバイス ID。
ターゲット モジュール 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 が指定されていない場合は必須です。
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI