az vmss

Azure Virtual Machine Scale Set (VMSS) 内の仮想マシンのグループ化を管理します。

コマンド

名前	説明	型	状態
az vmss application	VM スケール セットのアプリケーションを管理します。	コア	GA
az vmss application list	VMSS のアプリケーションを一覧表示します。	コア	GA
az vmss application set	VMSS のアプリケーションを設定します。	コア	GA
az vmss create	Azure 仮想マシン スケール セットを作成します。	コア	GA
az vmss deallocate	VMSS 内の VM の割り当てを解除します。	コア	GA
az vmss delete	VM スケール セットを削除します。	コア	GA
az vmss delete-instances	VMSS 内の VM を削除します。	コア	GA
az vmss diagnostics	Azure 仮想マシン スケール セット診断拡張機能を構成します。	コア	GA
az vmss diagnostics get-default-config	収集するデータを定義する既定の構成ファイルを表示します。	コア	GA
az vmss diagnostics set	VMSS で診断を有効にします。	コア	GA
az vmss disk	VMSS のデータ ディスクを管理します。	コア	GA
az vmss disk attach	マネージド データ ディスクをスケール セットまたはそのインスタンスにアタッチします。	コア	GA
az vmss disk detach	スケール セットまたはそのインスタンスからマネージド データ ディスクをデタッチします。	コア	GA
az vmss encryption	VMSS の暗号化を管理します。	コア	GA
az vmss encryption disable	マネージド ディスクを使用する VMSS での暗号化を無効にします。	コア	GA
az vmss encryption enable	マネージド ディスクを使用して VMSS を暗号化します。	コア	GA
az vmss encryption show	暗号化の状態を表示します。	コア	GA
az vmss extension	VM スケール セットで拡張機能を管理します。	コア	GA
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 get-instance-view	VMSS のインスタンスを表示します。	コア	GA
az vmss get-os-upgrade-history	VM スケール セット インスタンスの OS アップグレードを一覧表示します。	コア	GA
az vmss identity	VM スケールセットのサービス ID を管理します。	コア	GA
az vmss identity assign	VMSS でマネージド サービス ID を有効にします。	コア	GA
az vmss identity remove	VM スケールセットからユーザー割り当て ID を削除します。	コア	プレビュー
az vmss identity show	VM スケールセットのマネージド ID 情報を表示します。	コア	GA
az vmss list	リソース グループのすべての VM スケール セットを一覧表示します。	コア	GA
az vmss list-instance-connection-info	セット内の個々の VM インスタンスに接続するために使用される IP アドレスとポート番号を取得します。	コア	GA
az vmss list-instance-public-ips	セット内の VM インスタンスのパブリック IP アドレスを一覧表示します。	コア	GA
az vmss list-instances	VM スケール セット内のすべての仮想マシンを一覧表示します。	コア	GA
az vmss list-skus	VM スケール セットで使用可能な SKU (各 SKU で許可される最小および最大 VM インスタンスを含む) を一覧表示します。	コア	GA
az vmss nic	VMSS のネットワーク インターフェイスを管理します。	コア	GA
az vmss nic list	仮想マシン スケール セット内のすべてのネットワーク インターフェイスを取得します。	コア	GA
az vmss nic list-vm-nics	仮想マシン スケール セット内の仮想マシン内のすべてのネットワーク インターフェイスに関する情報を取得します。	コア	GA
az vmss nic show	仮想マシン スケール セット内の指定されたネットワーク インターフェイスを取得します。	コア	GA
az vmss perform-maintenance	VM スケール セット内の 1 つ以上の仮想マシンに対してメンテナンスを実行します。 メンテナンスを実行できないインスタンスに対する操作は失敗します。 詳細については、ベスト プラクティス( https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications)を参照してください。	コア	GA
az vmss reimage	VMSS 内の VM を再イメージ化します。	コア	GA
az vmss restart	VMSS 内の VM を再起動します。	コア	GA
az vmss rolling-upgrade	ローリング アップグレードを管理します。	コア	GA
az vmss rolling-upgrade cancel	現在の仮想マシン スケール セットのローリング アップグレードをキャンセルします。	コア	GA
az vmss rolling-upgrade get-latest	最新の仮想マシン スケール セットのローリング アップグレードの状態を取得します。	コア	GA
az vmss rolling-upgrade start	ローリング アップグレードを開始して、すべての仮想マシン スケール セット インスタンスを利用可能な最新のプラットフォーム イメージ OS バージョンに移動します。 使用可能な最新の OS バージョンを既に実行しているインスタンスは影響を受けません。	コア	GA
az vmss run-command	仮想マシン スケール セットで実行コマンドを管理します。	コア	GA
az vmss run-command create	VMSS VM 実行コマンドを作成する操作。	コア	GA
az vmss run-command delete	実行コマンドを削除する操作。	コア	GA
az vmss run-command invoke	仮想マシン スケール セット インスタンスで特定の実行コマンドを実行します。	コア	GA
az vmss run-command list	仮想マシン スケールセット内のインスタンスのすべての実行コマンドを取得する操作。	コア	GA
az vmss run-command show	VMSS 実行コマンドを取得する操作。	コア	GA
az vmss run-command update	VMSS 実行コマンドを更新する操作。	コア	GA
az vmss scale	VMSS 内の VM の数を変更します。	コア	GA
az vmss set-orchestration-service-state	VMSS 内の特定のサービスの ServiceState プロパティを変更します。	コア	GA
az vmss show	VMSS 内の VM の詳細を取得します。	コア	GA
az vmss simulate-eviction	VM スケール セット内のスポット仮想マシンの削除をシミュレートします。	コア	GA
az vmss start	VMSS 内の VM を起動します。	コア	GA
az vmss stop	VMSS 内の VM の電源をオフ (停止) します。	コア	GA
az vmss update	VMSS を更新します。 アップグレード ポリシーを構成していない場合は、'az vmss update-instances' コマンドを実行して VM への変更をロールアウトします。	コア	GA
az vmss update-domain-walk	Service Fabric 仮想マシン スケール セット内の仮想マシンを更新するための手動プラットフォーム更新ドメインウォーク。	コア	GA
az vmss update-instances	VMSS 内の VM をアップグレードします。	コア	GA
az vmss wait	スケール セットの条件が満たされるまで、CLI を待機状態にします。	コア	GA

az vmss create

Azure 仮想マシン スケール セットを作成します。

エンド ツー エンドのチュートリアルについては、 https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-linux-create-cliを参照してください。

az vmss create --name
               --resource-group
               [--accelerated-networking {false, true}]
               [--accept-term]
               [--additional-events {false, true}]
               [--admin-password]
               [--admin-username]
               [--app-gateway]
               [--app-gateway-capacity]
               [--app-gateway-sku]
               [--app-gateway-subnet-address-prefix]
               [--asgs]
               [--assign-identity]
               [--authentication-type {all, password, ssh}]
               [--automatic-repairs-action {Reimage, Replace, Restart}]
               [--automatic-repairs-grace-period]
               [--backend-pool-name]
               [--backend-port]
               [--capacity-reservation-group]
               [--computer-name-prefix]
               [--custom-data]
               [--data-disk-caching]
               [--data-disk-delete-option {Delete, Detach}]
               [--data-disk-encryption-sets]
               [--data-disk-iops]
               [--data-disk-mbps]
               [--data-disk-sizes-gb]
               [--disable-integrity-monitoring-autoupgrade]
               [--disable-overprovision]
               [--disk-controller-type {NVMe, SCSI}]
               [--dns-servers]
               [--edge-zone]
               [--enable-agent {false, true}]
               [--enable-auto-os-upgrade {false, true}]
               [--enable-auto-update {false, true}]
               [--enable-cross-zone-upgrade {false, true}]
               [--enable-hibernation {false, true}]
               [--enable-integrity-monitoring]
               [--enable-osimage-notification {false, true}]
               [--enable-proxy-agent {false, true}]
               [--enable-reboot {false, true}]
               [--enable-redeploy {false, true}]
               [--enable-resilient-creation {false, true}]
               [--enable-resilient-deletion {false, true}]
               [--enable-secure-boot {false, true}]
               [--enable-spot-restore {false, true}]
               [--enable-vtpm {false, true}]
               [--encryption-at-host {false, true}]
               [--ephemeral-os-disk {false, true}]
               [--ephemeral-os-disk-placement {CacheDisk, NvmeDisk, ResourceDisk}]
               [--eviction-policy {Deallocate, Delete}]
               [--exclude-extensions]
               [--generate-ssh-keys]
               [--health-probe]
               [--host-group]
               [--image]
               [--instance-count]
               [--lb]
               [--lb-nat-rule-name]
               [--lb-sku {Basic, Gateway, Standard}]
               [--license-type {None, RHEL_BASE, RHEL_BASESAPAPPS, RHEL_BASESAPHA, RHEL_BYOS, RHEL_ELS_6, RHEL_EUS, RHEL_SAPAPPS, RHEL_SAPHA, SLES, SLES_BYOS, SLES_HPC, SLES_SAP, SLES_STANDARD, UBUNTU, UBUNTU_PRO, Windows_Client, Windows_Server}]
               [--location]
               [--max-batch-instance-percent]
               [--max-price]
               [--max-surge {false, true}]
               [--max-unhealthy-instance-percent]
               [--max-unhealthy-upgraded-instance-percent]
               [--network-api-version]
               [--no-wait]
               [--nsg]
               [--orchestration-mode {Flexible, Uniform}]
               [--os-disk-caching {None, ReadOnly, ReadWrite}]
               [--os-disk-delete-option {Delete, Detach}]
               [--os-disk-encryption-set]
               [--os-disk-name]
               [--os-disk-secure-vm-disk-encryption-set]
               [--os-disk-security-encryption-type {DiskWithVMGuestState, NonPersistedTPM, VMGuestStateOnly}]
               [--os-disk-size-gb]
               [--os-type {linux, windows}]
               [--patch-mode {AutomaticByOS, AutomaticByPlatform, ImageDefault, Manual}]
               [--pause-time-between-batches]
               [--plan-name]
               [--plan-product]
               [--plan-promotion-code]
               [--plan-publisher]
               [--platform-fault-domain-count]
               [--ppg]
               [--prioritize-unhealthy-instances {false, true}]
               [--priority {Low, Regular, Spot}]
               [--proxy-agent-mode {Audit, Enforce}]
               [--public-ip-address]
               [--public-ip-address-allocation {dynamic, static}]
               [--public-ip-address-dns-name]
               [--public-ip-per-vm]
               [--regular-priority-count]
               [--regular-priority-percentage]
               [--role]
               [--scale-in-policy {Default, NewestVM, OldestVM}]
               [--scope]
               [--secrets]
               [--security-posture-id]
               [--security-type {ConfidentialVM, Standard, TrustedLaunch}]
               [--single-placement-group {false, true}]
               [--specialized {false, true}]
               [--spot-restore-timeout]
               [--ssh-dest-key-path]
               [--ssh-key-values]
               [--storage-container-name]
               [--storage-sku]
               [--subnet]
               [--subnet-address-prefix]
               [--tags]
               [--terminate-notification-time]
               [--ultra-ssd-enabled {false, true}]
               [--upgrade-policy-mode {Automatic, Manual, Rolling}]
               [--use-unmanaged-disk]
               [--user-data]
               [--v-cpus-available]
               [--v-cpus-per-core]
               [--validate]
               [--vm-domain-name]
               [--vm-sku]
               [--vnet-address-prefix]
               [--vnet-name]
               [--zones]

例

5 つのインスタンス、ロード バランサー、パブリック IP アドレス、2 GB データ ディスク、40 GB OS ディスクを含む Windows VM スケール セットを作成します。

az vmss create -n MyVmss -g MyResourceGroup --instance-count 5 --image Win2016Datacenter --data-disk-sizes-gb 2 --os-disk-size-gb 40

自動生成された SSH キー ペア、パブリック IP アドレス、DNS エントリ、既存のロード バランサー、および既存の仮想ネットワークを使用して Linux VM スケール セットを作成します。

az vmss create -n MyVmss -g MyResourceGroup --public-ip-address-dns-name my-globally-dns-name \
    --load-balancer MyLoadBalancer --vnet-name MyVnet --subnet MySubnet --image Ubuntu2204 \
    --generate-ssh-keys

既定の既存の公開 SSH キーを使用して、カスタム イメージから Linux VM スケール セットを作成します。

az vmss create -n MyVmss -g MyResourceGroup --image MyImage

ロード バランサーとカスタム DNS サーバーを使用して Linux VM スケール セットを作成します。 各 VM には、パブリック IP アドレスとカスタム ドメイン名があります。

az vmss create -n MyVmss -g MyResourceGroup --image CentOS85Gen2 \
    --public-ip-per-vm --vm-domain-name myvmss --dns-servers 10.0.0.6 10.0.0.5

構成用の cloud-init スクリプトを使用して Linux VM スケール セットを作成します。 https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init を参照

az vmss create -g MyResourceGroup -n MyVmss --image Debian11 --custom-data MyCloudInitScript.yml

一般化されたギャラリー イメージ バージョンから VMSS を作成します。

az vmss create -g MyResourceGroup -n MyVmss --image /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Compute/galleries/myGallery/images/myImage/versions/1.0.0

特殊なギャラリー イメージ バージョンから VMSS を作成します。

az vmss create -g MyResourceGroup -n MyVmss --image /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Compute/galleries/myGallery/images/myImage/versions/1.0.0 --specialized

最新バージョンのギャラリー イメージから VMSS を作成する

az vmss create -g MyResourceGroup -n MyVmss --image /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Compute/galleries/myGallery/images/myImage

Key Vault シークレットを使用して Debian11 VM スケールセットを作成します。

az keyvault certificate create --vault-name vaultname -n cert1 \
  -p "$(az keyvault certificate get-default-policy)"

secrets=$(az keyvault secret list-versions --vault-name vaultname \
  -n cert1 --query "[?attributes.enabled].id" -o tsv)

vm_secrets=$(az vm secret format -s "$secrets")

az vmss create -g group-name -n vm-name --admin-username deploy  \
  --image Debian11 --secrets "$vm_secrets"

システム割り当て ID を使用して VM スケールセットを作成します。 VM には、ストレージ アカウントへのアクセス権を持つ "共同作成者" ロールがあります。

az vmss create -n MyVmss -g MyResourceGroup --image CentOS85Gen2 --assign-identity --scope /subscriptions/99999999-1bf0-4dda-aec3-cb9272f09590/MyResourceGroup/myRG/providers/Microsoft.Storage/storageAccounts/storage1 --role Contributor

ユーザー割り当て ID を使用して Debian11 VM スケールセットを作成します。

az vmss create -n MyVmss -g rg1 --image Debian11 --assign-identity  /subscriptions/99999999-1bf0-4dda-aec3-cb9272f09590/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID

システム割り当て ID とユーザー割り当て ID の両方を使用して Debian11 VM スケールセットを作成します。

az vmss create -n MyVmss -g rg1 --image Debian11 --assign-identity  [system] /subscriptions/99999999-1bf0-4dda-aec3-cb9272f09590/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID

現在のリソース グループのリージョンに単一ゾーンの VM スケールセットを作成する

az vmss create -n MyVmss -g MyResourceGroup --image CentOS85Gen2 --zones 1

SpotRestore をサポートする VMSS を作成します。

az vmss create -n MyVmss -g MyResourceGroup  --location NorthEurope --instance-count 2 --image CentOS85Gen2 --priority Spot --eviction-policy Deallocate --single-placement-group --enable-spot-restore True --spot-restore-timeout PT1H

共有ギャラリー イメージから VMSS を作成します。

az vmss create -n MyVmss -g MyResourceGroup --image /SharedGalleries/{gallery_unique_name}/Images/{image}/Versions/{version}

コミュニティ ギャラリー イメージから VMSS を作成します。

az vmss create -n MyVmss -g MyResourceGroup --image /CommunityGalleries/{gallery_unique_name}/Images/{image}/Versions/{version}

パッチ モード 'Manual' を使用して Windows VMSS を作成します (現在、VMSS の作成時にパッチ モード 'AutomaticByPlatform' はサポートされていません。これは、VMSS の作成時に 'AutomaticByPlatform' モードに必要な正常性拡張機能を設定できないためです)。

az vmss create -n MyVmss -g MyResourceGroup --image Win2019Datacenter --enable-agent --enable-auto-update false --patch-mode Manual --orchestration-mode Flexible

スケール セット内のすべての仮想マシンに使用するセキュリティ体制を指定して VMSS を作成します。

az vmss create -n MyVmss -g MyResourceGroup --image /CommunityGalleries/{gallery_unique_name}/Images/{image}/Versions/{version} --security-posture-reference-id /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{version} \
    --security-posture-reference-exclude-extensions "c:\tmp\exclude_extensions.json"

必須のパラメーター

--name -n

仮想マシン スケール セットの名前。

--resource-group -g

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

省略可能のパラメーター

--accelerated-networking

高速ネットワークを有効にします。 指定しない限り、CLI はマシンイメージとサイズに基づいて有効にします。

指定可能な値: false, true

--accept-term

使用許諾契約書とプライバシーに関する声明に同意します。

--additional-events --additional-scheduled-events --scheduled-event-additional-publishing-target-event-grid-and-resource-graph

イベント グリッドとリソース グラフのスケジュールされたイベント設定の作成時に使用される構成パラメーター。

指定可能な値: false, true

--admin-password

認証の種類が "パスワード" の場合の VM のパスワード。

--admin-username

VM のユーザー名。 既定値は、OS の現在のユーザー名です。 既定値がシステム予約済みの場合、既定値は azureuser に設定されます。 予約値の完全な一覧を取得するには、 https://docs.microsoft.com/rest/api/compute/virtualmachines/createorupdate#osprofile を参照してください。

--app-gateway

新しいアプリケーション ゲートウェイ (既定) を作成するとき、または既存のゲートウェイを参照するときに使用する名前。 ID で既存のアプリケーション ゲートウェイを参照したり、"" を指定したりすることもできます。

--app-gateway-capacity

新しいアプリケーション ゲートウェイを作成するときに使用するインスタンスの数。

規定値: 10

--app-gateway-sku

新しいアプリケーション ゲートウェイを作成するときの SKU。

規定値: Standard_Large

--app-gateway-subnet-address-prefix

CIDR 形式で新しいアプリケーション ゲートウェイを作成するときに使用するサブネット IP アドレス プレフィックス。

--asgs

VM に関連付ける既存のアプリケーション セキュリティ グループのスペース区切りの一覧。

--assign-identity

スペースで区切られたシステム割り当て ID またはユーザー割り当て ID を受け入れます。 システム割り当て ID を参照するには '[system]' を使用し、ユーザー割り当て ID を参照するにはリソース ID を使用します。 その他の例については、ヘルプを参照してください。

--authentication-type

VM で使用する認証の種類。 Windows の場合はパスワード、Linux の場合は SSH 公開キーが既定値です。 "all" では、ssh 認証とパスワード認証の両方が有効になります。

指定可能な値: all, password, ssh

--automatic-repairs-action

スケール セット内の異常な仮想マシンの修復に使用される修復アクションの種類。

指定可能な値: Reimage, Replace, Restart

--automatic-repairs-grace-period

VM の状態変化により自動修復が中断される時間 (分単位、30 ~ 90)。

--backend-pool-name

新しいロード バランサーまたはアプリケーション ゲートウェイを作成するときにバックエンド プールに使用する名前。

--backend-port

新しいロード バランサーを作成するときに、NAT 規則で開くバックエンド ポート (Linux では既定値は 22、Windows では 3389)。 アプリケーション ゲートウェイを作成するときに、バックエンド HTTP 設定に使用するバックエンド ポート。

--capacity-reservation-group --crg

プレビュー

割り当てに使用される容量予約グループの ID または名前。 容量予約グループの関連付けを解除するには、"None" を渡します。 容量予約グループに関連付けられている VM/VMSS を削除する場合は、まず容量予約グループの関連付けを解除する必要があることに注意してください。

--computer-name-prefix

スケール セット内のすべての仮想マシンのコンピューター名プレフィックス。 コンピューター名のプレフィックスは、1 ~ 15 文字にする必要があります。

--custom-data

カスタム init スクリプト ファイルまたはテキスト (cloud-init、cloud-config など)。

--data-disk-caching

"なし"、"ReadOnly"、"ReadWrite" など、データ ディスクのストレージ キャッシュの種類。単一の値を使用してすべてのディスクに適用するか、 <lun>=<vaule1> <lun>=<value2> を使用して個々のディスクを構成します。

--data-disk-delete-option

VMSS Flex の削除時にデータ ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブル オーケストレーション モードの VMSS 専用です)。

指定可能な値: Delete, Detach

--data-disk-encryption-sets

データ ディスクのディスク暗号化セットの名前または ID (スペース区切り)。

--data-disk-iops

マネージド ディスクの読み取り/書き込み IOPS (スペース区切り) を指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用してください。 指定しない場合は、diskSizeGB に基づいて既定値が割り当てられます。

--data-disk-mbps

マネージド ディスクの帯域幅を MB/秒 (スペース区切り) で指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用してください。 指定しない場合は、diskSizeGB に基づいて既定値が割り当てられます。

--data-disk-sizes-gb

作成する空の空のマネージド データ ディスク サイズ (GB 単位)。

--disable-integrity-monitoring-autoupgrade

トラステッド起動が有効な VM と VMSS のゲスト構成証明拡張機能の自動アップグレードを無効にします。

規定値: False

--disable-overprovision

