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
必須のパラメーター
Device Update アカウント名。
az config set defaults.adu_account={name}
を使用して、既定のアカウント名を構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
デバイス更新インスタンス名。
az config set defaults.adu_instance={name}
を使用して、既定のインスタンス名を構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
スペース区切りの 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.
診断ログ収集で使用するユーザー指定のストレージ アカウント リソース ID。
プロパティ | 値 |
---|---|
Parameter group: | Storage Arguments |
診断ログの収集を有効にします。
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
規定値: | False |
Device Update アカウントのリソース グループ名。
az config set defaults.adu_group={name}
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
Resource tags. 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
Device Update アカウント名。
az config set defaults.adu_account={name}
を使用して、既定のアカウント名を構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
デバイス更新インスタンス名。
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.
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
規定値: | False |
Device Update アカウントのリソース グループ名。
az config set defaults.adu_group={name}
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 Default: false.
プロパティ | 値 |
---|---|
指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az iot du instance list
デバイス更新インスタンスを一覧表示します。
az iot du instance list --account
[--resource-group]
例
ターゲット アカウントに関連付けられているインスタンスを一覧表示します。
az iot du instance list -n {account_name}
必須のパラメーター
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.
Device Update アカウントのリソース グループ名。
az config set defaults.adu_group={name}
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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}
必須のパラメーター
Device Update アカウント名。
az config set defaults.adu_account={name}
を使用して、既定のアカウント名を構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
デバイス更新インスタンス名。
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.
Device Update アカウントのリソース グループ名。
az config set defaults.adu_group={name}
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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}
必須のパラメーター
Device Update アカウント名。
az config set defaults.adu_account={name}
を使用して、既定のアカウント名を構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
デバイス更新インスタンス名。
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 property.listProperty <key=value, string or JSON string>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | False |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
規定値: | False |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
Device Update アカウントのリソース グループ名。
az config set defaults.adu_group={name}
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
プロパティ | 値 |
---|---|
Parameter group: | Generic Update Arguments |
規定値: | [] |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
Device Update アカウント名。
az config set defaults.adu_account={name}
を使用して、既定のアカウント名を構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
デバイス更新インスタンス名。
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.
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
削除されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
リソースが存在するまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
ポーリング間隔 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 30 |
Device Update アカウントのリソース グループ名。
az config set defaults.adu_group={name}
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Account Identifier Arguments |
最大待機時間 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |