Virtual Machine Scale Sets - List

リソースグループの下にあるすべての VM スケールセットの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2021-07-01

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

リソース グループの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント Api バージョン。

応答

Name Type Description
200 OK

[OK]

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

定義

AdditionalCapabilities

仮想マシンまたは仮想マシン スケール セットの機能を有効または無効にします。

AdditionalUnattendContent

Windows セットアップによって使用される、Unattend.xml ファイルに含めることができる XML 形式の追加情報を指定します。 コンテンツは、設定名、コンポーネント名、およびコンテンツが適用されるパスによって定義されます。

ApiEntityReference

API エンティティ参照。

ApplicationProfile

VM/VMSS で使用できるようにするギャラリーアプリケーションの一覧が含まれています。

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

AutomaticRepairsPolicy

仮想マシンスケールセットで自動修復を行うための構成パラメーターを指定します。

BillingProfile

Azure スポット VM または VMSS の課金に関連する詳細を指定します。

最小 api バージョン: 2019-03-01。

BootDiagnostics

ブート診断はデバッグ機能であり、コンソール出力とスクリーンショットを表示して VM の状態を診断できます。

コンソール ログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。

CachingTypes

キャッシュの種類を取得します。

CapacityReservationProfile

容量予約プロファイルのパラメーター。

ComponentNames

コンポーネントの名前。 現時点では、許可されている値は、Microsoft Windows の設定のみです。

DeleteOptions

VM が削除されたときのネットワークインターフェイスの動作を指定します

DiagnosticsProfile

ブート診断設定の状態を指定します。

最小 api バージョン: 2015-06-15。

DiffDiskOptions

オペレーティングシステムディスクの一時ディスク設定を指定します。

DiffDiskPlacement

オペレーティングシステムディスクの一時ディスクの配置を指定します。 このプロパティは、一時的な OS ディスクプロビジョニング用のキャッシュディスクまたはリソースディスク領域を選択するために、ユーザーが要求で使用できます。 一時 os のディスクサイズの要件の詳細については、「」の vm https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements と Linux vm の Windows vm の一時 os ディスクサイズ要件を参照してください。https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiffDiskSettings

オペレーティングシステムディスクに指定できる一時ディスク設定のパラメーターについて説明します。

注: 一時ディスクの設定は、管理ディスクに対してのみ指定できます。

DiskCreateOptionTypes

仮想マシンの作成方法を指定します。

次のいずれかの値になります。

Attach \u2013 この値は、仮想マシンを作成するために特殊なディスクを使用する場合に使用します。

Fromimage \u2013 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォームイメージを使用する場合は、上で説明した imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

DiskEncryptionSetParameters

ディスクに指定できるユーザー管理ディスク暗号化セットリソース id のパラメーターについて説明します。

注: ディスク暗号化セットのリソース id は、管理ディスクに対してのみ指定できます。 詳細については、「」を参照してください https://aka.ms/mdssewithcmkoverview

ExtendedLocation

拡張位置の複合型。

ExtendedLocationTypes

拡張された場所の型。

ImageReference

使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。 注: イメージ参照パブリッシャーとオファーは、スケール セットを作成するときにのみ設定できます。

IPVersion

Api-Version 2019-07-01 以降で使用できます。これは、特定の ip 構成が IPv4 と IPv6 のどちらであるかを表します。 既定値は IPv4 として取得されます。 指定できる値は ' IPv4 ' と ' IPv6 ' です。

LinuxConfiguration

仮想マシン上の Linux オペレーティングシステムの設定を指定します。

サポートされている Linux ディストリビューションの一覧については、「 linux on Azure-Endorsed ディストリビューション」を参照してください。

LinuxPatchAssessmentMode

IaaS 仮想マシンに対する VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

LinuxPatchSettings

Linux 上の VM ゲスト修正に関連する設定を指定します。

LinuxVMGuestPatchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンの既定の修正プログラム構成が使用されます。

自動 byplatform -仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent は true である必要があります

NetworkApiVersion

は、ネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します

OperatingSystemTypes

OsDiskImage のオペレーティングシステム。

OrchestrationMode

仮想マシン スケール セットのオーケストレーション モードを指定します。

PassNames

パス名。 現時点では、許可されている値は OobeSystem だけです。

PatchSettings

Windows での VM ゲスト修正に関連する設定を指定します。

Plan

仮想マシンの作成に使用する marketplace イメージに関する情報を指定します。 この要素は、marketplace イメージに対してのみ使用されます。 API から marketplace イメージを使用する前に、プログラムで使用できるようにイメージを有効にする必要があります。 Azure portal で、使用する marketplace イメージを見つけて、[プログラムによる展開、はじめに >] の順にクリックします。 必要な情報を入力し、[ 保存] をクリックします。

ProtocolTypes

WinRM リスナーのプロトコルを指定します。

次のいずれかの値になります。
http

ssl

PublicIPAddressSku

パブリック IP Sku について説明します

PublicIPAddressSkuName

パブリック IP SKU 名を指定する

PublicIPAddressSkuTier

パブリック IP SKU レベルを指定する

ResourceIdentityType

仮想マシンに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、仮想マシンから ID を削除します。

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

ScaleInPolicy

仮想マシン スケール セットのスケールイン ポリシーについて説明します。

ScheduledEventsProfile
SecurityProfile

仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch に設定されていない限り、UefiSettings は有効になりません。

SettingNames

コンテンツが適用される設定の名前を指定します。 指定できる値は、FirstLogonCommands と自動ログオンです。

Sku

仮想マシンスケールセットの sku について説明します。 注: スケールセットが現在存在するハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケールセット内の Vm の割り当てを解除する必要があります。

SpotRestorePolicy

仮想マシン スケール セットの Spot-Try-Restore プロパティを指定します。

このプロパティを使用すると、容量の可用性と価格の制約に基づいて、削除されたスポット VMSS VM インスタンスの自動復元を日和見的に有効または無効にできます。

SshConfiguration

Azure で実行されている Linux ベースの Vm の SSH 構成

SshPublicKey

SSH 証明書の公開キーと、公開キーが配置されている Linux VM のパスに関する情報が含まれています。

StorageAccountTypes

管理ディスクのストレージアカウントの種類を指定します。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

SubResource
TerminateNotificationProfile
UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM のようなセキュリティ設定を指定します。

最小 api-version: 2020-12-01

UpgradeMode

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

次のいずれかの値になります。

手動 - スケール セット内の仮想マシンに対する更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

UpgradePolicy

アップグレードポリシー (自動、手動、またはローリング) について説明します。

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID です。

VaultCertificate

Key Vault 内の1つの証明書参照と、その証明書を VM 上に配置する必要がある場所について説明します。

VaultSecretGroup

すべて同じ Key Vault にある一連の証明書を記述します。

VirtualHardDisk

ディスクの uri について説明します。

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。

