az iot adr ns su instance
Note
このリファレンスは、Azure CLI (バージョン 2.73.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、 az iot adr ns su instance コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
コマンド グループ 'iot adr ns' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
ソフトウェア更新プログラムを実行する Update インスタンスを管理します。
Update Instances は最上位レベルのMicrosoftです。DeviceUpdate リソース。 これらは Device Registry の検出可能性のためにここにグループ化されていますが、名前空間の子ではありません。
コマンド
| Name | 説明 | 型 | 状態 |
|---|---|---|---|
| az iot adr ns su instance check-name |
Update Instance 名が使用可能かどうかを確認します。 |
Extension | Preview |
| az iot adr ns su instance create |
Update インスタンスを作成します。 |
Extension | Preview |
| az iot adr ns su instance delete |
Update インスタンスを削除します。 |
Extension | Preview |
| az iot adr ns su instance list |
更新インスタンスを一覧表示します。 |
Extension | Preview |
| az iot adr ns su instance show |
Update インスタンスを表示します。 |
Extension | Preview |
| az iot adr ns su instance update |
Update Instance のタグまたはマネージド ID を更新します。 |
Extension | Preview |
| az iot adr ns su instance wait |
インスタンスの更新条件を待ちます。 |
Extension | Preview |
az iot adr ns su instance check-name
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
Update Instance 名が使用可能かどうかを確認します。
az iot adr ns su instance check-name --name
[--acquire-policy-token]
[--change-reference]
例
名前を確認する
az iot adr ns su instance check-name -n myUpdateInstance
必須パラメーター
Update インスタンスの名前。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot adr ns su instance create
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
Update インスタンスを作成します。
Microsoftを作成します。DeviceUpdate/updateInstances リソース。 マネージド ID 引数を組み合わせて、指定された場合の完全な目的の ID 状態を記述できます。 いずれかの ID オプションを指定せずに create を再実行すると、既存のインスタンスの SAMI/UAMI 構成、タグ、およびサービスマネージド状態が保持されます。
az iot adr ns su instance create --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--location]
[--mi-sa --system-assigned-mi {false, true}]
[--mi-ua --user-assigned-mi]
[--no-wait]
[--tags]
例
システム割り当て ID を使用してインスタンスを作成する
az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup --location eastus2 --system-assigned-mi
システム割り当て ID とユーザー割り当て ID を使用してインスタンスを作成する
az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup \
--system-assigned-mi --user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<identity>
既存のインスタンス ID をユーザー割り当て専用構成に置き換える
az iot adr ns su instance create -n myUpdateInstance -g myResourceGroup \
--user-assigned-mi /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<identity>
必須パラメーター
Update インスタンスの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
Location. 値のソース: az account list-locations
az configure --defaults location=<location> を使用して、既定の場所を構成できます。
システム割り当てマネージド ID を含めるか削除します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
必要なユーザー割り当てマネージド ID リソース ID のセットを完了します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot adr ns su instance delete
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
Update インスタンスを削除します。
az iot adr ns su instance delete --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--no-wait]
[--yes {false, true}]
例
メッセージを表示せずに削除する
az iot adr ns su instance delete -n myUpdateInstance -g myResourceGroup --yes
必須パラメーター
Update インスタンスの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot adr ns su instance list
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
更新インスタンスを一覧表示します。
az iot adr ns su instance list [--resource-group]
例
リソース グループ内のインスタンスを一覧表示する
az iot adr ns su instance list -g myResourceGroup
サブスクリプション内のインスタンスを一覧表示する
az iot adr ns su instance list
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot adr ns su instance show
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
Update インスタンスを表示します。
az iot adr ns su instance show --name
--resource-group
例
インスタンスを表示する
az iot adr ns su instance show -n myUpdateInstance -g myResourceGroup
必須パラメーター
Update インスタンスの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot adr ns su instance update
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
Update Instance のタグまたはマネージド ID を更新します。
ID オプションは、指定された場合の完全な目的の ID 状態を示します。--system-assigned-mi コントロールは SAMI を制御し、--user-assigned-mi は UAMI セットを提供します。 既存の ID を変更せずに残すには、両方の ID オプションを省略します。
az iot adr ns su instance update --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--mi-sa --system-assigned-mi {false, true}]
[--mi-ua --user-assigned-mi]
[--no-wait]
[--tags]
例
タグの更新
az iot adr ns su instance update -n myUpdateInstance -g myResourceGroup --tags environment=test
ID をシステム割り当てに設定する
az iot adr ns su instance update -n myUpdateInstance -g myResourceGroup --system-assigned-mi
必須パラメーター
Update インスタンスの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
システム割り当てマネージド ID を含めるか削除します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
必要なユーザー割り当てマネージド ID リソース ID のセットを完了します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az iot adr ns su instance wait
コマンド グループ 'iot adr ns su instance' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
インスタンスの更新条件を待ちます。
明示的な待機述語がない場合は、provisioningState Succeeded を待機します。
az iot adr ns su instance wait --name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
例
プロビジョニングが成功するまで待つ
az iot adr ns su instance wait -n myUpdateInstance -g myResourceGroup
必須パラメーター
Update インスタンスの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
このリソース操作のAzure Policy トークンを自動的に取得します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
このリソース操作の関連する変更参照 ID。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Global Policy Arguments |
provisioningState が成功するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
カスタム JMESPath 式が true に評価されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
リソースが削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
GET 時間を含む、ポーリングの予算 (秒単位)。 インフライト GET はトランスポート タイムアウトによって制限され、このポーリング期限までに中断することはできません。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が成功するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |