Virtual Machine Scale Sets - Get

仮想マシン スケール セットに関する情報を表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2021-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2021-03-01&$expand=userData

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

vmScaleSetName
path True
  • string

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

api-version
query True
  • string

クライアント API のバージョン。

$expand
query

操作に適用する expand 式。 'UserData' は、VM スケール セットの作成/更新操作中にユーザーによって提供された VM スケール セットの UserData プロパティを取得します

応答

Name Type Description
200 OK

OK

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

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

Scopes

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

Get a virtual machine scale set placed on a dedicated host group through automatic placement.
Get a virtual machine scale set with UserData

Get a virtual machine scale set placed on a dedicated host group through automatic placement.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2021-03-01&$expand=userData

Sample Response

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

Get a virtual machine scale set with UserData

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet?api-version=2021-03-01&$expand=userData

Sample Response

{
  "name": "myVirtualMachineScaleSet",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "sku": {
    "name": "Standard_D2s_v3",
    "tier": "Standard",
    "capacity": 4
  },
  "properties": {
    "singlePlacementGroup": false,
    "upgradePolicy": {
      "mode": "Automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": false
      }
    },
    "virtualMachineProfile": {
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS"
          },
          "diskSizeGB": 30
        },
        "imageReference": {
          "publisher": "azuredatabricks",
          "offer": "databricks",
          "sku": "databricksworker",
          "version": "3.15.2"
        },
        "dataDisks": []
      },
      "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
      "osProfile": {
        "computerNamePrefix": "myVirtualMachineScaleSet",
        "adminUsername": "admin",
        "linuxConfiguration": {
          "disablePasswordAuthentication": false
        }
      },
      "networkProfile": {
        "networkInterfaceConfigurations": [
          {
            "name": "myNic",
            "properties": {
              "primary": true,
              "ipConfigurations": [
                {
                  "name": "myIPConfig",
                  "properties": {
                    "primary": true,
                    "subnet": {
                      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
              }
            }
          }
        ]
      }
    },
    "provisioningState": "succeeded",
    "overprovision": false,
    "doNotRunExtensionsOnOverprovisionedVMs": false,
    "platformFaultDomainCount": 1,
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    }
  }
}

定義

AdditionalCapabilities

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

AdditionalUnattendContent

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

ApiEntityReference

API エンティティ参照。

AutomaticOSUpgradePolicy

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

AutomaticRepairsPolicy

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

BillingProfile

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

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

BootDiagnostics

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

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

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

CachingTypes

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

ComponentNames

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

DeleteOptions

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

DiagnosticsProfile

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

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

DiffDiskOptions

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

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが場所 (エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスクまたはリソース ディスク領域) を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、 で Windows VM と Linux VM のエフェメラル OS ディスク サイズ要件に関 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements するページを参照してください。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 、こちらをご覧ください。

ExpandTypesForGetVMScaleSets

操作に適用する expand 式。 'UserData' は、VM スケール セットの作成/更新操作中にユーザーによって提供された VM スケール セットの UserData プロパティを取得します

ExtendedLocation

拡張された場所の複合型。

ExtendedLocationTypes

拡張された場所の型。

ImageReference

使用するイメージに関する情報を指定します。 プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージに関する情報を指定できます。 この要素は、プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージを使用するが、他の作成操作では使用しない場合に必要です。 注: イメージ参照の発行元と提供プランは、スケールセットを作成するときにのみ設定できます。

IPVersion

Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 として使用されます。 指定できる値は、'IPv4' と 'IPv6' です。

LinuxConfiguration

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

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

LinuxPatchAssessmentMode

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

指定できる値は次のとおりです。

ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。

AutomaticByPlatform - プラットフォームによって定期的なパッチ評価がトリガーされます。 プロパティ provisionVMAgent は true である必要があります。

LinuxPatchSettings

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

LinuxVMGuestPatchMode

OrchestrationMode をフレキシブルとして使用して、仮想マシン スケール セットに関連付けられている IaaS 仮想マシンまたは仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

指定できる値は次のとおりです。

ImageDefault - 仮想マシンの既定のパッチ適用構成が使用されます。

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

NetworkApiVersion

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

OperatingSystemTypes

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

OrchestrationMode

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

PassNames

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

PatchSettings

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

Plan

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

ProtocolTypes

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

指定できる値は次のとおりです。
http

https

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 の割り当てを割り当てない必要があります。

SshConfiguration

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

SshPublicKey

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

StorageAccountTypes