オーバープロビジョニング オプション (詳細については、 https://azure.microsoft.com/documentation/articles/virtual-machine-scale-sets-overview/ を参照してください)。

--disk-controller-type

プレビュー

VM または VMSS 用に構成されたディスク コントローラーの種類を指定します。

指定可能な値: NVMe, SCSI

--dns-servers

DNS サーバーのスペース区切りの IP アドレス (例: 10.0.0.5 10.0.0.6)。

--edge-zone

エッジ ゾーンの名前。

--enable-agent

仮想マシン エージェントを仮想マシンにプロビジョニングする必要があるかどうかを示します。 このプロパティが指定されていない場合、既定の動作では true に設定されます。 これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。

指定可能な値: false, true

--enable-auto-os-upgrade

新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。

指定可能な値: false, true

--enable-auto-update

Windows 仮想マシンに対して自動更新が有効になっているかどうかを示します。

指定可能な値: false, true

--enable-cross-zone-upgrade

このブール型プロパティを設定すると、VMSS はアップグレード バッチの作成時に AZ 境界を無視でき、バッチ サイズを決定するには Update Domain と maxBatchInstancePercent のみを考慮します。

指定可能な値: false, true

--enable-hibernation

VMSS の休止機能を有効または無効にするフラグ。

指定可能な値: false, true

--enable-integrity-monitoring

セキュリティでサポートされているゲスト構成証明拡張機能ではなく Microsoft のプロパティのインストールを有効にし、信頼された起動が有効な VM と VMSS に対してシステム割り当て ID を有効にします。

規定値: False

--enable-osimage-notification

OS Image Scheduled イベントを有効にするか無効にするかを指定します。

指定可能な値: false, true

--enable-proxy-agent

仮想マシンまたは仮想マシン スケール セットでプロキシ エージェント機能を有効にする必要があるかどうかを指定します。

指定可能な値: false, true

--enable-reboot --enable-user-reboot-scheduled-events

スケジュールされたイベントの追加の発行ターゲットの発行時に使用される構成パラメーター。

指定可能な値: false, true

--enable-redeploy --enable-user-redeploy-scheduled-events

ユーザーが開始したスケジュールされたイベント設定の作成を再デプロイするときに使用される構成パラメーター。

指定可能な値: false, true

--enable-resilient-creation

影響を受ける VM を削除して再作成することで、VM の作成操作中に発生した OS プロビジョニング タイムアウトエラーと VM 開始タイムアウト エラーから顧客を自動的に復旧します。

指定可能な値: false, true

--enable-resilient-deletion

削除操作が失敗した場合に、VM の削除要求を非同期的に再試行します。

指定可能な値: false, true

--enable-secure-boot

セキュア ブートを有効にします。

指定可能な値: false, true

--enable-spot-restore

容量の可用性と価格の制約に基づいて、削除された VMSS SPOT インスタンスを日和見的に復元しようとするスポット復元機能を有効にします。

指定可能な値: false, true

--enable-vtpm

vTPM を有効にします。

指定可能な値: false, true

--encryption-at-host

VM または VMSS のホスト暗号化を有効にします。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。

指定可能な値: false, true

--ephemeral-os-disk

ホスト ノード上に OS ディスクを直接作成できるため、ローカル ディスクのパフォーマンスと VM/VMSS の再イメージ化時間が短縮されます。

指定可能な値: false, true

--ephemeral-os-disk-placement --ephemeral-placement

--ephemeral-os-disk と共に使用された場合にのみ適用されます。 エフェメラル OS ディスクのプロビジョニング場所を選択できます。

指定可能な値: CacheDisk, NvmeDisk, ResourceDisk

--eviction-policy

スポット優先度スケール セット内の仮想マシンの削除ポリシー。 既定の削除ポリシーは、スポット優先度スケール セットに対して割り当て解除されます。

指定可能な値: Deallocate, Delete

--exclude-extensions --security-posture-reference-exclude-extensions

セキュリティ体制を適用するときに除外する仮想マシン拡張機能の一覧。 Json 文字列またはファイル パスを使用できます。 データ形式については、 https://docs.microsoft.com/rest/api/compute/virtualmachinescalesets/get#virtualmachineextension を参照してください。

--generate-ssh-keys

SSH 公開および秘密 RSA キー ファイルが存在しない場合は生成します。 キーは ~/.ssh ディレクトリに格納されます。

規定値: False

--health-probe

既存のロード バランサーからのプローブ名。主にローリング アップグレードまたは自動修復に使用されます。

--host-group

仮想マシン スケール セットが存在する専用ホスト グループの名前または ID。

--image

URN エイリアス、URN、カスタム イメージ名または ID、または VHD BLOB URI としてのオペレーティング システム イメージの名前。 さらに、共有ギャラリー イメージもサポートしています。 使用するディストリビューションのバージョンを含むイメージ エイリアスを使用してください。 例: Debian の代わりに Debian11 を使用してください。' このパラメーターは、有効な URN 形式 --attach-os-disk. "Publisher:Offer:Sku:Version" を使用しない限り必須です。 詳細については、https://docs.microsoft.com/azure/virtual-machines/linux/cli-ps-findimageを参照してください。

値の取得元: az sig image-version show-shared, az vm image list, az vm image show

--instance-count

スケール セット内の VM の数。

規定値: 2

--lb --load-balancer

新しいロード バランサー (既定) を作成するとき、または既存のロード バランサーを参照するときに使用する名前。 ID で既存のロード バランサーを参照したり、"" を指定したりすることもできます。

--lb-nat-rule-name --nat-rule-name

新しいロード バランサーの作成時に NAT 規則 v2 に使用する名前。 (NAT 規則 V2 は NAT プールを置き換えるために使用されます)。

--lb-sku

作成するロード バランサーの SKU。 パブリック IP は、"Standard" の場合にのみエッジ ゾーンに作成することがサポートされています。

指定可能な値: Basic, Gateway, Standard

規定値: Standard

--license-type

Windows イメージまたはディスクのライセンスがオンプレミスにあることを指定します。 Windows Server のAzure ハイブリッド特典を有効にするには、'Windows_Server' を使用します。 Windows 10 のマルチテナント ホスティング権限を有効にするには、'Windows_Client' を使用します。 詳細については、Azure Windows VM のオンライン ドキュメントを参照してください。

指定可能な値: None, RHEL_BASE, RHEL_BASESAPAPPS, RHEL_BASESAPHA, RHEL_BYOS, RHEL_ELS_6, RHEL_EUS, RHEL_SAPAPPS, RHEL_SAPHA, SLES, SLES_BYOS, SLES_HPC, SLES_SAP, SLES_STANDARD, UBUNTU, UBUNTU_PRO, Windows_Client, Windows_Server

--location -l

VM と関連リソースを作成する場所。 既定の場所が構成されていない場合は、リソース グループの場所が既定で設定されます。

--max-batch-instance-percent

1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 既定値: 20%

--max-price

プレビュー

スポット VM/VMSS に対して支払う最大価格 (米ドル)。 -1 は、価格上の理由からスポット VM/VMSS を削除しないことを示します。

--max-surge

プレビュー

既存の仮想マシンを更新するのではなく、スケール セットをアップグレードする新しい仮想マシンを作成するように指定します。

指定可能な値: false, true

--max-unhealthy-instance-percent

同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 既定値: 20%

--max-unhealthy-upgraded-instance-percent

異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 既定値: 20%

--network-api-version

オーケストレーション モードが "フレキシブル" の仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用する Microsoft.Network API バージョンを指定します。 既定値は 2020-11-01 です。

--no-wait

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

規定値: False

--nsg

既存のネットワーク セキュリティ グループの名前または ID。

--orchestration-mode

スケール セットによって仮想マシンを管理する方法を選択します。 Uniform モードでは、仮想マシン モデルを定義します。Azure では、そのモデルに基づいて同じインスタンスが生成されます。 フレキシブル モードでは、任意の構成の仮想マシンを手動で作成してスケール セットに追加するか、スケール セットに対して定義された仮想マシン モデルに基づいて同じインスタンスを生成します。

指定可能な値: Flexible, Uniform

規定値: Flexible

--os-disk-caching

VM OS ディスクのストレージ キャッシュの種類。 既定値: ReadWrite。

指定可能な値: None, ReadOnly, ReadWrite

--os-disk-delete-option

VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブル オーケストレーション モードの VMSS 専用です)。

指定可能な値: Delete, Detach

--os-disk-encryption-set

OS ディスクのディスク暗号化セットの名前または ID。

--os-disk-name

新しい VM OS ディスクの名前。

--os-disk-secure-vm-disk-encryption-set

カスタマー マネージド キーで暗号化された機密 VM OS ディスクと VM ゲスト BLOB に使用されるマネージド ディスクの、カスタマー マネージド ディスク暗号化セットのリソース ID または名前を指定します。

--os-disk-security-encryption-type

OS マネージド ディスクの暗号化の種類を指定します。

指定可能な値: DiskWithVMGuestState, NonPersistedTPM, VMGuestStateOnly

--os-disk-size-gb

作成する OS ディスク サイズ (GB)。

--os-type

カスタム VHD にインストールされている OS の種類。 URN または URN エイリアスを指定する場合は使用しないでください。

指定可能な値: linux, windows

--patch-mode

IaaS 仮想マシンへのゲスト内パッチ適用のモード。 Windows VM で使用できる値: AutomaticByOS、AutomaticByPlatform、Manual。 Linux VM で使用できる値: AutomaticByPlatform、ImageDefault。 手動 - 仮想マシンへのパッチの適用を制御します。 これを行うには、VM 内でパッチを手動で適用します。 このモードでは、自動更新は無効になります。パラメーター --enable-auto-update は false にする必要があります。 AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。 パラメーター --enable-auto-update は true である必要があります。 AutomaticByPlatform - 仮想マシンは OS によって自動的に更新されます。 ImageDefault - 仮想マシンの既定の修正プログラムの適用構成が使用されます。 パラメーター --enable-agent と --enable-auto-update は true である必要があります。

指定可能な値: AutomaticByOS, AutomaticByPlatform, ImageDefault, Manual

--pause-time-between-batches

すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 既定値: 0 秒。

--plan-name

プラン名。

--plan-product

製品を計画します。

--plan-promotion-code

プロモーション コードを計画します。

--plan-publisher

発行元を計画します。

--platform-fault-domain-count

可用性ゾーン内の各配置グループの障害ドメイン数。

--ppg

VMSS を関連付ける必要がある近接通信配置グループの名前または ID。

--prioritize-unhealthy-instances

このブール型プロパティを設定すると、正常なインスタンスの前にスケール セット内のすべての異常なインスタンスがアップグレードされます。

指定可能な値: false, true

--priority

優先順位。 "スポット" を使用して、コスト効率の高い方法で有効期間の短いワークロードを実行します。 'Low' 列挙型は今後非推奨となる予定です。 "スポット" を使用して、Azure スポット VM または VMSS をデプロイしてください。 既定値は Regular です。

指定可能な値: Low, Regular, Spot

--proxy-agent-mode

機能が有効になっている場合にプロキシ エージェントを実行するモードを指定します。

指定可能な値: Audit, Enforce

--public-ip-address

パブリック IP アドレスを作成するときの名前 (既定) または既存の IP アドレスを参照する場合。 また、既存のパブリック IP を ID で参照したり、PowerShell または --% 演算子を使用して Azure CLI で None ('""') に "" を指定することもできます。 PowerShell Core Edition 7.3.4 を使用する Azure CLI の場合は、"" (--public-ip-address または --public-ip-address "") を指定します。

--public-ip-address-allocation

指定可能な値: dynamic, static

--public-ip-address-dns-name

新しく作成されたパブリック IP のグローバルに一意の DNS 名。

--public-ip-per-vm

各 VM インスタンスにはパブリック IP があります。 セキュリティのために、'--nsg' を使用して適切な規則を適用できます。

規定値: False

--regular-priority-count

プレビュー

スケールアウト時にこのスケール セットに作成される通常の優先順位の VM の基本数。0 より大きい必要があります。

--regular-priority-percentage

プレビュー

基本の通常の優先度の数に達した後の、通常の優先度を使用することが予想される VM インスタンスの割合。 0 ～ 100 の範囲で指定します。

--role

システム割り当て ID が持つロール名または ID。

--scale-in-policy

仮想マシン スケール セットをスケールインするときに削除対象として選択する仮想マシンを決定するスケールイン ポリシー (スペース区切り) を指定します。

指定可能な値: Default, NewestVM, OldestVM

--scope

システム割り当て ID がアクセスできるスコープ。

--secrets

[{ "sourceVault": { "id": "value" }, "vaultCertificates": [{ "certificateUrl": "value", "certificateStore": "cert store name (only on windows)"}] }]を含む@{path}を介して JSON 文字列またはファイルとして 1 つまたは複数の Key Vault シークレット。

--security-posture-id --security-posture-reference-id

/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}の形式のセキュリティ体制参照 ID|{major.*}|latest.

--security-type

仮想マシンのセキュリティの種類を指定します。

指定可能な値: ConfidentialVM, Standard, TrustedLaunch

--single-placement-group

スケール セットを 1 つの配置グループに制限します。 詳細については、https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-placement-groups を参照してください。

指定可能な値: false, true

--specialized

ソース イメージが特殊化されているかどうかを示します。

指定可能な値: false, true

--spot-restore-timeout

ISO 8601 時間として表されるタイムアウト値。その後、プラットフォームは VMSS SPOT インスタンスの復元を試行しません。

--ssh-dest-key-path

SSH キーの VM 上の宛先ファイル パス。 ファイルが既に存在する場合は、指定したキーがファイルに追加されます。 現在、LINUX プロビジョニング エージェントの既知の問題により、SSH 公開キーの宛先パスは既定値 "/home/username/.ssh/authorized_keys" に制限されています。

--ssh-key-values

SSH 公開キーまたは公開キー ファイル パスのスペース区切りの一覧。

--storage-container-name

--use-unmanaged-disk と共に使用された場合にのみ適用されます。 VM OS ディスクのストレージ コンテナーの名前。 既定値: vhds。

規定値: vhds

--storage-sku

VM を保持するストレージ アカウントの SKU。 すべてのディスクに適用される単一の SKU を使用するか、個々のディスクを指定します。 使用法: [--storage-sku SKU | --storage-sku ID=SKU ID=SKU ID=SKU...]。各 ID は "os" または 0 インデックス付き lun です。 使用できる値: Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS、StandardSSD_ZRS、PremiumV2_LRS。

--subnet

新しい VNet を作成するとき、または既存の VNet を参照するときのサブネットの名前。 ID で既存のサブネットを参照することもできます。 vnet 名とサブネットの両方を省略すると、適切な VNet とサブネットが自動的に選択されるか、新しく作成されます。

--subnet-address-prefix

CIDR 形式で新しい VNet を作成するときに使用するサブネット IP アドレス プレフィックス。

--tags

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

--terminate-notification-time

VM が削除されるまでインスタンス メタデータ サーバー上の VM に送信される通知の長さ (分単位、5 ~ 15)。

--ultra-ssd-enabled

UltraSSD_LRS ストレージ アカウントを持つ 1 つ以上のマネージド データ ディスクを持つ機能を有効または無効にします。

指定可能な値: false, true

--upgrade-policy-mode

スケール セット内の仮想マシンへのアップグレードモードを指定します。

指定可能な値: Automatic, Manual, Rolling

規定値: manual

--use-unmanaged-disk

マネージド ディスクを使用して VM を保持しないでください。

規定値: False

--user-data

スケール セット内の仮想マシンの UserData。 ファイルまたは文字列として渡すことができます。

--v-cpus-available

使用可能な vCPU の数を指定します。

--v-cpus-per-core

物理コアに対する vCPU の比率を指定します。 このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。

--validate

リソースを作成せずに ARM テンプレートを生成して検証します。

規定値: False

--vm-domain-name

VM インスタンスのドメイン名が構成されると、FQDN が vm<vm-index>.<vm-domain-name>.<..rest..>されます。

--vm-sku

スケール セット内の VM のサイズ。 既定値は "Standard_DS1_v2" です。 サイズ情報については、 https://azure.microsoft.com/pricing/details/virtual-machines/ を参照してください。

--vnet-address-prefix

CIDR 形式で新しい VNet を作成するときに使用する IP アドレス プレフィックス。

規定値: 10.0.0.0/16

--vnet-name

新しい仮想ネットワークを作成するとき、または既存の仮想ネットワークを参照するときの仮想ネットワークの名前。

--zones -z

リソースをプロビジョニングする可用性ゾーンのスペース区切りの一覧。

グローバル パラメーター

--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 deallocate

VMSS 内の VM の割り当てを解除します。

az vmss deallocate --name
                   --resource-group
                   [--hibernate {false, true}]
                   [--instance-ids]
                   [--no-wait]

例

VMSS 内の VM の割り当てを解除します。 (自動生成)

az vmss deallocate --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--hibernate

VM スケール セットから仮想マシンを休止状態にします。 フレキシブル OrchestrationMode を使用する VMSS でのみ使用できます。

指定可能な値: false, true

--instance-ids

すべてのインスタンスの ID (例: 1 2 3 ...) または * のスペース区切りのリスト。 指定しない場合、アクションはスケールセット自体に適用されます。

--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 delete

VM スケール セットを削除します。

az vmss delete [--force-deletion {0, 1, f, false, n, no, t, true, y, yes}]
               [--ids]
               [--name]
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
               [--resource-group]
               [--subscription]

省略可能のパラメーター

--force-deletion

VM スケール セットを強制的に削除するための省略可能なパラメーター。 (プレビューの機能)。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--name --vm-scale-set-name -n

VM スケール セットの名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--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 を使います。

az vmss delete-instances

VMSS 内の VM を削除します。

az vmss delete-instances --instance-ids
                         --name
                         --resource-group
                         [--no-wait]

例

VMSS 内の VM を削除します。 (自動生成)

az vmss delete-instances --instance-ids 0 --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--instance-ids

すべてのインスタンスの ID (例: 1 2 3 ...) または * のスペース区切りのリスト。

--name -n

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<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 get-instance-view

VMSS のインスタンスを表示します。

az vmss get-instance-view [--ids]
                          [--instance-id]
                          [--name]
                          [--resource-group]
                          [--subscription]

例

VMSS のインスタンスを表示します。 (自動生成)

az vmss get-instance-view --name MyScaleSet --resource-group MyResourceGroup

省略可能のパラメーター

--ids

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

--instance-id

スケール セット内のすべての VM のインスタンス ビューを一覧表示する VM インスタンス ID または "*"。

--name -n

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

--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 を使います。

az vmss get-os-upgrade-history

VM スケール セット インスタンスの OS アップグレードを一覧表示します。

az vmss get-os-upgrade-history --name
                               --resource-group
                               [--max-items]
                               [--next-token]

必須のパラメーター

--name --vm-scale-set-name -n

VM スケール セットの名前。

--resource-group -g

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

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター

--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 list

リソース グループのすべての VM スケール セットを一覧表示します。

az vmss list [--max-items]
             [--next-token]
             [--resource-group]

例

VMSS の一覧表示

az vmss list --resource-group MyResourceGroup

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<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 list-instance-connection-info

セット内の個々の VM インスタンスに接続するために使用される IP アドレスとポート番号を取得します。

az vmss list-instance-connection-info [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

例

セット内の個々の VM インスタンスに接続するために使用される IP アドレスとポート番号を取得します。 (自動生成)

az vmss list-instance-connection-info --name MyScaleSet --resource-group MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

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

--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 を使います。

az vmss list-instance-public-ips

セット内の VM インスタンスのパブリック IP アドレスを一覧表示します。

az vmss list-instance-public-ips [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

例

セット内の VM インスタンスのパブリック IP アドレスを一覧表示します。 (自動生成)

az vmss list-instance-public-ips --name MyScaleSet --resource-group MyResourceGroup

省略可能のパラメーター

--ids

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

--name -n

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

--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 を使います。

az vmss list-instances

VM スケール セット内のすべての仮想マシンを一覧表示します。

VMSS によって管理されている仮想マシンの一覧を返します。 フレキシブル オーケストレーション モードの VMSS の場合は、"az vm list" を使用して詳細を取得してください。

az vmss list-instances --name
                       --resource-group
                       [--expand]
                       [--filter]
                       [--max-items]
                       [--next-token]
                       [--select]

必須のパラメーター

--name --virtual-machine-scale-set-name -n

VM スケール セットの名前。

--resource-group -g

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

省略可能のパラメーター

--expand

操作に適用する展開式。 使用できる値は 'instanceView' です。

--filter

操作に適用するフィルター。 使用できる値は、'startswith(instanceView/statuses/code, 'PowerState') eq true'、'properties/latestModelApplied eq true'、'properties/latestModelApplied eq false' です。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--select

リスト パラメーター。 使用できる値は 、'instanceView'、'instanceView/statuses' です。

グローバル パラメーター

--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 list-skus

VM スケール セットで使用可能な SKU (各 SKU で許可される最小および最大 VM インスタンスを含む) を一覧表示します。

az vmss list-skus --name
                  --resource-group
                  [--max-items]
                  [--next-token]

必須のパラメーター

--name --vm-scale-set-name -n

VM スケール セットの名前。

--resource-group -g

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

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター

--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 perform-maintenance

VM スケール セット内の 1 つ以上の仮想マシンに対してメンテナンスを実行します。 メンテナンスを実行できないインスタンスに対する操作は失敗します。 詳細については、ベスト プラクティス( https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications)を参照してください。

az vmss perform-maintenance [--ids]
                            [--instance-ids]
                            [--name]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]

省略可能のパラメーター

--ids

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

--instance-ids

仮想マシン スケール セットのインスタンス ID。 仮想マシン スケール セットのインスタンス ID を省略すると、仮想マシン スケール セット内のすべての仮想マシンで操作が実行されます。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--name --vm-scale-set-name -n

VM スケール セットの名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--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 を使います。

az vmss reimage

VMSS 内の VM を再イメージ化します。

az vmss reimage [--force-update-os-disk-for-ephemeral {false, true}]
                [--ids]
                [--instance-ids]
                [--name]
                [--no-wait]
                [--resource-group]
                [--subscription]

例

VMSS 内の VM インスタンスを再イメージ化します。

az vmss reimage --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription

VMSS 内の VM インスタンスのバッチを再イメージ化します。

az vmss reimage --instance-ids 1 2 3 --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription

VMSS 内のすべての VM インスタンスを再イメージ化します。

az vmss reimage --name MyScaleSet --resource-group MyResourceGroup --subscription MySubscription

省略可能のパラメーター

--force-update-os-disk-for-ephemeral --update-os-disk

仮想マシン スケール セット VM の一時的な OS ディスクを強制的に更新します。

指定可能な値: false, true

--ids

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

--instance-ids

VM インスタンス 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 を使います。

az vmss restart

VMSS 内の VM を再起動します。

az vmss restart --name
                --resource-group
                [--instance-ids]
                [--no-wait]

例

VMSS 内の VM を再起動します。 (自動生成)

az vmss restart --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--instance-ids

すべてのインスタンスの ID (例: 1 2 3 ...) または * のスペース区切りのリスト。 指定しない場合、アクションはスケールセット自体に適用されます。

--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 scale

VMSS 内の VM の数を変更します。

az vmss scale --new-capacity
              [--ids]
              [--name]
              [--no-wait]
              [--resource-group]
              [--subscription]

例

VMSS 内の VM の数を変更します。 (自動生成)

az vmss scale --name MyScaleSet --new-capacity 6 --resource-group MyResourceGroup

必須のパラメーター

--new-capacity

VMSS 内の VM の数。

省略可能のパラメーター

--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 を使います。

az vmss set-orchestration-service-state

VMSS 内の特定のサービスの ServiceState プロパティを変更します。

az vmss set-orchestration-service-state --action {Resume, Suspend}
                                        --service-name {AutomaticRepairs, DummyOrchestrationServiceName}
                                        [--ids]
                                        [--name]
                                        [--no-wait]
                                        [--resource-group]
                                        [--subscription]

例

AutomaticRepairs の ServiceState プロパティを変更する

az vmss set-orchestration-service-state --service-name AutomaticRepairs --action Resume --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--action

実行するアクション。

指定可能な値: Resume, Suspend

--service-name

オーケストレーション サービスの名前。

指定可能な値: AutomaticRepairs, DummyOrchestrationServiceName

省略可能のパラメーター

--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 を使います。

az vmss show

VMSS 内の VM の詳細を取得します。

az vmss show --name
             --resource-group
             [--include-user-data]
             [--instance-id]

例

VMSS 内の VM の詳細を取得します。 (自動生成)

az vmss show --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--include-user-data -u

クエリ結果にユーザー データ プロパティを含めます。

規定値: False

--instance-id

VM インスタンス ID。 見つからない場合は、VMSS を表示します。

グローバル パラメーター

--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 simulate-eviction

VM スケール セット内のスポット仮想マシンの削除をシミュレートします。

az vmss simulate-eviction [--ids]
                          [--instance-id]
                          [--name]
                          [--resource-group]
                          [--subscription]

例

VM スケール セット内のスポット仮想マシンの削除をシミュレートします。

az vmss simulate-eviction --resource-group MyResourceGroup --name MyScaleSet --instance-id 0

省略可能のパラメーター

--ids

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

--instance-id

仮想マシンのインスタンス ID。

--name --vm-scale-set-name -n

VM スケール セットの名前。

--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 を使います。

az vmss start

VMSS 内の VM を起動します。

az vmss start --name
              --resource-group
              [--instance-ids]
              [--no-wait]

例

VMSS 内の VM を起動します。 (自動生成)

az vmss start --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--instance-ids

すべてのインスタンスの ID (例: 1 2 3 ...) または * のスペース区切りのリスト。 指定しない場合、アクションはスケールセット自体に適用されます。

--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 stop

VMSS 内の VM の電源をオフ (停止) します。

VM は引き続き課金されます。 これを回避するには、"az vmss deallocate" を使用して VMSS 内の VM インスタンスの割り当てを解除します。

az vmss stop --name
             --resource-group
             [--instance-ids]
             [--no-wait]
             [--skip-shutdown]

例

シャットダウンせずに VMSS 内の VM の電源をオフにします。

az vmss stop --name MyScaleSet --resource-group MyResourceGroup --skip-shutdown

VMSS 内の VM の電源をオフ (停止) します。 (自動生成)

az vmss stop --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--name -n

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

--resource-group -g

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

省略可能のパラメーター

--instance-ids

すべてのインスタンスの ID (例: 1 2 3 ...) または * のスペース区切りのリスト。 指定しない場合、アクションはスケールセット自体に適用されます。

--no-wait

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

規定値: False

--skip-shutdown

シャットダウンと電源オフをすぐにスキップします。

規定値: 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 update

VMSS を更新します。 アップグレード ポリシーを構成していない場合は、'az vmss update-instances' コマンドを実行して VM への変更をロールアウトします。

az vmss update [--add]
               [--additional-events {false, true}]
               [--automatic-repairs-action {Reimage, Replace, Restart}]
               [--automatic-repairs-grace-period]
               [--capacity-reservation-group]
               [--custom-data]
               [--disk-controller-type {NVMe, SCSI}]
               [--enable-auto-os-upgrade {false, true}]
               [--enable-automatic-repairs {false, true}]
               [--enable-cross-zone-upgrade {false, true}]
               [--enable-hibernation {false, true}]
               [--enable-osimage-notification {false, true}]
               [--enable-proxy-agent {false, true}]
               [--enable-reboot {false, true}]
               [--enable-redeploy {false, true}]
               [--enable-resilient-creation {false, true}]
               [--enable-resilient-deletion {false, true}]
               [--enable-secure-boot {false, true}]
               [--enable-spot-restore {false, true}]
               [--enable-terminate-notification {false, true}]
               [--enable-vtpm {false, true}]
               [--ephemeral-option {Local}]
               [--ephemeral-os-disk {false, true}]
               [--ephemeral-os-disk-placement {CacheDisk, NvmeDisk, ResourceDisk}]
               [--exclude-extensions]
               [--force-deletion]
               [--force-string]
               [--ids]
               [--instance-id]
               [--license-type {None, RHEL_BASE, RHEL_BASESAPAPPS, RHEL_BASESAPHA, RHEL_BYOS, RHEL_ELS_6, RHEL_EUS, RHEL_SAPAPPS, RHEL_SAPHA, SLES, SLES_BYOS, SLES_HPC, SLES_SAP, SLES_STANDARD, UBUNTU, UBUNTU_PRO, Windows_Client, Windows_Server}]
               [--max-batch-instance-percent]
               [--max-price]
               [--max-surge {false, true}]
               [--max-unhealthy-instance-percent]
               [--max-unhealthy-upgraded-instance-percent]
               [--name]
               [--no-wait]
               [--pause-time-between-batches]
               [--ppg]
               [--prioritize-unhealthy-instances {false, true}]
               [--priority {Low, Regular, Spot}]
               [--protect-from-scale-in {false, true}]
               [--protect-from-scale-set-actions {false, true}]
               [--proxy-agent-mode {Audit, Enforce}]
               [--regular-priority-count]
               [--regular-priority-percentage]
               [--remove]
               [--resource-group]
               [--scale-in-policy {Default, NewestVM, OldestVM}]
               [--security-posture-id]
               [--security-type {Standard, TrustedLaunch}]
               [--set]
               [--spot-restore-timeout]
               [--subscription]
               [--terminate-notification-time]
               [--ultra-ssd-enabled {false, true}]
               [--upgrade-policy-mode {Automatic, Manual, Rolling}]
               [--user-data]
               [--v-cpus-available]
               [--v-cpus-per-core]
               [--vm-sku]
               [--zones]

例

Azure ハイブリッド特典の VMSS のライセンスの種類を更新します。

az vmss update --name MyScaleSet --resource-group MyResourceGroup --license-type windows_server

VM インスタンスの保護ポリシーを更新します。

az vmss update --name MyScaleSet --resource-group MyResourceGroup --instance-id 4 --protect-from-scale-set-actions False --protect-from-scale-in

VM インスタンスの保護ポリシーを更新します。

az vmss update --name MyScaleSet --resource-group MyResourceGroup --instance-id 4 --set protectionPolicy.protectFromScaleIn=True protectionPolicy.protectFromScaleSetActions=False

VM インスタンスのマネージド ディスクの読み取り/書き込み IOPS を更新します。

az vmss update --name MyScaleSet --resource-group MyResourceGroup --set virtualMachineProfile.storageProfile.dataDisks[0].diskIOPSReadWrite=444

マネージド ディスクの 1 秒あたりの VM インスタンスの帯域幅を MB 単位で更新します。

az vmss update --name MyScaleSet --resource-group MyResourceGroup --set virtualMachineProfile.storageProfile.dataDisks[0].diskMBpsReadWrite=66

カスタム イメージを使用するように VM を更新します。

az vmss update --name MyScaleSet --resource-group MyResourceGroup --set virtualMachineProfile.storageProfile.imageReference.id=imageID

Linux VMSS をパッチ モード 'AutomaticByPlatform' に更新します。

az vmss update -n MyVmss -g MyResourceGroup --set virtualMachineProfile.osProfile.linuxConfiguration.patchSettings.patchMode=AutomaticByPlatform

スケール セット内のすべての仮想マシンに使用するセキュリティ体制を指定して、VMSS を更新します。

az vmss update -n MyVmss -g MyResourceGroup --security-posture-reference-id /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{version} \
    --security-posture-reference-exclude-extensions "c:\tmp\exclude_extensions.json"

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

規定値: []

--additional-events --additional-scheduled-events --scheduled-event-additional-publishing-target-event-grid-and-resource-graph

イベント グリッドとリソース グラフのスケジュールされたイベント設定の作成時に使用される構成パラメーター。

指定可能な値: false, true

--automatic-repairs-action

スケール セット内の異常な仮想マシンの修復に使用される修復アクションの種類。

指定可能な値: Reimage, Replace, Restart

--automatic-repairs-grace-period

VM の状態変化により自動修復が中断される時間 (分単位、30 ~ 90)。

--capacity-reservation-group --crg

プレビュー

割り当てに使用される容量予約グループの ID または名前。 容量予約グループの関連付けを解除するには、"None" を渡します。 容量予約グループに関連付けられている VM/VMSS を削除する場合は、まず容量予約グループの関連付けを解除する必要があることに注意してください。

--custom-data

カスタム init スクリプト ファイルまたはテキスト (cloud-init、cloud-config など)。

--disk-controller-type

プレビュー

VM または VMSS 用に構成されたディスク コントローラーの種類を指定します。

指定可能な値: NVMe, SCSI

--enable-auto-os-upgrade

新しいバージョンの OS イメージが使用可能になったときに、OS アップグレードをスケール セット インスタンスに自動的に適用するかどうかを示します。

指定可能な値: false, true

--enable-automatic-repairs

自動修復を有効にします。

指定可能な値: false, true

--enable-cross-zone-upgrade

このブール型プロパティを設定すると、VMSS はアップグレード バッチの作成時に AZ 境界を無視でき、バッチ サイズを決定するには Update Domain と maxBatchInstancePercent のみを考慮します。

指定可能な値: false, true

--enable-hibernation

VMSS の休止機能を有効または無効にするフラグ。

指定可能な値: false, true

--enable-osimage-notification

OS Image Scheduled イベントを有効にするか無効にするかを指定します。

指定可能な値: false, true

--enable-proxy-agent

仮想マシンまたは仮想マシン スケール セットでプロキシ エージェント機能を有効にする必要があるかどうかを指定します。

指定可能な値: false, true

--enable-reboot --enable-user-reboot-scheduled-events

スケジュールされたイベントの追加の発行ターゲットの発行時に使用される構成パラメーター。

指定可能な値: false, true

--enable-redeploy --enable-user-redeploy-scheduled-events

ユーザーが開始したスケジュールされたイベント設定の作成を再デプロイするときに使用される構成パラメーター。

指定可能な値: false, true

--enable-resilient-creation

影響を受ける VM を削除して再作成することで、VM の作成操作中に発生した OS プロビジョニング タイムアウトエラーと VM 開始タイムアウト エラーから顧客を自動的に復旧します。

指定可能な値: false, true

--enable-resilient-deletion

削除操作が失敗した場合に、VM の削除要求を非同期的に再試行します。

指定可能な値: false, true

--enable-secure-boot

セキュア ブートを有効にします。

指定可能な値: false, true

--enable-spot-restore

容量の可用性と価格の制約に基づいて、削除された VMSS SPOT インスタンスを日和見的に復元しようとするスポット復元機能を有効にします。

指定可能な値: false, true

--enable-terminate-notification

終了通知を有効にします。

指定可能な値: false, true

--enable-vtpm

vTPM を有効にします。

指定可能な値: false, true

--ephemeral-option --ephemeral-os-disk-option

オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

指定可能な値: Local

--ephemeral-os-disk

オペレーティング システム ディスクのエフェメラル ディスク設定を指定できます。 一時ディスク設定を空として設定し、非エフェメラルに移行するには、false に指定します。

指定可能な値: false, true

--ephemeral-os-disk-placement --ephemeral-placement

--vm-sku と共に使用された場合にのみ適用されます。 エフェメラル OS ディスクのプロビジョニング場所を選択できます。

指定可能な値: CacheDisk, NvmeDisk, ResourceDisk

--exclude-extensions --security-posture-reference-exclude-extensions

セキュリティ体制を適用するときに除外する仮想マシン拡張機能の一覧。 Json 文字列またはファイル パスを使用できます。 データ形式については、 https://docs.microsoft.com/rest/api/compute/virtualmachinescalesets/get#virtualmachineextension を参照してください。

--force-deletion

プレビュー

このプロパティを使用すると、仮想マシン スケール セットのスケールイン時に、削除対象として選択した仮想マシンを強制的に削除する必要があるかどうかを指定できます。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False

--ids

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

--instance-id

この ID で VM インスタンスを更新します。 見つからない場合は、VMSS を更新します。

--license-type

Windows イメージまたはディスクのライセンスがオンプレミスにあることを指定します。 Windows Server のAzure ハイブリッド特典を有効にするには、'Windows_Server' を使用します。 Windows 10 のマルチテナント ホスティング権限を有効にするには、'Windows_Client' を使用します。 詳細については、Azure Windows VM のオンライン ドキュメントを参照してください。

指定可能な値: None, RHEL_BASE, RHEL_BASESAPAPPS, RHEL_BASESAPHA, RHEL_BYOS, RHEL_ELS_6, RHEL_EUS, RHEL_SAPAPPS, RHEL_SAPHA, SLES, SLES_BYOS, SLES_HPC, SLES_SAP, SLES_STANDARD, UBUNTU, UBUNTU_PRO, Windows_Client, Windows_Server

--max-batch-instance-percent

1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 既定値: 20%

--max-price

プレビュー

スポット VM/VMSS に対して支払う最大価格 (米ドル)。 -1 は、価格上の理由からスポット VM/VMSS を削除しないことを示します。

--max-surge

プレビュー

既存の仮想マシンを更新するのではなく、スケール セットをアップグレードする新しい仮想マシンを作成するように指定します。

指定可能な値: false, true

--max-unhealthy-instance-percent

同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 既定値: 20%

--max-unhealthy-upgraded-instance-percent

異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 既定値: 20%

--name -n

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

--no-wait

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

規定値: False

--pause-time-between-batches

すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 既定値: 0 秒。

--ppg

VMSS を関連付ける必要がある近接通信配置グループの名前または ID。

--prioritize-unhealthy-instances

このブール型プロパティを設定すると、正常なインスタンスの前にスケール セット内のすべての異常なインスタンスがアップグレードされます。

指定可能な値: false, true

--priority

優先順位。 "スポット" を使用して、コスト効率の高い方法で有効期間の短いワークロードを実行します。 'Low' 列挙型は今後非推奨となる予定です。 "スポット" を使用して、Azure スポット VM または VMSS をデプロイしてください。 既定値は Regular です。

指定可能な値: Low, Regular, Spot

--protect-from-scale-in

スケールイン操作から VM インスタンスを保護します。

指定可能な値: false, true

--protect-from-scale-set-actions

スケール セットアクション (スケールインを含む) から VM インスタンスを保護します。

指定可能な値: false, true

--proxy-agent-mode

機能が有効になっている場合にプロキシ エージェントを実行するモードを指定します。

指定可能な値: Audit, Enforce

--regular-priority-count

プレビュー

スケールアウト時にこのスケール セットに作成される通常の優先順位の VM の基本数。0 より大きい必要があります。

--regular-priority-percentage

プレビュー

基本の通常の優先度の数に達した後の、通常の優先度を使用することが予想される VM インスタンスの割合。 0 ～ 100 の範囲で指定します。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

規定値: []

--resource-group -g

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

--scale-in-policy

仮想マシン スケール セットをスケールインするときに削除対象として選択する仮想マシンを決定するスケールイン ポリシー (スペース区切り) を指定します。

指定可能な値: Default, NewestVM, OldestVM

--security-posture-id --security-posture-reference-id

/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}の形式のセキュリティ体制参照 ID|{major.*}|latest.

