次の方法で共有


az iot du instance

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az iot du instance コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

コマンド

名前 説明 状態
az iot du instance create

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

Extension GA
az iot du instance delete

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

Extension GA
az iot du instance list

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

Extension GA
az iot du instance show

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

Extension GA
az iot du instance update

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

Extension GA
az iot du instance wait

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

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

診断が有効なインスタンスを作成し、ユーザー指定のストレージ アカウントとペアにします。 Include tags.

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}を使用して、既定のアカウント名を構成できます。

プロパティ
Parameter group: Account Identifier Arguments
--instance -i

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

プロパティ
Parameter group: Account Identifier Arguments
--iothub-ids

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

プロパティ
Parameter group: IoT Hub Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--diagnostics-storage-id

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

プロパティ
Parameter group: Storage Arguments
--enable-diagnostics

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

プロパティ
指定可能な値: false, true
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--resource-group -g

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

プロパティ
Parameter group: Account Identifier Arguments
--tags

Resource tags. 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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}を使用して、既定のアカウント名を構成できます。

プロパティ
Parameter group: Account Identifier Arguments
--instance -i

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

プロパティ
Parameter group: Account Identifier Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--resource-group -g

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

プロパティ
Parameter group: Account Identifier Arguments
--yes -y

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

プロパティ
指定可能な値: false, true
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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}を使用して、既定のアカウント名を構成できます。

プロパティ
Parameter group: Account Identifier Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

プロパティ
Parameter group: Account Identifier Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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}を使用して、既定のアカウント名を構成できます。

プロパティ
Parameter group: Account Identifier Arguments
--instance -i

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

プロパティ
Parameter group: Account Identifier Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

プロパティ
Parameter group: Account Identifier Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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}を使用して、既定のアカウント名を構成できます。

プロパティ
Parameter group: Account Identifier Arguments
--instance -i

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

プロパティ
Parameter group: Account Identifier Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

プロパティ
Parameter group: Generic Update Arguments
規定値: []
--force-string

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

プロパティ
Parameter group: Generic Update Arguments
規定値: False
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--remove

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

プロパティ
Parameter group: Generic Update Arguments
規定値: []
--resource-group -g

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

プロパティ
Parameter group: Account Identifier Arguments
--set

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

プロパティ
Parameter group: Generic Update Arguments
規定値: []
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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}を使用して、既定のアカウント名を構成できます。

プロパティ
Parameter group: Account Identifier Arguments
--instance -i

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

プロパティ
Parameter group: Account Identifier Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--custom

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

プロパティ
Parameter group: Wait Condition Arguments
--deleted

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--exists

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--interval

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 30
--resource-group -g

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

プロパティ
Parameter group: Account Identifier Arguments
--timeout

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ
規定値: False
--output -o

Output format.

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False