マネージド ディスクのストレージ アカウントの種類を指定します。 マネージド OS ディスク ストレージ アカウントの種類は、スケール セットを作成するときにのみ設定できます。 注: UltraSSD_LRSディスクでのみ使用できる場合、OS ディスクでは使用できません。

SubResource
TerminateNotificationProfile
UefiSettings

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

最小 api バージョン: 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 タグを格納します。

VirtualMachineScaleSetManagedDiskParameters

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

VirtualMachineScaleSetNetworkConfiguration

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

VirtualMachineScaleSetNetworkConfigurationDnsSettings

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

VirtualMachineScaleSetNetworkProfile

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

VirtualMachineScaleSetOSDisk

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

VirtualMachineScaleSetOSProfile

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

VirtualMachineScaleSetPublicIPAddressConfiguration

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

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

VirtualMachineScaleSetStorageProfile

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

VirtualMachineScaleSetVMProfile

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

WindowsConfiguration

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

WindowsPatchAssessmentMode

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

指定できる値は次のとおりです。

ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。

AutomaticByPlatform - プラットフォームによって定期的なパッチ評価がトリガーされます。 プロパティ provisionVMAgent は true である必要があります。

WindowsVMGuestPatchMode

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

指定できる値は次のとおりです。

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

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

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

WinRMConfiguration

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

WinRMListener

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

AdditionalCapabilities

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

Name Type Description
ultraSSDEnabled
  • boolean

VM または VMSS 上のストレージ アカウントの種類が UltraSSD_LRS マネージド データ ディスクを持つ機能を有効または無効にするフラグ。 ストレージ アカウントの種類が 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

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

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 の状態を診断できるデバッグ機能です。

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

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

DiffDiskOptions

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

Name Type Description
Local
  • string

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが場所 (エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスクまたはリソース ディスク領域) を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、 で Windows VM と Linux VM のエフェメラル OS ディスク サイズ要件に関 https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements するページを参照してください。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

ExpandTypesForGetVMScaleSets

操作に適用する expand 式。 'UserData' は、VM スケール セットの作成/更新操作中にユーザーによって提供された VM スケール セットの UserData プロパティを取得します

Name Type Description
userData
  • string

ExtendedLocation

拡張された場所の複合型。

Name Type Description
name
  • string

拡張された場所の名前。

type

拡張された場所の型。

ExtendedLocationTypes

拡張された場所の型。

Name Type Description
EdgeZone
  • string

ImageReference

使用するイメージに関する情報を指定します。 プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージに関する情報を指定できます。 この要素は、プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージを使用するが、他の作成操作では使用しない場合に必要です。 注: イメージ参照の発行元と提供プランは、スケールセットを作成するときにのみ設定できます。

Name Type Description
exactVersion
  • string

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

id
  • string

リソース Id

offer
  • string

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

publisher
  • string

イメージの発行元。

sku
  • string

イメージ SKU。

version
  • string

仮想マシンの作成に使用されるプラットフォームイメージまたは marketplace イメージのバージョンを指定します。 使用できる形式は、Major. Minor. Build または ' latest ' です。 メジャー、マイナー、およびビルドは10進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 "Latest" を使用する場合でも、新しいバージョンが使用可能になった場合でも、デプロイ時に VM イメージが自動的に更新されることはありません。

IPVersion

Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が 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 - 仮想マシンでのパッチ評価のタイミングを制御します。

AutomaticByPlatform - プラットフォームによって定期的なパッチ評価がトリガーされます。 プロパティ 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 - 仮想マシンの既定のパッチ適用構成が使用されます。

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

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

NetworkApiVersion

ネットワークインターフェイスの構成でネットワークリソースを作成するときに使用される、Microsoft ネットワーク 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 イメージにのみ使用されます。 API から Marketplace イメージを使用する前に、プログラムで使用するイメージを有効にする必要があります。 次のAzure portal、使用するマーケットプレース イメージを見つけて、[プログラムで展開する] をクリックし、[ - はじめに ] を>。 必要な情報を入力し、[保存] を クリックします

Name Type Description
name
  • string

プラン ID。

product
  • string

マーケットプレースのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。

promotionCode
  • string

販売促進コード。

publisher
  • string

発行元 ID。

ProtocolTypes

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

指定できる値は次のとおりです。
http

https

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

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

マネージド ディスクのストレージ アカウントの種類を指定します。 マネージド OS ディスク ストレージ アカウントの種類は、スケール セットを作成するときにのみ設定できます。 注: 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 バージョン: 2020-12-01

Name Type Description
secureBootEnabled
  • boolean

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

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

vTpmEnabled
  • boolean

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

最小 api バージョン: 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