--security-type

仮想マシン スケール セットのセキュリティの種類を指定します。

指定可能な値: Standard, TrustedLaunch

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

規定値: []

--spot-restore-timeout

ISO 8601 時間として表されるタイムアウト値。その後、プラットフォームは VMSS SPOT インスタンスの復元を試行しません。

--subscription

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

--terminate-notification-time

VM が削除されるまでインスタンス メタデータ サーバー上の VM に送信される通知の長さ (分単位、5 ~ 15)。

--ultra-ssd-enabled

UltraSSD_LRS ストレージ アカウントを持つ 1 つ以上のマネージド データ ディスクを持つ機能を有効または無効にします。

指定可能な値: false, true

--upgrade-policy-mode

スケール セット内の仮想マシンへのアップグレードモードを指定します。

指定可能な値: Automatic, Manual, Rolling

--user-data

スケール セット内の仮想マシンの UserData。 ファイルまたは文字列として渡すことができます。 空の文字列が渡されると、既存の値が削除されます。

--v-cpus-available

使用可能な vCPU の数を指定します。

--v-cpus-per-core

物理コアに対する vCPU の比率を指定します。 このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。

--vm-sku

プレビュー

スケール セット内の仮想マシン インスタンスの新しいサイズ。 既定値は "Standard_DS1_v2" です。 サイズ情報については、 https://azure.microsoft.com/pricing/details/virtual-machines/ を参照してください。

