az iot du device deployment

リファレンス

Note

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

デバイス展開の管理。

展開では、ターゲットデバイスグループに対して必要な互換性のある更新プログラムが適用され、グループ内のデバイスクラス間で更新プログラムが配布されます。クラウドによって開始されるロールバックポリシーは、必要に応じて構成できます。

コマンド

名前	説明	型	状態
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}

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--cid --class-id

デバイスクラス ID。これは、IoT Hub の Device Update PnP インターフェイスでデバイス更新エージェントによって報告されるモデル ID と互換性プロパティから生成されます。これは、16 進数でエンコードされた SHA1 ハッシュです。

--deployment-id --did

呼び出し元が指定したデプロイ ID。これは 73 文字より長くすることはできません。すべて小文字にする必要があり、'>、'^'、'['、']'、'{'、'}'、'|'、''、'<'、'>'、スラッシュ、円記号、または二重引用符を含めることはできません。

--gid --group-id

デバイスグループ ID。これは、接続されている IoT Hub のデバイス/モジュールツインの ADUGroup タグの値から作成されるか、タグのないデバイスの$defaultから作成されます。

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_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 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}

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--deployment-id --did

--gid --group-id

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

--un --update-name

更新プログラムの名前。

--up --update-provider

更新プロバイダー。

--update-version --uv

更新プログラムのバージョン。

省略可能のパラメーター

--failed-count --fc

クラウドのロールバックが発生する前のデプロイで失敗したデバイスの数を表す整数。ロールバックポリシーを定義するときに必要です。

--failed-percentage --fp

クラウドのロールバックが発生する前のデプロイで失敗したデバイスの割合を表す整数。ロールバックポリシーを定義するときに必要です。

--rbun --rollback-update-name

ロールバック更新プログラムの名前。

--rbup --rollback-update-provider

ロールバック更新プロバイダー。

--rbuv --rollback-update-version

ロールバック更新プログラムのバージョン。

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--start-time

iso-8601 準拠のデプロイの開始時刻。値が指定されていない場合は、UTC 'now' の対応する値が使用されます。

グローバルパラメーター

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

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--deployment-id --did

--gid --group-id

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--cid --class-id

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--yes -y

ユーザープロンプトをスキップします。アクションの受け入れを示します。主に自動化シナリオに使用されます。既定値は false です。

指定可能な値: false, true

グローバルパラメーター

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

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--gid --group-id

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--cid --class-id

--order-by

返されるデプロイのセットを注文します。順序は startDateTime [desc/asc] で行うことができます。

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_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 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'"

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--cid --class-id

--deployment-id --did

--gid --group-id

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--filter

返される展開デバイスの状態のセットを制限します。 deviceId と moduleId または deviceState でフィルター処理できます。

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_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 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}

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--cid --class-id

--deployment-id --did

--gid --group-id

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_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 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

必須のパラメーター

--account -n

Device Update アカウント名。を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--deployment-id --did

--gid --group-id

--instance -i

デバイス更新インスタンス名。を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--cid --class-id

--resource-group -g

Device Update アカウントのリソースグループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--status

展開中、完了済み、または失敗したデバイスの数の内訳を含む、展開の状態を取得します。

指定可能な値: false, true

グローバルパラメーター

--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 du device deployment

コマンド

az iot du device deployment cancel

例

必須のパラメーター

省略可能のパラメーター

az iot du device deployment create

例

必須のパラメーター

省略可能のパラメーター

az iot du device deployment delete

例

必須のパラメーター

省略可能のパラメーター

az iot du device deployment list

例

必須のパラメーター

省略可能のパラメーター

az iot du device deployment list-devices

例

必須のパラメーター

省略可能のパラメーター

az iot du device deployment retry

例

必須のパラメーター

省略可能のパラメーター

az iot du device deployment show

例

必須のパラメーター

省略可能のパラメーター

その他のリソース