Azure スポット仮想マシンの場合、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは2019-03-01 です。

Azure スポットスケールセットでは、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは 2017-10-30-preview です。

VirtualMachinePriorityTypes

仮想マシンの優先順位を指定します。

最小 api バージョン: 2019-03-01

VirtualMachineScaleSet

仮想マシンスケールセットについて説明します。

VirtualMachineScaleSetDataDisk

仮想マシン スケール セットのデータ ディスクについて説明します。

VirtualMachineScaleSetExtension

仮想マシン スケール セット拡張機能について説明します。

VirtualMachineScaleSetExtensionProfile

仮想マシンスケールセット拡張機能のプロファイルについて説明します。

VirtualMachineScaleSetIdentity

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

VirtualMachineScaleSetIPConfiguration

仮想マシンスケールセットのネットワークプロファイルの IP 構成について説明します。

VirtualMachineScaleSetIpTag

パブリック IP アドレスに関連付けられている IP タグを格納します。

VirtualMachineScaleSetListResult

バーチャルマシン操作の応答の一覧です。

VirtualMachineScaleSetManagedDiskParameters

ScaleSet 管理ディスクのパラメーターについて説明します。

VirtualMachineScaleSetNetworkConfiguration

仮想マシン スケール セットのネットワーク プロファイルのネットワーク構成について説明します。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

仮想マシンスケールセットのネットワーク構成の DNS 設定について説明します。

VirtualMachineScaleSetNetworkProfile

仮想マシンスケールセットのネットワークプロファイルについて説明します。

VirtualMachineScaleSetOSDisk

仮想マシン スケール セットのオペレーティング システム ディスクについて説明します。

VirtualMachineScaleSetOSProfile

仮想マシン スケール セットの OS プロファイルについて説明します。

VirtualMachineScaleSetPublicIPAddressConfiguration

仮想マシンスケールセットの IP 構成の PublicIPAddress 構成について説明します。

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

仮想マシンスケールセットのネットワーク構成の DNS 設定について説明します。

VirtualMachineScaleSetStorageProfile

仮想マシンスケールセットのストレージプロファイルについて説明します。

VirtualMachineScaleSetVMProfile

仮想マシンスケールセットの仮想マシンプロファイルについて説明します。

VMGalleryApplication

コンピューティングギャラリーアプリケーションのバージョンを参照するために必要な情報を指定します

WindowsConfiguration

仮想マシン上の Windows オペレーティング システムの設定を指定します。

WindowsPatchAssessmentMode

IaaS 仮想マシンに対する VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

WindowsVMGuestPatchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

次のいずれかの値になります。

手動 -仮想マシンに対する修正プログラムの適用を制御します。 これを行うには、VM 内で手動で修正プログラムを適用します。 このモードでは、自動更新は無効になっています。WindowsConfiguration. Enable自動更新プロパティは false である必要があります

自動 : os によって仮想マシンが自動的に更新されます。 WindowsConfiguration. Enable自動更新プロパティは true である必要があります。

自動 byplatform -仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent と WindowsConfiguration. Enable自動更新は true でなければなりません

WinRMConfiguration

VM の構成 Windows リモート管理について説明します。

WinRMListener

Windows リモート管理リスナーのプロトコルと拇印について説明します。

AdditionalCapabilities

仮想マシンまたは仮想マシン スケール セットの機能を有効または無効にします。

Name Type Description
hibernationEnabled
  • boolean

VM で休止状態機能を有効または無効にするフラグ。

ultraSSDEnabled
  • boolean

VM または VMSS のストレージ アカウントの種類が UltraSSD_LRS のマネージド データ ディスクを 1 つ以上持つ機能を有効または無効にするフラグ。 ストレージ アカウントの種類が UltraSSD_LRSマネージド ディスクは、このプロパティが有効になっている場合にのみ、仮想マシンまたは仮想マシン スケール セットに追加できます。

AdditionalUnattendContent

Windows セットアップによって使用される、Unattend.xml ファイルに含めることができる XML 形式の追加情報を指定します。 コンテンツは、設定名、コンポーネント名、およびコンテンツが適用されるパスによって定義されます。

Name Type Description
componentName

コンポーネントの名前。 現時点では、許可されている値は、Microsoft Windows の設定のみです。

content
  • string

指定されたパスおよびコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満にする必要があり、挿入する設定または機能のルート要素を含める必要があります。

passName

パス名。 現時点では、許可されている値は OobeSystem だけです。

settingName

コンテンツが適用される設定の名前を指定します。 指定できる値は、FirstLogonCommands と自動ログオンです。

ApiEntityReference

API エンティティ参照。

Name Type Description
id
  • string

/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... の形式の ARM リソース ID。

ApplicationProfile

VM/VMSS で使用できるようにするギャラリーアプリケーションの一覧が含まれています。

Name Type Description
galleryApplications

VM/VMSS で使用できるようにするギャラリーアプリケーションを指定します

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

Name Type Description
disableAutomaticRollback
  • boolean

OS イメージのロールバック機能を無効にするかどうか。 既定値は false です。

enableAutomaticOSUpgrade
  • boolean

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

ベースのスケール セットでこれが true に設定されているWindows enableAutomaticUpdatesは自動的に false に設定され、true に設定することはできません。

AutomaticRepairsPolicy

仮想マシンスケールセットで自動修復を行うための構成パラメーターを指定します。

Name Type Description
enabled
  • boolean

仮想マシンスケールセットで自動修復を有効にする必要があるかどうかを指定します。 既定値は false です。

gracePeriod
  • string

VM での状態の変更によって自動修復が中断される時間の長さ。 状態の変更が完了した後に、猶予時間が開始されます。 これは、早すぎるか偶発的な修復を回避するのに役立ちます。 期間は ISO 8601 形式で指定する必要があります。 許容される猶予期間の最小値は30分 (PT30M) です。これは、既定値でもあります。 許容される最大の猶予期間は90分 (PT90M) です。

BillingProfile

Azure スポット VM または VMSS の課金に関連する詳細を指定します。

最小 api バージョン: 2019-03-01。

Name Type Description
maxPrice
  • number

Azure スポット VM/VMSS に対して支払うことができる最大価格を指定します。 この料金は米ドルです。

この料金は、VM サイズの現在の Azure スポット価格と比較されます。 また、Azure スポット VM/VMSS の作成/更新時に価格が比較されます。この操作は、maxPrice が現在の Azure スポット価格よりも大きい場合にのみ成功します。

また、現在の Azure スポット料金が VM/VMSS の作成後に maxPrice を超えた場合に、Azure スポット VM/VMSS を作成するためにも、maxPrice が使用されます。

次のいずれかの値になります。

-0 より大きい10進値。 例: 0.01538

-1 –オンデマンドでの既定の価格を示します。

MaxPrice を-1 に設定すると、Azure スポット VM/VMSS を削除しないことを示すことができます。 また、既定の最大価格は、提供されていない場合は-1 になります。

