Share via

az guestconfig guest-configuration-assignment

  • 実験用
  • リファレンス

Note

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

このコマンド グループは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Guestconfig guest-configuration-assignment。

コマンド

名前 説明 型 Status
az guestconfig guest-configuration-assignment create

VM とゲスト構成の間の関連付けを作成します。

 拡張 Experimental
az guestconfig guest-configuration-assignment delete

ゲスト構成の割り当てを削除します。

 拡張 Experimental
az guestconfig guest-configuration-assignment list

仮想マシンのすべてのゲスト構成の割り当てを一覧表示します。

 拡張 Experimental
az guestconfig guest-configuration-assignment show

ゲスト構成の割り当てに関する情報を取得します。

 拡張 Experimental
az guestconfig guest-configuration-assignment update

VM とゲスト構成の間の関連付けを作成します。

 拡張 Experimental
az guestconfig guest-configuration-assignment wait

guestconfig guest-configuration-assignment の条件が満たされるまで、CLI を待機状態にします。

 拡張 Experimental

az guestconfig guest-configuration-assignment create

実験用

コマンド グループ 'guestconfig guest-configuration-assignment' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VM とゲスト構成の間の関連付けを作成します。

az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name
                                                     --resource-group
                                                     --vm-name
                                                     [--context]
                                                     [--guest-configuration-configuration-parameter]
                                                     [--guest-configuration-configuration-setting]
                                                     [--guest-configuration-name]
                                                     [--guest-configuration-version]
                                                     [--latest-assignment-report-assignment]
                                                     [--location]
                                                     [--name]
                                                     [--no-wait]

例

ゲスト構成の割り当てを作成または更新する

az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"

必須のパラメーター

--guest-configuration-assignment-name

ゲスト構成割り当ての名前。

--resource-group -g

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

--vm-name

仮想マシンの名前。

省略可能のパラメーター

--context

ゲスト構成の割り当てを開始したソース。 例: Azure Policy。

--guest-configuration-configuration-parameter

ゲスト構成の構成パラメーター。

使用法: --guest-configuration-configuration-parameter name=XX value=XX

name: 構成パラメーターの名前。 value: 構成パラメーターの値。

複数の --guest-configuration-configuration-parameter 引数を使用して、複数のアクションを指定できます。

--guest-configuration-configuration-setting

ゲスト構成の構成設定。

使用法: --guest-configuration-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-mins=XX reboot-if-needed=XX configuration-mode-frequency-mins=XX

configuration-mode: LCM(Local Configuration Manager) が実際にターゲット ノードに構成を適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。 allow-module-overwrite: true の場合、プル サービスからダウンロードされた新しい構成は、ターゲット ノード上の古い構成を上書きできます。 それ以外の場合、false action-after-reboot: 構成の適用中に再起動後に何が起こるかを指定します。 指定できる値は ContinueConfiguration と StopConfiguration refresh-frequency-minutes です。LCM がプル サービスをチェックして更新された構成を取得する時間間隔 (分単位)。 この値は、LCM がプル モードで構成されていない場合は無視されます。 既定値は 30 です。 reboot-if-needed: 再起動が必要な構成が適用された後にノードを自動的に再起動するには、これを true に設定します。 設定しない場合は、再起動が必要な構成のノードを手動で再起動する必要があります。 既定値は false です。 DSC 以外 (Windows インストーラーなど) で再起動の条件が有効化されている場合にこの設定を使用するには、この設定を xPendingReboot モジュールと併用します。 configuration-mode-frequency-minutes: 現在の構成がチェックされ、適用される頻度 (分単位)。 ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。 既定値は 15 です。

--guest-configuration-name

ゲスト構成の名前。

--guest-configuration-version

ゲスト構成のバージョン。

--latest-assignment-report-assignment

ゲスト構成割り当ての構成の詳細。 予期される値: json-string/@json-file。

--location -l

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

--name

ゲスト構成割り当ての名前。

--no-wait

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

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

az guestconfig guest-configuration-assignment delete

実験用

コマンド グループ 'guestconfig guest-configuration-assignment' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ゲスト構成の割り当てを削除します。

az guestconfig guest-configuration-assignment delete [--ids]
                                                     [--name]
                                                     [--no-wait]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--vm-name]

例

ゲスト構成の割り当てを削除する

az guestconfig guest-configuration-assignment delete --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

ゲスト構成割り当ての名前。

--no-wait

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

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

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

--subscription

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

--vm-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 guestconfig guest-configuration-assignment list

実験用

コマンド グループ 'guestconfig guest-configuration-assignment' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

仮想マシンのすべてのゲスト構成の割り当てを一覧表示します。