--zones -z

リソースをプロビジョニングする可用性ゾーンのスペース区切りの一覧。

グローバル パラメーター

--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 update-domain-walk

Service Fabric 仮想マシン スケール セット内の仮想マシンを更新するための手動プラットフォーム更新ドメインウォーク。

az vmss update-domain-walk --platform-update-domain
                           [--ids]
                           [--placement-group-id]
                           [--resource-group]
                           [--subscription]
                           [--vmss-name]
                           [--zone]

例

Service Fabric プラットフォームの更新ドメインの強制ウォーク

az vmss update-domain-walk -g rg --vmss-name vmss --platform-update-domain

必須のパラメーター

--platform-update-domain

手動回復ウォークが要求されるプラットフォーム更新ドメイン。

省略可能のパラメーター

--ids

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

--placement-group-id

手動回復ウォークが要求される配置グループ ID。

--resource-group -g

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

--subscription

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

--vmss-name

VM スケール セットの名前。

--zone

クロス ゾーン仮想マシン スケール セットに対して手動回復ウォークが要求されるゾーン。

グローバル パラメーター

--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 update-instances

VMSS 内の VM をアップグレードします。

az vmss update-instances --instance-ids
                         --name
                         --resource-group
                         [--no-wait]

例

VMSS 内の VM をアップグレードします。 (自動生成)

az vmss update-instances --instance-ids 1 --name MyScaleSet --resource-group MyResourceGroup

必須のパラメーター

--instance-ids

すべてのインスタンスの ID (例: 1 2 3 ...) または * のスペース区切りのリスト。

--name -n

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<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 wait

スケール セットの条件が満たされるまで、CLI を待機状態にします。

az vmss wait [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--ids]
             [--instance-id]
             [--interval]
             [--name]
             [--resource-group]
             [--subscription]
             [--timeout]
             [--updated]

例

VMSS が更新されるまで、CLI を待機状態にします。

az vmss wait --updated --name MyScaleSet --resource-group MyResourceGroup

VMSS インスタンスが更新されるまで、CLI を待機状態にします。

az vmss wait --updated --instance-id 1 --name MyScaleSet --resource-group MyResourceGroup

スケール セットの条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az vmss wait --created --name MyScaleSet --resource-group MyResourceGroup

省略可能のパラメーター

--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' 引数を指定する必要があります。

--instance-id

この ID の VM インスタンスを待機します。 見つからない場合は、VMSS で待機します。

--interval

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

規定値: 30

--name -n

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

--resource-group -g

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

--subscription

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

--timeout

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

規定値: 3600

--updated

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

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