.Vaultcertificates のすべての証明書を含む Key Vault の相対 URL。

vaultCertificates

証明書を含む SourceVault 内の key vault 参照の一覧。

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 イメージにのみ使用されます。 API から Marketplace イメージを使用する前に、プログラムで使用するイメージを有効にする必要があります。 次のAzure portal、使用するマーケットプレース イメージを見つけて、[プログラムで展開する] をクリックし、[ - はじめに ] を>。 必要な情報を入力し、[保存] を クリックします

properties.additionalCapabilities

仮想マシン スケール セット内のVirtual Machines有効または無効にする追加の機能を指定します。 たとえば、ストレージ アカウントの種類Virtual Machinesマネージド データ ディスクのアタッチをサポートする機能がUltraSSD_LRSかどうかなどです。

properties.automaticRepairsPolicy

自動修復のポリシー。

properties.doNotRunExtensionsOnOverprovisionedVMs
  • boolean

オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、過剰にプロビジョニングされた余分な VM で拡張機能が実行されません。

properties.hostGroup

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

最小 api-version: 2020-06-01。

properties.orchestrationMode

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

properties.overprovision
  • boolean

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

properties.platformFaultDomainCount
  • integer

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

properties.provisioningState
  • string

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

properties.proximityPlacementGroup

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

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

properties.scaleInPolicy

仮想マシン スケール セットのスケールイン時に削除する仮想マシンを決定するスケールイン ポリシーを指定します。

properties.singlePlacementGroup
  • boolean

true の場合、スケール セットは 1 つの配置グループ (最大サイズ 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更される可能性があります。 ただし、singlePlacementGroup が false の場合は、true に変更できません。

properties.uniqueId
  • string

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

properties.upgradePolicy

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

properties.virtualMachineProfile

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

properties.zoneBalance
  • boolean

ゾーンが停止した場合に備え、仮想マシンの分散を厳密に x ゾーン間で強制的に行うかどうか。

sku

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

tags
  • object

リソース タグ

type
  • string

リソースの種類

zones
  • string[]

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

VirtualMachineScaleSetDataDisk

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

Name Type Description
caching

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

指定できる値は次のとおりです。

なし

ReadOnly

ReadWrite

既定値は 、Standard storage の場合は None です。プレミアムストレージの読み取り専用

createOption

Create オプション。

diskIOPSReadWrite
  • integer

管理ディスクの Read-Write IOPS を指定します。 StorageAccountType が UltraSSD_LRS 場合にのみ使用してください。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。

diskMBpsReadWrite
  • integer

管理ディスクの帯域幅 (MB/秒) を指定します。 StorageAccountType が UltraSSD_LRS 場合にのみ使用してください。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。

diskSizeGB
  • integer

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

この値は 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.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など。

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

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

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 storage の場合は None です。プレミアムストレージの読み取り専用

createOption

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

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

diffDiskSettings

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

diskSizeGB
  • integer

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

この値は 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 つの条件を満たす必要があります
文字が低い
大文字を含む
数字を持つ
特殊文字を持つ (正規表現一致 [\W_])

[許可されません] の値: " abc@123 ", "P@$$w 0rd", P@ssw0rd " P@ssword123 ", " ", "Pa$$word", " pass@word1 ", "Password!", "Password1", "Password22", "iloveyou!"

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

ルート パスワードのリセットについては、「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

publicIP アドレス構成名。

properties.deleteOption

VM が削除された場合のパブリック IP の実行を指定する

properties.dnsSettings

publicIP アドレス に適用される DNS 設定。

properties.idleTimeoutInMinutes
  • integer

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

properties.ipTags

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

properties.publicIPAddressVersion

Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 として使用されます。 指定できる値は、'IPv4' と 'IPv6' です。

properties.publicIPPrefix

publicIP アドレスの割り当てに使用する 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
billingProfile

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

最小 api-version: 2019-03-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

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 - 仮想マシンでのパッチ評価のタイミングを制御します。

AutomaticByPlatform - プラットフォームによって定期的なパッチ評価がトリガーされます。 プロパティ provisionVMAgent は true である必要があります。

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

WindowsVMGuestPatchMode

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

指定できる値は次のとおりです。

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

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

AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。 provisionVMAgent プロパティと WindowsConfiguration.enableAutomaticUpdates プロパティは 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":"",
"dataType":"pfx",
"password":""
}
仮想マシンに証明書をインストールするには、Linux用の Azure Key Vault 仮想マシン拡張機能を使用するか、 の場合はAzure Key Vault 仮想マシン拡張機能を使用Windows。

protocol

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

指定できる値は次のとおりです。
http

https