Share via

az iot du instance

  • リファレンス

Note

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

デバイス更新インスタンスの管理。

コマンド

名前 説明 型 Status
az iot du instance create

Device Update インスタンスを作成します。

 拡張子 GA
az iot du instance delete

Device Update インスタンスを削除します。

 拡張子 GA
az iot du instance list

デバイス更新インスタンスを一覧表示します。

 拡張子 GA
az iot du instance show

デバイス更新インスタンスを表示します。

 拡張子 GA
az iot du instance update

デバイス更新インスタンスを更新します。

 拡張子 GA
az iot du instance wait

目的のインスタンス リソースの状態が満たされるまでブロックします。

 拡張子 GA

az iot du instance create

Device Update インスタンスを作成します。

このコマンドは、既存のインスタンスの状態を更新するためにも使用できます。

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

例

最小構成でインスタンスを作成します。

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

診断が有効になっているインスタンスを作成し、ユーザー指定のストレージ アカウントとペアにします。 タグを含めます。

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

必須のパラメーター

--account -n

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

--instance -i

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

--iothub-ids

スペース区切りの IoT Hub リソース ID。

省略可能のパラメーター

--diagnostics-storage-id

診断ログ収集で使用するユーザー指定のストレージ アカウント リソース ID。

--enable-diagnostics

診断ログの収集を有効にします。

承認された値: false, true
--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--resource-group -g

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

--tags

リソース タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。

グローバル パラメーター
--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 instance delete

Device Update インスタンスを削除します。

az iot du instance delete --account
                          --instance
                          [--no-wait]
                          [--resource-group]
                          [--yes {false, true}]

例

ターゲット アカウントに関連付けられているインスタンスを削除します。

az iot du instance delete -n {account_name} -i {instance_name}

ターゲット アカウントに関連付けられているインスタンスを削除し、確認プロンプトをスキップします。

az iot du instance delete -n {account_name} -i {instance_name} -y

必須のパラメーター

--account -n

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

--instance -i

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

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--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 instance list

デバイス更新インスタンスを一覧表示します。

az iot du instance list --account
                        [--resource-group]

例

ターゲット アカウントに関連付けられているインスタンスを一覧表示します。

az iot du instance list -n {account_name}

必須のパラメーター

--account -n

Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<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 instance show

デバイス更新インスタンスを表示します。

az iot du instance show --account
                        --instance
                        [--resource-group]

例

ターゲット アカウントに関連付けられているインスタンスの詳細を表示します。

az iot du instance show -n {account_name} -i {instance_name}

必須のパラメーター

--account -n

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

--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 instance update

デバイス更新インスタンスを更新します。

現在、次のインスタンス プロパティ (iotHubs、enableDiagnostics、diagnosticStorageProperties、タグ) を更新できます。

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

例

特定のインスタンス タグ属性を設定します。

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

診断を有効にし、ログ収集用のストレージ アカウントを構成します。

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

必須のパラメーター

--account -n

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

--instance -i

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

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

既定値: []
--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

既定値: False
--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

既定値: []
--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

既定値: []
グローバル パラメーター
--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 instance wait

目的のインスタンス リソースの状態が満たされるまでブロックします。

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

例

ターゲット インスタンスが削除されるまでブロックします。

az iot du instance wait -n {account_name} -i {instance_name} --deleted

必須のパラメーター

--account -n

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

--instance -i

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

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--interval

ポーリング間隔 (秒単位)。

既定値: 30
--resource-group -g

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

--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: 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 を使います。