az guestconfig guest-configuration-assignment list --resource-group
                                                   --vm-name

例

仮想マシンのすべてのゲスト構成の割り当てを一覧表示する

az guestconfig guest-configuration-assignment list --resource-group "myResourceGroupName" --vm-name "myVMName"

必須のパラメーター

--resource-group -g

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

--vm-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 guestconfig guest-configuration-assignment show

実験用

コマンド グループ 'guestconfig guest-configuration-assignment' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

ゲスト構成の割り当てに関する情報を取得します。

az guestconfig guest-configuration-assignment show [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--vm-name]

例

ゲスト構成の割り当てを取得する

az guestconfig guest-configuration-assignment show --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

ゲスト構成の割り当て名。

--resource-group -g

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

--subscription

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

--vm-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 guestconfig guest-configuration-assignment update

実験用

コマンド グループ 'guestconfig guest-configuration-assignment' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

VM とゲスト構成の間の関連付けを作成します。

az guestconfig guest-configuration-assignment update [--context]
                                                     [--guest-configuration-assignment-name]
                                                     [--guest-configuration-configuration-parameter]
                                                     [--guest-configuration-configuration-setting]
                                                     [--guest-configuration-name]
                                                     [--guest-configuration-version]
                                                     [--ids]
                                                     [--latest-assignment-report-assignment]
                                                     [--location]
                                                     [--name]
                                                     [--no-wait]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--vm-name]

例

ゲスト構成の割り当てを作成または更新する

az guestconfig guest-configuration-assignment update --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"

省略可能のパラメーター

--context

ゲスト構成の割り当てを開始したソース。 例: Azure Policy。

--guest-configuration-assignment-name

ゲスト構成割り当ての名前。

--guest-configuration-configuration-parameter

ゲスト構成の構成パラメーター。

使用法: --guest-configuration-configuration-parameter name=XX value=XX

name: 構成パラメーターの名前。 value: 構成パラメーターの値。

複数の --guest-configuration-configuration-parameter 引数を使用して、複数のアクションを指定できます。

--guest-configuration-configuration-setting

ゲスト構成の構成設定。

使用法: --guest-configuration-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-mins=XX reboot-if-needed=XX configuration-mode-frequency-mins=XX

configuration-mode: LCM(Local Configuration Manager) が実際にターゲット ノードに構成を適用する方法を指定します。 使用可能な値は、ApplyOnly、ApplyAndMonitor、および ApplyAndAutoCorrect です。 allow-module-overwrite: true の場合、プル サービスからダウンロードされた新しい構成は、ターゲット ノード上の古い構成を上書きできます。 それ以外の場合、false action-after-reboot: 構成の適用中に再起動後に何が起こるかを指定します。 指定できる値は ContinueConfiguration と StopConfiguration refresh-frequency-minutes です。LCM がプル サービスをチェックして更新された構成を取得する時間間隔 (分単位)。 この値は、LCM がプル モードで構成されていない場合は無視されます。 既定値は 30 です。 reboot-if-needed: 再起動が必要な構成が適用された後にノードを自動的に再起動するには、これを true に設定します。 設定しない場合は、再起動が必要な構成のノードを手動で再起動する必要があります。 既定値は false です。 DSC 以外 (Windows インストーラーなど) で再起動の条件が有効化されている場合にこの設定を使用するには、この設定を xPendingReboot モジュールと併用します。 configuration-mode-frequency-minutes: 現在の構成がチェックされ、適用される頻度 (分単位)。 ConfigurationMode プロパティが ApplyOnly に設定されている場合、このプロパティは無視されます。 既定値は 15 です。

--guest-configuration-name

ゲスト構成の名前。

--guest-configuration-version

ゲスト構成のバージョン。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--latest-assignment-report-assignment

ゲスト構成割り当ての構成の詳細。 予期される値: json-string/@json-file。

--location -l

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

--name

ゲスト構成割り当ての名前。

--no-wait

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

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

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

--subscription

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

--vm-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 guestconfig guest-configuration-assignment wait

実験用

コマンド グループ 'guestconfig guest-configuration-assignment' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

guestconfig guest-configuration-assignment の条件が満たされるまで、CLI を待機状態にします。

az guestconfig guest-configuration-assignment wait [--created]
                                                   [--custom]
                                                   [--deleted]
                                                   [--exists]
                                                   [--ids]
                                                   [--interval]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--timeout]
                                                   [--updated]
                                                   [--vm-name]

例

guestconfig guest-configuration-assignment が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --created

guestconfig guest-configuration-assignment が正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --deleted

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--exists

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

既定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

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

既定値: 30
--name -n

ゲスト構成の割り当て名。

--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600
--updated

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

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