az iot du device deployment
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot du device deployment コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
デバイス展開の管理。
展開では、ターゲット デバイス グループに対して必要な互換性のある更新プログラムが適用され、グループ内のデバイス クラス間で更新プログラムが配布されます。 クラウドによって開始されるロールバック ポリシーは、必要に応じて構成できます。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az iot du device deployment cancel |
デバイス クラス サブグループのデプロイをキャンセルします。 |
拡張子 | GA |
az iot du device deployment create |
デバイス グループの展開を作成します。 デプロイは、ターゲット グループ内のすべてのデバイス クラス サブグループに対してマルチキャストされます。 |
拡張子 | GA |
az iot du device deployment delete |
デバイス グループまたはデバイス クラス サブグループ別にデプロイを削除します。 |
拡張子 | GA |
az iot du device deployment list |
デバイス グループまたはデバイス クラス サブグループの展開を一覧表示します。 |
拡張子 | GA |
az iot du device deployment list-devices |
デバイス クラス サブグループ展開内のデバイスとその状態を一覧表示します。 失敗したデバイスの一覧を取得するのに役立ちます。 |
拡張子 | GA |
az iot du device deployment retry |
デバイス クラス サブグループのデプロイを再試行します。 |
拡張子 | GA |
az iot du device deployment show |
デバイス グループまたはデバイス クラス サブグループの展開を表示します。これには、展開中、完了済み、または失敗したデバイスの数の詳細を示す状態が含まれます。 |
拡張子 | GA |
az iot du device deployment cancel
デバイス クラス サブグループのデプロイをキャンセルします。
az iot du device deployment cancel --account
--cid
--deployment-id
--gid
--instance
[--resource-group]
例
ターゲット デバイス クラスサブグループのデプロイをキャンセルします。
az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。
呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot du device deployment create
デバイス グループの展開を作成します。 デプロイは、ターゲット グループ内のすべてのデバイス クラス サブグループに対してマルチキャストされます。
az iot du device deployment create --account
--deployment-id
--gid
--instance
--un
--up
--update-version
[--failed-count]
[--failed-percentage]
[--rbun]
[--rbup]
[--rbuv]
[--resource-group]
[--start-time]
例
(UTC 時刻に関して) すぐに開始するようにスケジュールされたデバイス グループの展開を作成します。
az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}
必要な iso-8601 準拠の datetime で開始するようにスケジュールされたデバイス グループ展開を作成します。
az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"
定義されたクラウドによって開始されるロールバック ポリシーを使用して、すぐに開始するようにスケジュールされたデバイス グループのデプロイを作成します。 クラウドのロールバックは、失敗した数または失敗した割合のターゲットが満たされたときに開始されます。
az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
更新プログラムの名前。
更新プロバイダー。
更新プログラムのバージョン。
省略可能のパラメーター
クラウドのロールバックが発生する前のデプロイで失敗したデバイスの数を表す整数。 ロールバック ポリシーを定義するときに必要です。
クラウドのロールバックが発生する前のデプロイで失敗したデバイスの割合を表す整数。 ロールバック ポリシーを定義するときに必要です。
ロールバック更新プログラムの名前。
ロールバック更新プロバイダー。
ロールバック更新プログラムのバージョン。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
iso-8601 準拠のデプロイの開始時刻。 値が指定されていない場合は、UTC 'now' の対応する値が使用されます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot du device deployment delete
デバイス グループまたはデバイス クラス サブグループ別にデプロイを削除します。
az iot du device deployment delete --account
--deployment-id
--gid
--instance
[--cid]
[--resource-group]
[--yes {false, true}]
例
ターゲット デバイス グループの展開を削除します。
az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id}
ターゲット デバイス クラス サブグループのデプロイを削除します。
az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot du device deployment list
デバイス グループまたはデバイス クラス サブグループの展開を一覧表示します。
az iot du device deployment list --account
--gid
--instance
[--cid]
[--order-by]
[--resource-group]
例
デバイス グループの展開を一覧表示します。
az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id}
startDateTime の降順で、デバイス グループの順序付け結果の展開を一覧表示します。
az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"
デバイス クラス サブグループの展開を一覧表示します。
az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。
返されるデプロイのセットを注文します。 順序は startDateTime [desc/asc] で行うことができます。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot du device deployment list-devices
デバイス クラス サブグループ展開内のデバイスとその状態を一覧表示します。 失敗したデバイスの一覧を取得するのに役立ちます。
az iot du device deployment list-devices --account
--cid
--deployment-id
--gid
--instance
[--filter]
[--resource-group]
例
デバイス クラス サブグループ展開内のデバイスを一覧表示します。
az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}
deviceId と deviceState でフィルター処理するデバイス クラス サブグループ展開内のデバイスを一覧表示します。
az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。
呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
返される展開デバイスの状態のセットを制限します。 deviceId と moduleId または deviceState でフィルター処理できます。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot du device deployment retry
デバイス クラス サブグループのデプロイを再試行します。
az iot du device deployment retry --account
--cid
--deployment-id
--gid
--instance
[--resource-group]
例
ターゲット デバイス クラスサブグループのデプロイを再試行します。
az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。
呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot du device deployment show
デバイス グループまたはデバイス クラス サブグループの展開を表示します。これには、展開中、完了済み、または失敗したデバイスの数の詳細を示す状態が含まれます。
az iot du device deployment show --account
--deployment-id
--gid
--instance
[--cid]
[--resource-group]
[--status {false, true}]
例
デバイス グループの展開を表示します。
az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id}
デバイス グループの展開の状態を表示します。
az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --status
デバイス クラス サブグループのデプロイを表示します。
az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}
デバイス クラス サブグループ展開の状態を表示します。
az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status
必須のパラメーター
Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>
構成できます。
呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。
デバイス グループ ID。これは、接続されている IoT Hub のデバイス/モジュール ツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。
デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>
構成できます。
省略可能のパラメーター
デバイス クラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。 これは、16 進数でエンコードされた SHA1 ハッシュです。
Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name>
を使用して、既定のグループを構成できます。
展開中、完了済み、または失敗したデバイスの数の内訳を含む、展開の状態を取得します。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI