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

必須パラメーター

--name -n

Update インスタンスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
グローバル パラメーター
--debug

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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 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>

必須パラメーター

--name -n

Update インスタンスの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--mi-sa --system-assigned-mi

システム割り当てマネージド ID を含めるか削除します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。

プロパティ 値
指定可能な値: false, true
--mi-ua --user-assigned-mi

必要なユーザー割り当てマネージド ID リソース ID のセットを完了します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。

--no-wait

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

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

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

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

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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 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

必須パラメーター

--name -n

Update インスタンスの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--no-wait

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

プロパティ 値
規定値: False
--yes -y

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

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

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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 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 つ以上が必要になる場合があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

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

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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 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

必須パラメーター

--name -n

Update インスタンスの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

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

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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 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

必須パラメーター

--name -n

Update インスタンスの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--mi-sa --system-assigned-mi

システム割り当てマネージド ID を含めるか削除します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。

プロパティ 値
指定可能な値: false, true
--mi-ua --user-assigned-mi

必要なユーザー割り当てマネージド ID リソース ID のセットを完了します。 作成または更新時に、すべてのマネージド ID オプションを省略すると、既存の ID が保持されます。

--no-wait

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

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

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

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

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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 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

必須パラメーター

--name -n

Update インスタンスの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--created

provisioningState が成功するまで待ちます。

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

カスタム JMESPath 式が true に評価されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

リソースが削除されるまで待ちます。

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

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

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

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

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--timeout

GET 時間を含む、ポーリングの予算 (秒単位)。 インフライト GET はトランスポート タイムアウトによって制限され、このポーリング期限までに中断することはできません。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

provisioningState が成功するまで待ちます。

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

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

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

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

--only-show-errors

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

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

出力フォーマット。

プロパティ 値
規定値: 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