最小 api バージョン: 2019-03-01。

BootDiagnostics

ブート診断はデバッグ機能であり、コンソール出力とスクリーンショットを表示して VM の状態を診断できます。

コンソール ログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。

Name Type Description
enabled
  • boolean

仮想マシンでブート診断を有効にする必要があるかどうか。

storageUri
  • string

コンソール出力とスクリーンショットを配置するために使用するストレージ アカウントの URI。

ブート診断を有効にしている間に storageUri が指定されていない場合は、マネージド ストレージが使用されます。

CachingTypes

キャッシュの種類を取得します。

Name Type Description
None
  • string
ReadOnly
  • string
ReadWrite
  • string

CapacityReservationProfile

容量予約プロファイルのパラメーター。

Name Type Description
capacityReservationGroup

十分な容量が予約されている場合に、仮想マシンまたはスケールセット vm インスタンスの割り当てに使用する容量予約グループのリソース id を指定します。 詳細については、「」を参照してください https://aka.ms/CapacityReservation

ComponentNames

コンポーネントの名前。 現時点では、許可されている値は、Microsoft Windows の設定のみです。

Name Type Description
Microsoft-Windows-Shell-Setup
  • string

DeleteOptions

VM が削除されたときのネットワークインターフェイスの動作を指定します

Name Type Description
Delete
  • string
Detach
  • string

DiagnosticsProfile

ブート診断設定の状態を指定します。

最小 api バージョン: 2015-06-15。

Name Type Description
bootDiagnostics

ブート診断は、コンソールの出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。
: storageuri が指定されている場合は、ストレージアカウントが VM と同じリージョンおよびサブスクリプションにあることを確認してください。

コンソールログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを確認することもできます。

DiffDiskOptions

オペレーティングシステムディスクの一時ディスク設定を指定します。

Name Type Description
Local
  • string

DiffDiskPlacement

オペレーティングシステムディスクの一時ディスクの配置を指定します。 このプロパティは、一時的な OS ディスクプロビジョニング用のキャッシュディスクまたはリソースディスク領域を選択するために、ユーザーが要求で使用できます。 一時 os のディスクサイズの要件の詳細については、「」の vm https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements と Linux vm の Windows vm の一時 os ディスクサイズ要件を参照してください。https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Name Type Description
CacheDisk
  • string
ResourceDisk
  • string

DiffDiskSettings

オペレーティングシステムディスクに指定できる一時ディスク設定のパラメーターについて説明します。

注: 一時ディスクの設定は、管理ディスクに対してのみ指定できます。

Name Type Description
option

オペレーティングシステムディスクの一時ディスク設定を指定します。

placement

オペレーティングシステムディスクの一時ディスクの配置を指定します。

次のいずれかの値になります。

CacheDisk

Resourcedisk.filesystem

既定値: Cachedisk が VM サイズ用に構成されている場合は、 resourcedisk が使用されます。

https://docs.microsoft.com/azure/virtual-machines/windows/sizes https://docs.microsoft.com/azure/virtual-machines/linux/sizes キャッシュディスクを公開する vm のサイズを確認するには、で vm の Windows vm と Linux vm の vm サイズに関するドキュメントを参照してください。

DiskCreateOptionTypes

仮想マシンの作成方法を指定します。

次のいずれかの値になります。

Attach \u2013 この値は、仮想マシンを作成するために特殊なディスクを使用する場合に使用します。

Fromimage \u2013 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォームイメージを使用する場合は、上で説明した imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

Name Type Description
Attach
  • string
Empty
  • string
FromImage
  • string

DiskEncryptionSetParameters

ディスクに指定できるユーザー管理ディスク暗号化セットリソース id のパラメーターについて説明します。

注: ディスク暗号化セットのリソース id は、管理ディスクに対してのみ指定できます。 詳細については、「」を参照してください https://aka.ms/mdssewithcmkoverview

Name Type Description
id
  • string

リソース ID

ExtendedLocation

拡張位置の複合型。

Name Type Description
name
  • string

拡張された場所の名前。

type

拡張された場所の型。

ExtendedLocationTypes

拡張された場所の型。

Name Type Description
EdgeZone
  • string

ImageReference

使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。 注: イメージ参照パブリッシャーとオファーは、スケール セットを作成するときにのみ設定できます。

Name Type Description
exactVersion
  • string

仮想マシンの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージのバージョンを、10 進数で指定します。 この読み取り専用フィールドは、'version' フィールドに指定された値が 'latest' の場合にのみ、'version' とは異なります。

id
  • string

リソース ID

offer
  • string

仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのオファーを指定します。

publisher
  • string

イメージの発行元。

sharedGalleryImageId
  • string

VM デプロイの共有ギャラリー イメージの一意の ID を指定しました。 これは、共有ギャラリー イメージの GET 呼び出しからフェッチできます。

sku
  • string

イメージ SKU。

version
  • string

仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのバージョンを指定します。 使用できる形式は Major.Minor.Build または 'latest' です。 Major、Minor、Build は 10 進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 "最新" を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ時間後に VM イメージが自動的に更新されません。

IPVersion

Api-Version 2019-07-01 以降で使用できます。これは、特定の ip 構成が IPv4 と IPv6 のどちらであるかを表します。 既定値は IPv4 として取得されます。 指定できる値は ' IPv4 ' と ' IPv6 ' です。

Name Type Description
IPv4
  • string
IPv6
  • string

LinuxConfiguration

仮想マシン上の Linux オペレーティングシステムの設定を指定します。

サポートされている Linux ディストリビューションの一覧については、「 linux on Azure-Endorsed ディストリビューション」を参照してください。

Name Type Description
disablePasswordAuthentication
  • boolean

パスワード認証を無効にするかどうかを指定します。

patchSettings

[プレビュー機能]Linux 上の VM ゲスト修正に関連する設定を指定します。

provisionVMAgent
  • boolean

仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、後で拡張機能を VM に追加できるように、vm エージェントが vm にインストールされるようになります。

ssh

Linux OS の SSH キーの構成を指定します。

LinuxPatchAssessmentMode

IaaS 仮想マシンに対する VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

LinuxPatchSettings

Linux 上の VM ゲスト修正に関連する設定を指定します。

Name Type Description
assessmentMode

IaaS 仮想マシンに対する VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

patchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンの既定の修正プログラム構成が使用されます。

自動 byplatform -仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent は true である必要があります

LinuxVMGuestPatchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンの既定の修正プログラム構成が使用されます。

自動 byplatform -仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent は true である必要があります

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

NetworkApiVersion

は、ネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します

Name Type Description
2020-11-01
  • string

OperatingSystemTypes

OsDiskImage のオペレーティングシステム。

Name Type Description
Linux
  • string
Windows
  • string

OrchestrationMode

仮想マシン スケール セットのオーケストレーション モードを指定します。

Name Type Description
Flexible
  • string
Uniform
  • string

PassNames

パス名。 現時点では、許可されている値は OobeSystem だけです。

Name Type Description
OobeSystem
  • string

PatchSettings

Windows での VM ゲスト修正に関連する設定を指定します。

Name Type Description
assessmentMode

IaaS 仮想マシンに対する VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

enableHotpatching
  • boolean

を使用すると、再起動を必要とせずに Azure Vm に修正プログラムを適用できます。 EnableHotpatching パッチの場合は、' provisionVMAgent ' を true に設定し、' パッチモード ' を ' 自動 Byplatform ' に設定する必要があります。

patchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

次のいずれかの値になります。

手動 -仮想マシンに対する修正プログラムの適用を制御します。 これを行うには、VM 内で手動で修正プログラムを適用します。 このモードでは、自動更新は無効になっています。WindowsConfiguration. Enable自動更新プロパティは false である必要があります

自動 : os によって仮想マシンが自動的に更新されます。 WindowsConfiguration. Enable自動更新プロパティは true である必要があります。

自動 byplatform -仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent と WindowsConfiguration. Enable自動更新は true でなければなりません

Plan

仮想マシンの作成に使用する marketplace イメージに関する情報を指定します。 この要素は、marketplace イメージに対してのみ使用されます。 API から marketplace イメージを使用する前に、プログラムで使用できるようにイメージを有効にする必要があります。 Azure portal で、使用する marketplace イメージを見つけて、[プログラムによる展開、はじめに >] の順にクリックします。 必要な情報を入力し、[ 保存] をクリックします。

Name Type Description
name
  • string

プラン ID。

product
  • string

Marketplace からのイメージの製品を指定します。 これは、imageReference 要素のオファーと同じ値です。

promotionCode
  • string

販売促進コード。

publisher
  • string

発行者 ID。

ProtocolTypes

WinRM リスナーのプロトコルを指定します。

次のいずれかの値になります。
http

ssl

Name Type Description
Http
  • string
Https
  • string

PublicIPAddressSku

パブリック IP Sku について説明します

Name Type Description
name

パブリック IP sku 名を指定します

tier

パブリック IP sku レベルを指定する

PublicIPAddressSkuName

パブリック IP SKU 名を指定する

Name Type Description
Basic
  • string
Standard
  • string

PublicIPAddressSkuTier

パブリック IP SKU レベルを指定する

Name Type Description
Global
  • string
Regional
  • string

ResourceIdentityType

仮想マシンに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、仮想マシンから ID を削除します。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

Name Type Description
enableCrossZoneUpgrade
  • boolean

アップグレード バッチを構築するときに、VMSS が AZ 境界を無視することを許可します。 バッチ サイズを決定するには、Update Domain と maxBatchInstancePercent を考慮してください。

maxBatchInstancePercent
  • integer

ローリング アップグレードによって 1 回のバッチで同時にアップグレードされる仮想マシン インスタンスの合計の最大割合。 これは最大の結果として、以前または将来のバッチの不健康なインスタンスが原因で、バッチ内のインスタンスの割合が低下して信頼性が高くなる可能性があります。 このパラメーターの既定値は 20% です。

maxUnhealthyInstancePercent
  • integer

アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって正常性チェックによって、同時に不健康になる可能性があるスケール セット内の仮想マシン インスタンスの合計の最大割合。 この制約は、バッチを開始する前にチェックされます。 このパラメーターの既定値は 20% です。

maxUnhealthyUpgradedInstancePercent
  • integer

アップグレードされた仮想マシン インスタンスの最大割合が、問題の状態にあると見なされる可能性があります。 このチェックは、各バッチがアップグレードされた後に行います。 この割合を超えた場合、ローリング更新は中止されます。 このパラメーターの既定値は 20% です。

pauseTimeBetweenBatches
  • string

すべての仮想マシンの更新を 1 つのバッチで完了し、次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。

prioritizeUnhealthyInstances
  • boolean

正常なインスタンスの前に、スケール セット内のすべての正常なインスタンスをアップグレードします。

ScaleInPolicy

仮想マシン スケール セットのスケールイン ポリシーについて説明します。

Name Type Description
forceDeletion
  • boolean

このプロパティを使用すると、仮想マシン スケール セットをスケールインするときに、削除用に選択した仮想マシンを強制的に削除する必要がある場合に指定できます。(プレビューの機能)

rules
  • string[]

仮想マシン スケール セットをスケールインするときに従うルール。

次のいずれかの値になります。

既定 仮想マシン スケール セットがスケールインされる場合、スケール セットがゾーン スケール セットの場合は、まずゾーン間でバランスが取されます。 その後、可能な限り、障害ドメイン間でバランスが取されます。 各障害ドメイン内では、削除用に選択された仮想マシンが、スケールインから保護されていない最新の仮想マシンです。

OldestVM 仮想マシン スケール セットがスケールインされている場合、スケールインから保護されていない最も古い仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットはまずゾーン間で分散されます。 各ゾーン内では、保護されていない最も古い仮想マシンが削除用に選択されます。

NewestVM 仮想マシン スケール セットがスケールインされている場合は、スケールインから保護されていない最新の仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットはまずゾーン間で分散されます。 各ゾーン内では、保護されていない最新の仮想マシンが削除用に選択されます。

ScheduledEventsProfile

Name Type Description
terminateNotificationProfile

スケジュールされたイベント関連の構成の終了を指定します。

SecurityProfile

仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。

Name Type Description
encryptionAtHost
  • boolean

このプロパティは、仮想マシンまたは仮想マシンスケールセットのホストの暗号化を有効または無効にする要求でユーザーが使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。

既定: リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。

securityType

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするために TrustedLaunch として設定されています。

既定値: このプロパティが TrustedLaunch として設定されている場合を除き、UefiSettings は有効になりません。

uefiSettings

仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。

最小 api バージョン: 2020-12-01

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch に設定されていない限り、UefiSettings は有効になりません。

Name Type Description
TrustedLaunch
  • string

SettingNames

コンテンツが適用される設定の名前を指定します。 指定できる値は、FirstLogonCommands と自動ログオンです。

Name Type Description
AutoLogon
  • string
FirstLogonCommands
  • string

Sku

仮想マシンスケールセットの sku について説明します。 注: スケールセットが現在存在するハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケールセット内の Vm の割り当てを解除する必要があります。

Name Type Description
capacity
  • integer

スケールセット内の仮想マシンの数を指定します。

name
  • string

Sku の名前。

tier
  • string

スケールセット内の仮想マシンの層を指定します。

有効値は次のとおりです。

Standard

Basic

SpotRestorePolicy

仮想マシン スケール セットの Spot-Try-Restore プロパティを指定します。

このプロパティを使用すると、容量の可用性と価格の制約に基づいて、削除されたスポット VMSS VM インスタンスの自動復元を日和見的に有効または無効にできます。

Name Type Description
enabled
  • boolean

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

restoreTimeout
  • string

プラットフォームが VMSS SPOT インスタンスの復元を試みない ISO 8601 期間として表されるタイムアウト値

SshConfiguration

Azure で実行されている Linux ベースの Vm の SSH 構成

Name Type Description
publicKeys

Linux ベースの Vm での認証に使用される SSH 公開キーの一覧。

SshPublicKey

SSH 証明書の公開キーと、公開キーが配置されている Linux VM のパスに関する情報が含まれています。

Name Type Description
keyData
  • string

Ssh を介して VM で認証するために使用される SSH 公開キー証明書。 キーは、2048ビットと ssh rsa 形式である必要があります。

Ssh キーを作成する方法については、「Azure での Linux Vm 用の Linux および Mac での SSH キーの作成」を参照してください https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed) 。

path
  • string

Ssh 公開キーが格納される、作成された VM の完全なパスを指定します。 ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。 例:/home/user/.ssh/authorized_keys

StorageAccountTypes

管理ディスクのストレージアカウントの種類を指定します。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

Name Type Description
Premium_LRS
  • string
Premium_ZRS
  • string
StandardSSD_LRS
  • string
StandardSSD_ZRS
  • string
Standard_LRS
  • string
UltraSSD_LRS
  • string

SubResource

Name Type Description
id
  • string

リソース ID

TerminateNotificationProfile

Name Type Description
enable
  • boolean

スケジュールされたイベントの終了を有効または無効にするかどうかを指定します。

notBeforeTimeout
  • string

イベントが自動承認 (タイムアウト) になる前に、削除する仮想マシンが、スケジュールされたイベントの終了を承認する必要がある、構成可能な期間。 構成は ISO 8601 形式で指定する必要があります。既定値は5分 (PT5M) です。

UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM のようなセキュリティ設定を指定します。

最小 api-version: 2020-12-01

Name Type Description
secureBootEnabled
  • boolean

仮想マシンでセキュア ブートを有効にするかどうかを指定します。

最小 api-version: 2020-12-01

vTpmEnabled
  • boolean

仮想マシンで vTPM を有効にするかどうかを指定します。

最小 api-version: 2020-12-01

UpgradeMode

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

次のいずれかの値になります。

手動 - スケール セット内の仮想マシンに対する更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

Name Type Description
Automatic
  • string
Manual
  • string
Rolling
  • string

UpgradePolicy

アップグレードポリシー (自動、手動、またはローリング) について説明します。

Name Type Description
automaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

mode

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

次のいずれかの値になります。

手動 -スケールセット内の仮想マシンに対する更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 -スケールセット内のすべての仮想マシンが同時に自動的に更新されます。

rollingUpgradePolicy

ローリングアップグレードの実行中に使用される構成パラメーター。

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID です。

Name Type Description

VaultCertificate

Key Vault 内の1つの証明書参照と、その証明書を VM 上に配置する必要がある場所について説明します。

Name Type Description
certificateStore
  • string

Windows vm の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。 指定された証明書ストアは、暗黙的に LocalMachine アカウントに含まれています。

Linux Vm の場合、証明書ファイルは/var/lib/waagent ディレクトリに配置され、 < > X509 証明書ファイルには UppercaseThumbprint、 < > 秘密キーには UppercaseThumbprint というファイル名が付けられます。 これらのファイルはどちらも、pem 形式です。

certificateUrl
  • string

これは、シークレットとして Key Vault にアップロードされた証明書の URL です。 Key Vault にシークレットを追加する方法については、「キー またはシークレットをキーコンテナーに追加する」を参照してください。 この場合、証明書は、UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data": "Base64 でエンコードされた証明書の <>",
"dataType": "pfx",
"password": "pfx ファイルの <>"
}
仮想マシンに証明書をインストールするには、 Linux 用の Azure Key Vault 仮想マシン拡張機能、またはWindows 用の Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

VaultSecretGroup

すべて同じ Key Vault にある一連の証明書を記述します。

Name Type Description
sourceVault

コンテナーの相対 URL Key Vault VaultCertificates 内のすべての証明書を含む必要があります。

vaultCertificates

証明書を含む SourceVault のキー コンテナー参照の一覧。

VirtualHardDisk

ディスクの uri について説明します。

Name Type Description
uri
  • string

仮想ハードディスクの uri を指定します。

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。

Azure スポット仮想マシンの場合、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは2019-03-01 です。

Azure スポットスケールセットでは、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは 2017-10-30-preview です。

Name Type Description
Deallocate
  • string
Delete
  • string

VirtualMachinePriorityTypes

仮想マシンの優先順位を指定します。

最小 api バージョン: 2019-03-01

Name Type Description
Low
  • string
Regular
  • string
Spot
  • string

VirtualMachineScaleSet

仮想マシンスケールセットについて説明します。

Name Type Description
extendedLocation

仮想マシンスケールセットの拡張された場所。

id
  • string

リソース ID

identity

仮想マシンスケールセットの id (構成されている場合)。

location
  • string

リソースの場所

name
  • string

リソース名

plan

仮想マシンの作成に使用する marketplace イメージに関する情報を指定します。 この要素は、marketplace イメージに対してのみ使用されます。 API から marketplace イメージを使用する前に、プログラムで使用できるようにイメージを有効にする必要があります。 Azure portal で、使用する marketplace イメージを見つけて、[プログラムによる展開、はじめに >] の順にクリックします。 必要な情報を入力し、[ 保存] をクリックします。

properties.additionalCapabilities

仮想マシンスケールセットの Virtual Machines で有効または無効にする追加の機能を指定します。 例: UltraSSD_LRS ストレージアカウントの種類を使用して、管理対象データディスクの接続をサポートする機能が Virtual Machines であるかどうか。

properties.automaticRepairsPolicy

自動修復のポリシー。

properties.doNotRunExtensionsOnOverprovisionedVMs
  • boolean

オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の Vm でのみ起動されます。 そのため、このプロパティによって、追加のオーバープロビジョニングされた Vm で拡張機能が実行されないようにすることができます。

properties.hostGroup

仮想マシンスケールセットが存在する専用のホストグループに関する情報を指定します。

最小 api バージョン: 2020-06-01。

properties.orchestrationMode

仮想マシンスケールセットのオーケストレーションモードを指定します。

properties.overprovision
  • boolean

仮想マシンスケールセットをオーバープロビジョニングする必要があるかどうかを指定します。

properties.platformFaultDomainCount
  • integer

各配置グループの障害ドメインの数。

properties.provisioningState
  • string

応答にのみ表示されるプロビジョニング状態。

properties.proximityPlacementGroup

仮想マシンスケールセットの割り当て先となる近接配置グループに関する情報を指定します。

最小 api バージョン: 2018-04-01。

properties.scaleInPolicy

仮想マシンスケールセットの Virtual Machines をスケーリングするときに適用されるポリシーを指定します。

properties.singlePlacementGroup
  • boolean

True の場合、スケールセットは、最大サイズが100仮想マシンの1つの配置グループに限定されます。 注: Single配置 Ementgroup が true の場合は、false に変更できます。 ただし、singlePlacementGroup が false の場合は、true に変更できません。

properties.spotRestorePolicy

仮想マシンスケールセットのスポット復元プロパティを指定します。

properties.uniqueId
  • string

仮想マシンスケールセットを一意に識別する ID を指定します。

properties.upgradePolicy

アップグレードポリシー。

properties.virtualMachineProfile

仮想マシンプロファイル。

properties.zoneBalance
  • boolean

ゾーンの停止が発生した場合に、厳密に仮想マシンの分散を強制的に実行するかどうか。 zones 均衡プロパティは、スケールセットの zones プロパティに複数のゾーンが含まれている場合にのみ設定できます。 ゾーンが指定されていない場合、またはゾーンが 1 つしか指定されていない場合は、zoneBalance プロパティを設定しないでください。

sku

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

tags
  • object

リソース タグ

type
  • string

リソースの種類

zones
  • string[]

仮想マシンスケールセットのゾーン。 注: 可用性ゾーンは、スケールセットを作成するときにのみ設定できます。

VirtualMachineScaleSetDataDisk

仮想マシン スケール セットのデータ ディスクについて説明します。

Name Type Description
caching

キャッシュの要件を指定します。

次のいずれかの値になります。

なし

ReadOnly

ReadWrite

既定値: Standard ストレージの場合はなし。ストレージの ReadOnly プレミアムする

createOption

create オプション。

diskIOPSReadWrite
  • integer

マネージド ディスクRead-Write IOPS を指定します。 StorageAccountType が指定されている場合にのみ使用UltraSSD_LRS。 指定しない場合、diskSizeGB に基づいて既定値が割り当てられます。

diskMBpsReadWrite
  • integer

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

diskSizeGB
  • integer

空のデータ ディスクのサイズをギガバイト単位で指定します。 この要素は、仮想マシン イメージ内のディスクのサイズを上書きするために使用できます。

この値は 1023 GB より大きくすることはできません

lun
  • integer

データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。

managedDisk

マネージド ディスクのパラメーター。

name
  • string

ディスク名。

writeAcceleratorEnabled
  • boolean

ディスクで writeAccelerator を有効にするか無効にするか指定します。

VirtualMachineScaleSetExtension

仮想マシン スケール セット拡張機能について説明します。

Name Type Description
id
  • string

リソース ID

name
  • string

拡張機能の名前です。

properties.autoUpgradeMinorVersion
  • boolean

展開時に拡張機能が使用可能な場合に、新しいマイナーバージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。

properties.enableAutomaticUpgrade
  • boolean

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

properties.forceUpdateTag
  • string

値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張ハンドラーは強制的に更新されます。

properties.protectedSettings
  • object

拡張機能には、protectedSettings または protectedSettingsFromKeyVault のいずれかを含めることも、保護された設定をまったく含めないこともできます。

properties.provisionAfterExtensions
  • string[]

この拡張機能をプロビジョニングする必要がある後の拡張名のコレクション。

properties.provisioningState
  • string

応答にのみ表示されるプロビジョニング状態。

properties.publisher
  • string

拡張ハンドラーパブリッシャーの名前。

properties.settings
  • object

拡張機能の Json 形式のパブリック設定。

properties.suppressFailures
  • boolean

拡張機能からのエラーのステミングを抑制するかどうかを示します (VM に接続していないなどの操作上のエラーは、この値に関係なく抑制されません)。 既定値は false です。

properties.type
  • string

拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。

properties.typeHandlerVersion
  • string

スクリプトハンドラーのバージョンを指定します。

type
  • string

リソースの種類

VirtualMachineScaleSetExtensionProfile

仮想マシンスケールセット拡張機能のプロファイルについて説明します。

Name Type Description
extensions

仮想マシンスケールセットの子拡張リソース。

extensionsTimeBudget
  • string

すべての拡張機能を開始する時間の alloted を指定します。 期間は15分から120分の範囲で指定する必要があり、ISO 8601 形式で指定する必要があります。 既定値は90分 (PT1H30M) です。

最小 api バージョン: 2020-06-01

VirtualMachineScaleSetIdentity

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

Name Type Description
principalId
  • string

仮想マシンスケールセット id のプリンシパル id。 このプロパティは、システムによって割り当てられた id に対してのみ提供されます。

tenantId
  • string

仮想マシンスケールセットに関連付けられているテナント id。 このプロパティは、システムによって割り当てられた id に対してのみ提供されます。

type

仮想マシンスケールセットに使用される id の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類が ' None ' の場合、仮想マシンスケールセットからすべての id が削除されます。

userAssignedIdentities

仮想マシンスケールセットに関連付けられているユーザー id の一覧。 ユーザー id ディクショナリキー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース id になります。

VirtualMachineScaleSetIPConfiguration

仮想マシンスケールセットのネットワークプロファイルの IP 構成について説明します。

Name Type Description
id
  • string

リソース ID

name
  • string

IP 構成の名前。

properties.applicationGatewayBackendAddressPools

アプリケーションゲートウェイのバックエンドアドレスプールへの参照の配列を指定します。 スケールセットは、複数のアプリケーションゲートウェイのバックエンドアドレスプールを参照できます。 複数のスケールセットで同じアプリケーションゲートウェイを使用することはできません。

properties.applicationSecurityGroups

アプリケーションセキュリティグループへの参照の配列を指定します。

properties.loadBalancerBackendAddressPools

ロードバランサーのバックエンドアドレスプールへの参照の配列を指定します。 スケールセットでは、1つのパブリックおよび1つの内部ロードバランサーのバックエンドアドレスプールを参照できます。 複数のスケールセットで同じ basic sku ロードバランサーを使用することはできません。

properties.loadBalancerInboundNatPools

ロードバランサーの受信 Nat プールへの参照の配列を指定します。 スケールセットでは、1つのパブリックおよび1つの内部ロードバランサーの受信 nat プールを参照できます。 複数のスケールセットで同じ basic sku ロードバランサーを使用することはできません。

properties.primary
  • boolean

仮想マシンに複数のネットワークインターフェイスがある場合に備えて、プライマリネットワークインターフェイスを指定します。

properties.privateIPAddressVersion

Api-Version 2017-03-30 以降で使用できます。これは、特定の ip 構成が IPv4 と IPv6 のどちらであるかを表します。 既定値は IPv4 として取得されます。 指定できる値は ' IPv4 ' と ' IPv6 ' です。

properties.publicIPAddressConfiguration

PublicIPAddressConfiguration。

properties.subnet

サブネットの識別子を指定します。

VirtualMachineScaleSetIpTag

パブリック IP アドレスに関連付けられている IP タグを格納します。

Name Type Description
ipTagType
  • string

IP タグの種類。 例: FirstPartyUsage。

tag
  • string

パブリック IP に関連付けられている IP タグ。 例: SQL、Storageなど。

VirtualMachineScaleSetListResult

バーチャルマシン操作の応答の一覧です。

Name Type Description
nextLink
  • string

Virtual Machine Scale Sets の次のページをフェッチする uri。 このを使用して ListNext () を呼び出し、VMSS の次のページをフェッチします。

value

仮想マシンスケールセットの一覧。

VirtualMachineScaleSetManagedDiskParameters

ScaleSet 管理ディスクのパラメーターについて説明します。

Name Type Description
diskEncryptionSet

管理ディスクのユーザー管理ディスク暗号化セットリソース id を指定します。

storageAccountType

管理ディスクのストレージアカウントの種類を指定します。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

VirtualMachineScaleSetNetworkConfiguration

仮想マシン スケール セットのネットワーク プロファイルのネットワーク構成について説明します。

Name Type Description
id
  • string

リソース ID

name
  • string

ネットワーク構成名。

properties.deleteOption

VM が削除された場合のネットワーク インターフェイスの実行を指定する

properties.dnsSettings

ネットワーク インターフェイスに適用される DNS 設定。

properties.enableAcceleratedNetworking
  • boolean

ネットワーク インターフェイスが高速ネットワーク対応かどうかを指定します。

properties.enableFpga
  • boolean

ネットワーク インターフェイスが FPGA ネットワーク対応かどうかを指定します。

properties.enableIPForwarding
  • boolean

この NIC で IP 転送が有効になっているかどうか。

properties.ipConfigurations

ネットワーク インターフェイスの IP 構成を指定します。

properties.networkSecurityGroup

ネットワーク セキュリティ グループ。

properties.primary
  • boolean

仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合に備え、プライマリ ネットワーク インターフェイスを指定します。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

仮想マシンスケールセットのネットワーク構成の DNS 設定について説明します。

Name Type Description
dnsServers
  • string[]

DNS サーバーの IP アドレスの一覧

VirtualMachineScaleSetNetworkProfile

仮想マシンスケールセットのネットワークプロファイルについて説明します。

Name Type Description
healthProbe

仮想マシンスケールセット内のインスタンスの正常性を判断するために使用されるロードバランサープローブへの参照。 参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName} ' という形式になります。

networkApiVersion

オーケストレーションモード "柔軟" を使用して、仮想マシンスケールセットのネットワークインターフェイス構成でネットワークリソースを作成するときに使用される、Microsoft ネットワーク API バージョンを指定します。

networkInterfaceConfigurations

ネットワーク構成の一覧。

VirtualMachineScaleSetOSDisk

仮想マシン スケール セットのオペレーティング システム ディスクについて説明します。

Name Type Description
caching

キャッシュの要件を指定します。

次のいずれかの値になります。

なし

ReadOnly

ReadWrite

既定値: Standard ストレージの場合はなし。ストレージの ReadOnly プレミアムする

createOption

スケール セット内の仮想マシンを作成する方法を指定します。

使用できる値は FromImage \u2013 のみです。この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、前述の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明したプラン要素も使用します。

diffDiskSettings

仮想マシン スケール セットで設定オペレーティング システム ディスクのエフェメラル ディスクを指定します。

diskSizeGB
  • integer

オペレーティング システム ディスクのサイズをギガバイト単位で指定します。 この要素は、仮想マシン イメージ内のディスクのサイズを上書きするために使用できます。

この値は 1023 GB より大きくすることはできません

image

スケール セットの基にするアンマネージド ユーザー イメージに関する情報を指定します。

managedDisk

マネージド ディスクのパラメーター。

name
  • string

ディスク名。

osType

このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。

次のいずれかの値になります。

Windows

Linux

vhdContainers
  • string[]

スケール セットのオペレーティング システム ディスクを格納するために使用するコンテナー URL を指定します。

writeAcceleratorEnabled
  • boolean

ディスクで writeAccelerator を有効にするか無効にするか指定します。

VirtualMachineScaleSetOSProfile

仮想マシン スケール セットの OS プロファイルについて説明します。

Name Type Description
adminPassword
  • string

管理者アカウントのパスワードを指定します。

最小長 (Windows): 8 文字

最小長 (Linux): 6 文字

最大長 (Windows): 123 文字

最大長 (Linux): 72 文字

複雑さの要件: 以下の4つの条件のうち3つを満たす必要があります。
に小さい文字がある
上限文字がある
に数字が含まれています
に特殊文字があります (Regex match [\ W_])

許可されていない 値:" abc@123 "、"P@ $ $w 0rd"、" P@ssw0rd "、" P@ssword123 "、"Pa $ $word"、" pass@word1 "、"Password!"、"Password1"、"Password22"、"iloveyou!"

パスワードをリセットする方法については、「 Windows VM でリモートデスクトップサービスまたはそのログインパスワードをリセットする方法」を参照してください。

ルートパスワードをリセットする方法については、「 VMAccess 拡張機能を使用した Azure Linux vm 上のユーザーの管理、SSH、およびディスクのチェックまたは修復」を参照してください。

adminUsername
  • string

管理者アカウントの名前を指定します。

Windows制限: "." で終えできません。

[許可されません] の値: "administrator"、"admin"、"user"、"user1"、"test"、"user2"、"test1"、"user3"、"admin1"、 "1"、"123"、"a"、"actuser"、"adm"、"admin2"、"aspnet"、"backup"、"console"、"david"、"guest"、"john"、"owner"、"root"、"server"、"sql"、"support"、"support_388945a0"、"sys"、"test3"、"test3"、"user4"、"user"

最小長 (Linux): 1 文字

最大長 (Linux): 64 文字

最大長 (Windows): 20 文字

computerNamePrefix
  • string

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

customData
  • string

カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。

VM に対して cloud-init を使用する場合は、「 cloud-init を使用して作成時に LINUX VM をカスタマイズする」を参照してください。

linuxConfiguration

仮想マシン上の Linux オペレーティングシステムの設定を指定します。

サポートされている Linux ディストリビューションの一覧については、「 linux on Azure-Endorsed ディストリビューション」を参照してください。

secrets

スケールセット内の仮想マシンにインストールする必要がある証明書のセットを指定します。 仮想マシンに証明書をインストールするには、 Linux 用の Azure Key Vault 仮想マシン拡張機能、またはWindows 用の Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

windowsConfiguration

仮想マシン上の Windows オペレーティング システムの設定を指定します。

VirtualMachineScaleSetPublicIPAddressConfiguration

仮想マシンスケールセットの IP 構成の PublicIPAddress 構成について説明します。

Name Type Description
name
  • string

パブリック Ip アドレスの構成名。

properties.deleteOption

VM が削除されたときにパブリック IP に対して何が起こるかを指定します

properties.dnsSettings

パブリック Ip アドレスに適用される dns 設定。

