次の方法で共有

az vmss extension

  • リファレンス

VM スケール セットで拡張機能を管理します。

コマンド

名前 説明 型 状態
az vmss extension delete

VMSS から拡張機能を削除します。

 コア GA
az vmss extension image

サブスクリプションとリージョンで使用可能な VM 拡張機能を見つけます。

 コア GA
az vmss extension image list

使用可能な拡張機能に関する情報を一覧表示します。

 コア GA
az vmss extension image list-names

仮想マシン拡張機能イメージの種類を一覧表示します。

 コア GA
az vmss extension image list-versions

仮想マシン拡張機能イメージのバージョンを一覧表示します。

 コア GA
az vmss extension image show

仮想マシン拡張機能イメージを取得します。

 コア GA
az vmss extension list

VMSS に関連付けられている拡張機能を一覧表示します。

 コア GA
az vmss extension set

VMSS に拡張機能を追加するか、既存の拡張機能を更新します。

 コア GA
az vmss extension show

VMSS 拡張機能の詳細を表示します。

 コア GA
az vmss extension upgrade

すべての VMSS インスタンスのすべての拡張機能を最新バージョンにアップグレードします。

 コア GA

az vmss extension delete

編集

VMSS から拡張機能を削除します。

az vmss extension delete --name
                         --resource-group
                         --vmss-name
                         [--no-wait]

例

VMSS から拡張機能を削除します。 (自動生成)

az vmss extension delete --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss

必須のパラメーター

--name -n

拡張機能の名前。

--resource-group -g

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

--vmss-name

スケール セット名。 を使用して az configure --defaults vmss=<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 vmss extension list

編集

VMSS に関連付けられている拡張機能を一覧表示します。

az vmss extension list --resource-group
                       --vmss-name

例

VMSS に関連付けられている拡張機能を一覧表示します。 (自動生成)

az vmss extension list --resource-group MyResourceGroup --vmss-name MyVmss

必須のパラメーター

--resource-group -g

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

--vmss-name

スケール セット名。 を使用して az configure --defaults vmss=<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 vmss extension set

編集

VMSS に拡張機能を追加するか、既存の拡張機能を更新します。

から拡張機能の詳細を az vmss extension image list取得します。

az vmss extension set --name
                      --publisher
                      --resource-group
                      --vmss-name
                      [--enable-auto-upgrade {false, true}]
                      [--extension-instance-name]
                      [--force-update]
                      [--no-auto-upgrade {false, true}]
                      [--no-auto-upgrade-minor-version {false, true}]
                      [--no-wait]
                      [--protected-settings]
                      [--provision-after-extensions]
                      [--settings]
                      [--version]

例

以前に設定した 2 つの拡張機能に依存する拡張機能を設定します。 つまり、VMSS インスタンスが作成または再イメージ化されると、カスタムScript 拡張機能は、依存するすべての拡張機能がプロビジョニングされた後にのみプロビジョニングされます。 この拡張機能は、前提条件の構成の他の拡張機能に依存する必要はありません。

az vmss extension set --vmss-name my-vmss --name customScript --resource-group my-group \
    --version 2.0 --publisher Microsoft.Azure.Extensions \
    --provision-after-extensions NetworkWatcherAgentLinux VMAccessForLinux  \
    --settings '{"commandToExecute": "echo testing"}'

新しいバージョンの拡張機能が使用可能な場合は、拡張機能を追加し、プラットフォームによる自動アップグレードを有効にします。

az vmss extension set -n extName --publisher publisher --vmss-name my-vmss -g my-group \ --enable-auto-upgrade true

必須のパラメーター

--name -n

拡張機能の名前。

値の取得元: az vm extension image list
--publisher

拡張機能の発行元の名前。

--resource-group -g

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

--vmss-name

スケール セット名。 を使用して az configure --defaults vmss=<name>既定値を構成できます。

省略可能のパラメーター

--enable-auto-upgrade

使用可能な拡張機能の新しいバージョンがある場合は、プラットフォームによって拡張機能を自動的にアップグレードする必要があることを示します。

指定可能な値: false, true
--extension-instance-name

カスタマイズ可能な拡張インスタンスの名前。 既定値: 拡張機能の名前。

--force-update

拡張機能の構成が変更されていない場合でも、強制的に更新します。

規定値: False
--no-auto-upgrade
非推奨

オプション '--no-auto-upgrade' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--no-auto-upgrade-minor-version' を使用してください。

設定した場合、拡張機能が再デプロイされた場合でも、拡張機能サービスは自動的に最新のマイナー バージョンを選択またはアップグレードしません。

指定可能な値: false, true
規定値: False
--no-auto-upgrade-minor-version

設定した場合、拡張機能が再デプロイされた場合でも、拡張機能サービスは自動的に最新のマイナー バージョンを選択またはアップグレードしません。

指定可能な値: false, true
規定値: False
--no-wait

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

規定値: False
--protected-settings

資格情報などの機密情報の保護された設定 (JSON 形式)。 JSON ファイル パスも受け入れられます。

--provision-after-extensions

この拡張機能をプロビジョニングする必要がある拡張機能名のスペース区切りの一覧。 これらの拡張機能は、VM に既に設定されている必要があります。

--settings

JSON 形式の拡張機能の設定。 JSON ファイル パスも受け入れられます。

--version

拡張機能のバージョン。 拡張機能のバージョンをこの値にピン留めするには、--no-auto-upgrade-minor-version を指定してください。

グローバル パラメーター
--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 vmss extension show

編集

VMSS 拡張機能の詳細を表示します。

az vmss extension show --name
                       --resource-group
                       --vmss-name

例

VMSS 拡張機能の詳細を表示します。 (自動生成)

az vmss extension show --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss

必須のパラメーター

--name -n

拡張機能の名前。

--resource-group -g

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

--vmss-name

スケール セット名。 を使用して az configure --defaults vmss=<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 vmss extension upgrade

編集

すべての VMSS インスタンスのすべての拡張機能を最新バージョンにアップグレードします。

az vmss extension upgrade [--ids]
                          [--name]
                          [--no-wait]
                          [--resource-group]
                          [--subscription]

例

すべての拡張機能を最新バージョンにアップグレードします。

az vmss extension upgrade -g MyResourceGroup -n MyVmss

省略可能のパラメーター

--ids

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

--name -n

スケール セット名。 を使用して az configure --defaults vmss=<name>既定値を構成できます。

--no-wait

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

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

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

--subscription

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

グローバル パラメーター
--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 を使います。