Share via

az iot hub state

  • 実験用
  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.37.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot hub state コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

このコマンド グループは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

IoT Hub の状態を管理します。

詳細については、「aka.ms/aziotcli-iot-hub-state」を参照してください。

コマンド

名前 説明 型 Status
az iot hub state export

IoT Hub の状態をファイルにエクスポートします。

 拡張 Experimental
az iot hub state import

ファイルから IoT Hub にハブの状態をインポートします。

 拡張 Experimental
az iot hub state migrate

ファイルに保存せずに、あるハブの状態を別のハブに移行します。

 拡張 Experimental

az iot hub state export

実験用

コマンド グループ "IoT ハブの状態" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

IoT Hub の状態をファイルにエクスポートします。

既定では、エクスポートされた状態には、ハブの arm テンプレート、ハブ構成 (ADM 構成とエッジ デプロイを含む)、デバイス情報 (デバイス ID、デバイス ツイン、モジュール ID、モジュール ツインなど) が含まれます。

詳細については、「aka.ms/aziotcli-iot-hub-state」を参照してください。

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

例

指定したハブのサポートされている状態を、指定したファイルにエクスポートします。

az iot hub state export -n {iothub_name} -f {state_filename}

指定したハブのサポートされている状態を指定したファイルにエクスポートし、ファイルの内容を上書きします。

az iot hub state export -n {iothub_name} -f {state_filename} -r

指定したハブのデバイスと構成のみを、指定したファイルにエクスポートします。

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

必須のパラメーター

--state-file -f

状態情報が格納されるファイルへのパス。

省略可能のパラメーター

--aspects

ハブの側面 (スペース区切り)。

承認された値: arm, configurations, devices
--auth-type

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

承認された値: key, login
既定値: key
--hub-name -n

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

--login -l

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

--replace -r

このフラグが設定されている場合、コマンドは出力ファイルの内容を上書きします。

既定値: 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 hub state import

実験用

コマンド グループ "IoT ハブの状態" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ファイルから IoT Hub にハブの状態をインポートします。

arm の側面が指定されている場合、ハブが存在しない場合は作成されます。

既定では、インポートされた状態には、ハブの arm テンプレート、ハブ構成 (ADM 構成とエッジ デプロイを含む)、デバイス情報 (デバイス ID、デバイス ツイン、モジュール ID、モジュール ツインなど) が含まれます。

システム割り当て ID 認証を使用してインポートされたエンドポイントの場合、指定されたハブには適切なアクセス許可が必要です。 それ以外の場合、コマンドは失敗します。

インポート プロセスでは、プライベート エンドポイントは無視されます。

詳細については、「aka.ms/aziotcli-iot-hub-state」を参照してください。

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

例

指定したファイルから指定したハブに、サポートされている状態をインポートします。

az iot hub state import -n {iothub_name} -f {state_filename}

サポートされている状態を指定したファイルから指定したハブにインポートし、ハブの以前の状態を上書きします。 新しい状態がアップロードされる前に、すべての証明書、構成、およびデバイスが削除されます。

az iot hub state import -n {iothub_name} -f {state_filename} -r

指定したファイルから指定したハブに arm テンプレートのみをインポートします。 存在しない場合は、新しいハブが作成されることに注意してください。 ファイルにはデバイスと構成が含まれている場合がありますが、これらは無視されます。

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

指定したファイルから指定したハブにデバイスと構成のみをインポートします。 新しいハブが存在せず、コマンドが失敗する場合、新しいハブは作成されないことに注意してください。 ファイルには arm テンプレートが含まれている場合がありますが、これは無視されます。

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

必須のパラメーター

--state-file -f

状態情報が格納されるファイルへのパス。

省略可能のパラメーター

--aspects

ハブの側面 (スペース区切り)。

承認された値: arm, configurations, devices
--auth-type

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

承認された値: key, login
既定値: key
--hub-name -n

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

--login -l

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

--replace -r

このフラグが設定されている場合、コマンドは宛先ハブの現在のデバイス、構成、および証明書を削除します。

既定値: 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 hub state migrate

実験用

コマンド グループ "IoT ハブの状態" は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ファイルに保存せずに、あるハブの状態を別のハブに移行します。

arm の側面が指定されている場合、ハブが存在しない場合は作成されます。

既定では、移行された状態には、ハブの arm テンプレート、ハブ構成 (ADM 構成とエッジデプロイを含む)、デバイス情報 (デバイス ID、デバイス ツイン、モジュール ID、モジュール ツインなど) が含まれます。

システム割り当て ID 認証を使用して移行されたエンドポイントの場合、指定されたハブには適切なアクセス許可が必要です。 それ以外の場合、コマンドは失敗します。

移行プロセスでは、プライベート エンドポイントは無視されます。

移行に問題がある場合は、エクスポートコマンドとインポートコマンドを使用してファイルをバックアップとして使用してください。

詳細については、「aka.ms/aziotcli-iot-hub-state」を参照してください。

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub]
                         [--destination-hub-login]
                         [--destination-resource-group]
                         [--og]
                         [--oh]
                         [--ol]
                         [--replace]

例

配信元ハブのサポートされている状態を移行先ハブに移行します。

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

配信元ハブのサポートされている状態を移行先ハブに移行し、ハブの以前の状態を上書きします。 新しい状態がアップロードされる前に、宛先ハブ内のすべての証明書、構成、およびデバイスが削除されます。

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

配信元ハブから移行先ハブに arm テンプレートのみを移行します。 ターゲット ハブが存在しない場合は、新しいハブが作成されることに注意してください。 配信元ハブにはデバイスと構成が含まれている場合がありますが、これらは無視されます。

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

デバイスと構成のみを配信元ハブから移行先ハブに移行します。 ターゲット ハブが存在せず、コマンドが失敗する場合、新しいハブは作成されないことに注意してください。 配信元ハブの arm テンプレートは無視されます。

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

省略可能のパラメーター

--aspects

ハブの側面 (スペース区切り)。

承認された値: arm, configurations, devices
--auth-type

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

承認された値: key, login
既定値: key
--destination-hub --dh

配信元ハブの状態のコピー先となる IoT Hub の名前。

--destination-hub-login --dl

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

--destination-resource-group --dg

配信元ハブの状態のコピー先となる IoT Hub のリソース グループの名前。 指定しない場合は、配信元の IoT Hub のリソース グループを使用します。

--og --origin-resource-group

コピーされる IoT Hub のリソース グループの名前。

--oh --origin-hub

コピーされる IoT Hub の名前。

--ol --origin-hub-login

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

--replace -r

このフラグが設定されている場合、コマンドは宛先ハブの現在のデバイス、構成、および証明書を削除します。

既定値: False
グローバル パラメーター
--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 を使います。