properties.idleTimeoutInMinutes
  • integer

パブリック IP アドレスのアイドルタイムアウト。

properties.ipTags

パブリック IP アドレスに関連付けられている IP タグの一覧。

properties.publicIPAddressVersion

Api-Version 2019-07-01 以降で使用できます。これは、特定の ip 構成が IPv4 と IPv6 のどちらであるかを表します。 既定値は IPv4 として取得されます。 指定できる値は ' IPv4 ' と ' IPv6 ' です。

properties.publicIPPrefix

パブリック Ip アドレスの割り当て元となる PublicIPPrefix。

sku

パブリック IP Sku について説明します

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

仮想マシンスケールセットのネットワーク構成の DNS 設定について説明します。

Name Type Description
domainNameLabel
  • string

ドメイン名ラベル。ドメイン名ラベルと vm インデックスを連結すると、作成される PublicIPAddress リソースのドメイン名ラベルになります。

VirtualMachineScaleSetStorageProfile

仮想マシンスケールセットのストレージプロファイルについて説明します。

Name Type Description
dataDisks

スケールセット内の仮想マシンにデータディスクを追加するために使用されるパラメーターを指定します。

ディスクの詳細については、「 Azure virtual machines のディスクと Vhd について」を参照してください。

imageReference

使用するイメージに関する情報を指定します。 プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージに関する情報を指定できます。 この要素は、プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージを使用するが、他の作成操作では使用しない場合に必要です。

osDisk

スケールセット内の仮想マシンによって使用されるオペレーティングシステムディスクに関する情報を指定します。

ディスクの詳細については、「 Azure virtual machines のディスクと Vhd について」を参照してください。

VirtualMachineScaleSetVMProfile

仮想マシンスケールセットの仮想マシンプロファイルについて説明します。

Name Type Description
applicationProfile

VM/VMSS で使用できるギャラリー アプリケーションを指定します

billingProfile

Azure スポット VMSS の課金関連の詳細を指定します。

最小 api-version: 2019-03-01。

capacityReservation

スケール セットの容量予約関連の詳細を指定します。

最小 api-version: 2021-04-01。

diagnosticsProfile

ブート診断設定の状態を指定します。

最小 api-version: 2015-06-15。

evictionPolicy

Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。

Azure スポット仮想マシンの場合、'Deallocate' と 'Delete' の両方がサポートされ、api-version の最小バージョンは 2019-03-01 です。

Azure スポット スケール セットの場合、'Deallocate' と 'Delete' の両方がサポートされ、api-version の最小バージョンは 2017-10-30-preview です。

extensionProfile

スケール セット内の仮想マシンにインストールされる拡張機能の設定のコレクションを指定します。

licenseType
  • string

使用されているイメージまたはディスクがオンプレミスでライセンスされたと指定します。

Windows Server オペレーティング システムで使用できる値は次のとおりです。

Windows_Client

Windows_Server

Linux Server オペレーティング システムで使用できる値は次のとおりです。

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

詳細については、「Azure Hybrid Use Benefit for Windows Server」を参照してください。

Linux Server 向け Azure ハイブリッド使用特典

最小 api-version: 2015-06-15

networkProfile

スケール セット内の仮想マシンのネットワーク インターフェイスのプロパティを指定します。

osProfile

スケールセット内の仮想マシンのオペレーティングシステム設定を指定します。

priority

スケール セット内の仮想マシンの優先順位を指定します。

最小 api-version: 2017-10-30-preview

scheduledEventsProfile

スケジュールされたイベント関連の構成を指定します。

securityProfile

スケール セット内の仮想マシンのセキュリティ関連プロファイル設定を指定します。

storageProfile

仮想マシンのストレージ設定を指定します。

userData
  • string

スケール セット内の仮想マシンの UserData。Base-64 でエンコードする必要があります。 お客様は、ここにシークレットを渡さ " を行う必要があります。

最小 api-version: 2021-03-01

VMGalleryApplication

コンピューティングギャラリーアプリケーションのバージョンを参照するために必要な情報を指定します

Name Type Description
configurationReference
  • string

省略可能。指定されている場合、パッケージの既定の構成を置き換える azure blob への uri を指定します。

order
  • integer

省略可能。パッケージをインストールする順序を指定します。

packageReferenceId
  • string

/Subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} の形式で GalleryApplicationVersion リソース id を指定します。

tags
  • string

省略可能で、より汎用的なコンテキストのパススルー値を指定します。

WindowsConfiguration

仮想マシン上の Windows オペレーティング システムの設定を指定します。

Name Type Description
additionalUnattendContent

Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。

enableAutomaticUpdates
  • boolean

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

仮想マシンスケールセットの場合、このプロパティは更新でき、更新は OS 再プロビジョニングで有効になります。

patchSettings

[プレビュー機能]Windows での VM ゲスト修正に関連する設定を指定します。

provisionVMAgent
  • boolean

仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、後で拡張機能を VM に追加できるように、vm エージェントが vm にインストールされるようになります。

timeZone
  • string

仮想マシンのタイムゾーンを指定します。 例: "太平洋標準時"。

指定できる値は、 TimeZoneInfoによって返されるタイムゾーンの値をTimeZoneInfo.Idことができます。

winRM

Windows リモート管理リスナーを指定します。 これによって、リモートの Windows PowerShell が有効になります。

WindowsPatchAssessmentMode

IaaS 仮想マシンに対する VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

WindowsVMGuestPatchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

次のいずれかの値になります。

手動 -仮想マシンに対する修正プログラムの適用を制御します。 これを行うには、VM 内で手動で修正プログラムを適用します。 このモードでは、自動更新は無効になっています。WindowsConfiguration. Enable自動更新プロパティは false である必要があります

自動 : os によって仮想マシンが自動的に更新されます。 WindowsConfiguration. Enable自動更新プロパティは true である必要があります。

自動 byplatform -仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent と WindowsConfiguration. Enable自動更新は true でなければなりません

Name Type Description
AutomaticByOS
  • string
AutomaticByPlatform
  • string
Manual
  • string

WinRMConfiguration

VM の構成 Windows リモート管理について説明します。

Name Type Description
listeners

Windows リモート管理リスナーの一覧

WinRMListener

Windows リモート管理リスナーのプロトコルと拇印について説明します。

Name Type Description
certificateUrl
  • string

これは、シークレットとして Key Vault にアップロードされた証明書の URL です。 Key Vault にシークレットを追加する方法については、「キー またはシークレットをキーコンテナーに追加する」を参照してください。 この場合、証明書は、UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data": "Base64 でエンコードされた証明書の <>",
"dataType": "pfx",
"password": "pfx ファイルの <>"
}
仮想マシンに証明書をインストールするには、 Linux 用の Azure Key Vault 仮想マシン拡張機能、またはWindows 用の Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

protocol

WinRM リスナーのプロトコルを指定します。

次のいずれかの値になります。
http

ssl