Microsoft.Compute virtualMachineScaleSets 2021-03-01

Bicep リソース定義

virtualMachineScaleSets リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Compute/virtualMachineScaleSets リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets@2021-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
  }
  properties: {
    additionalCapabilities: {
      ultraSSDEnabled: bool
    }
    automaticRepairsPolicy: {
      enabled: bool
      gracePeriod: 'string'
    }
    doNotRunExtensionsOnOverprovisionedVMs: bool
    hostGroup: {
      id: 'string'
    }
    orchestrationMode: 'string'
    overprovision: bool
    platformFaultDomainCount: int
    proximityPlacementGroup: {
      id: 'string'
    }
    scaleInPolicy: {
      rules: [
        'string'
      ]
    }
    singlePlacementGroup: bool
    upgradePolicy: {
      automaticOSUpgradePolicy: {
        disableAutomaticRollback: bool
        enableAutomaticOSUpgrade: bool
      }
      mode: 'string'
      rollingUpgradePolicy: {
        enableCrossZoneUpgrade: bool
        maxBatchInstancePercent: int
        maxUnhealthyInstancePercent: int
        maxUnhealthyUpgradedInstancePercent: int
        pauseTimeBetweenBatches: 'string'
        prioritizeUnhealthyInstances: bool
      }
    }
    virtualMachineProfile: {
      billingProfile: {
        maxPrice: json('decimal-as-string')
      }
      diagnosticsProfile: {
        bootDiagnostics: {
          enabled: bool
          storageUri: 'string'
        }
      }
      evictionPolicy: 'string'
      extensionProfile: {
        extensions: [
          {
            name: 'string'
            properties: {
              autoUpgradeMinorVersion: bool
              enableAutomaticUpgrade: bool
              forceUpdateTag: 'string'
              protectedSettings: any()
              provisionAfterExtensions: [
                'string'
              ]
              publisher: 'string'
              settings: any()
              type: 'string'
              typeHandlerVersion: 'string'
            }
          }
        ]
        extensionsTimeBudget: 'string'
      }
      licenseType: 'string'
      networkProfile: {
        healthProbe: {
          id: 'string'
        }
        networkApiVersion: '2020-11-01'
        networkInterfaceConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              deleteOption: 'string'
              dnsSettings: {
                dnsServers: [
                  'string'
                ]
              }
              enableAcceleratedNetworking: bool
              enableFpga: bool
              enableIPForwarding: bool
              ipConfigurations: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    applicationGatewayBackendAddressPools: [
                      {
                        id: 'string'
                      }
                    ]
                    applicationSecurityGroups: [
                      {
                        id: 'string'
                      }
                    ]
                    loadBalancerBackendAddressPools: [
                      {
                        id: 'string'
                      }
                    ]
                    loadBalancerInboundNatPools: [
                      {
                        id: 'string'
                      }
                    ]
                    primary: bool
                    privateIPAddressVersion: 'string'
                    publicIPAddressConfiguration: {
                      name: 'string'
                      properties: {
                        deleteOption: 'string'
                        dnsSettings: {
                          domainNameLabel: 'string'
                        }
                        idleTimeoutInMinutes: int
                        ipTags: [
                          {
                            ipTagType: 'string'
                            tag: 'string'
                          }
                        ]
                        publicIPAddressVersion: 'string'
                        publicIPPrefix: {
                          id: 'string'
                        }
                      }
                      sku: {
                        name: 'string'
                        tier: 'string'
                      }
                    }
                    subnet: {
                      id: 'string'
                    }
                  }
                }
              ]
              networkSecurityGroup: {
                id: 'string'
              }
              primary: bool
            }
          }
        ]
      }
      osProfile: {
        adminPassword: 'string'
        adminUsername: 'string'
        computerNamePrefix: 'string'
        customData: 'string'
        linuxConfiguration: {
          disablePasswordAuthentication: bool
          patchSettings: {
            assessmentMode: 'string'
            patchMode: 'string'
          }
          provisionVMAgent: bool
          ssh: {
            publicKeys: [
              {
                keyData: 'string'
                path: 'string'
              }
            ]
          }
        }
        secrets: [
          {
            sourceVault: {
              id: 'string'
            }
            vaultCertificates: [
              {
                certificateStore: 'string'
                certificateUrl: 'string'
              }
            ]
          }
        ]
        windowsConfiguration: {
          additionalUnattendContent: [
            {
              componentName: 'Microsoft-Windows-Shell-Setup'
              content: 'string'
              passName: 'OobeSystem'
              settingName: 'string'
            }
          ]
          enableAutomaticUpdates: bool
          patchSettings: {
            assessmentMode: 'string'
            enableHotpatching: bool
            patchMode: 'string'
          }
          provisionVMAgent: bool
          timeZone: 'string'
          winRM: {
            listeners: [
              {
                certificateUrl: 'string'
                protocol: 'string'
              }
            ]
          }
        }
      }
      priority: 'string'
      scheduledEventsProfile: {
        terminateNotificationProfile: {
          enable: bool
          notBeforeTimeout: 'string'
        }
      }
      securityProfile: {
        encryptionAtHost: bool
        securityType: 'TrustedLaunch'
        uefiSettings: {
          secureBootEnabled: bool
          vTpmEnabled: bool
        }
      }
      storageProfile: {
        dataDisks: [
          {
            caching: 'string'
            createOption: 'string'
            diskIOPSReadWrite: int
            diskMBpsReadWrite: int
            diskSizeGB: int
            lun: int
            managedDisk: {
              diskEncryptionSet: {
                id: 'string'
              }
              storageAccountType: 'string'
            }
            name: 'string'
            writeAcceleratorEnabled: bool
          }
        ]
        imageReference: {
          id: 'string'
          offer: 'string'
          publisher: 'string'
          sku: 'string'
          version: 'string'
        }
        osDisk: {
          caching: 'string'
          createOption: 'string'
          diffDiskSettings: {
            option: 'Local'
            placement: 'string'
          }
          diskSizeGB: int
          image: {
            uri: 'string'
          }
          managedDisk: {
            diskEncryptionSet: {
              id: 'string'
            }
            storageAccountType: 'string'
          }
          name: 'string'
          osType: 'string'
          vhdContainers: [
            'string'
          ]
          writeAcceleratorEnabled: bool
        }
      }
      userData: 'string'
    }
    zoneBalance: bool
  }
  zones: [
    'string'
  ]
}

プロパティ値

virtualMachineScaleSets

名前 説明
name リソース名 string (必須)

文字制限: 1 から 15 (Windows)
1-64 (Linux)



有効な文字:
スペース、制御文字、または次の文字は使用できません:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

アンダースコアで開始することはできません。 末尾をピリオドまたはハイフンにすることはできません。
location リソースの場所 string (必須)
tags リソース タグ タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku 仮想マシン スケール セット SKU。 SKU
extendedLocation 仮想マシン スケール セットの拡張された場所。 ExtendedLocation
identity 構成されている場合は、仮想マシン スケール セットの ID。 VirtualMachineScaleSetIdentity
plan 仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする]、[作業の開始] の順>にクリックします。 必要な情報を入力し、[ 保存] をクリックします。 プラン
properties 仮想マシン スケール セットのプロパティについて説明します。 VirtualMachineScaleSetProperties
ゾーン 仮想マシン スケール セット ゾーン。 注: 可用性ゾーンは、スケール セットを作成するときにのみ設定できます string[]

ExtendedLocation

名前 説明
name 拡張場所の名前。 string
type 拡張された場所の型。 'EdgeZone'

VirtualMachineScaleSetIdentity

名前 説明
type 仮想マシン スケール セットに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシン スケール セットから ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities 仮想マシン スケール セットに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 VirtualMachineScaleSetIdentityUserAssignedIdentities

VirtualMachineScaleSetIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} VirtualMachineScaleSetIdentityUserAssignedIdentities...

VirtualMachineScaleSetIdentityUserAssignedIdentities...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

プラン

名前 説明
name プラン ID。 string
product マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 string
promotionCode 販売促進コード。 string
publisher 発行元 ID。 string

VirtualMachineScaleSetProperties

名前 説明
additionalCapabilities 仮想マシン スケール セットのVirtual Machinesで有効または無効にされる追加機能を指定します。 たとえば、ストレージ アカウントの種類を持つマネージド データ ディスクのアタッチをサポートする機能がVirtual MachinesにあるかどうかUltraSSD_LRS。 AdditionalCapabilities
automaticRepairsPolicy 自動修復のポリシー。 AutomaticRepairsPolicy
doNotRunExtensionsOnOverprovisionedVMs オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。 [bool]
hostGroup 仮想マシン スケール セットが存在する専用ホスト グループに関する情報を指定します。

最小 api-version: 2020-06-01。
サブリソース
orchestrationMode 仮想マシン スケール セットのオーケストレーション モードを指定します。 'フレキシブル'
'Uniform'
overprovision 仮想マシン スケール セットをオーバープロビジョニングするかどうかを指定します。 [bool]
platformFaultDomainCount 各配置グループの障害ドメイン数。 INT
proximityPlacementGroup 仮想マシン スケール セットを割り当てる必要がある近接配置グループに関する情報を指定します。

最小 api-version: 2018-04-01。
サブリソース
scaleInPolicy 仮想マシン スケール セットをスケールインするときに削除対象として選択する仮想マシンを決定するスケールイン ポリシーを指定します。 ScaleInPolicy
singlePlacementGroup true の場合、スケール セットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更される可能性があります。 ただし、singlePlacementGroup が false の場合は、true に変更できません。 [bool]
upgradePolicy アップグレード ポリシー。 UpgradePolicy
virtualMachineProfile 仮想マシン プロファイル。 VirtualMachineScaleSetVMProfile
zoneBalance ゾーンの停止が発生した場合に仮想マシンの配布を x ゾーン間で厳密に行うかどうか。 [bool]

AdditionalCapabilities

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

AutomaticRepairsPolicy

名前 説明
enabled 仮想マシン スケール セットで自動修復を有効にするかどうかを指定します。 既定値は false です。 [bool]
gracePeriod VM の状態の変更により自動修復が中断される時間。 猶予期間は、状態の変更が完了した後に開始されます。 これは、早期または偶発的な修復を回避するのに役立ちます。 期間は ISO 8601 形式で指定する必要があります。 許容される最小猶予期間は 30 分 (PT30M) で、既定値でもあります。 許可される猶予期間の上限は 90 分 (PT90M) です。 string

サブリソース

名前 説明
id リソース ID string

ScaleInPolicy

名前 説明
rules 仮想マシン スケール セットをスケーリングするときに従う規則。

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

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

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

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

次のいずれかを含む文字列配列:
'Default'
'NewestVM'
'OldestVM'

UpgradePolicy

名前 説明
automaticOSUpgradePolicy OS の自動アップグレードを実行するために使用される構成パラメーター。 AutomaticOSUpgradePolicy
mode スケール セット内の仮想マシンへのアップグレードモードを指定します。

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

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

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。
'Automatic'
'Manual'
'Rolling'
rollingUpgradePolicy ローリング アップグレードの実行中に使用される構成パラメーター。 RollingUpgradePolicy

AutomaticOSUpgradePolicy

名前 説明
disableAutomaticRollback OS イメージのロールバック機能を無効にするかどうか。 既定値は false です。 [bool]
enableAutomaticOSUpgrade 新しいバージョンの OS イメージが使用可能になったときに、スケール セット インスタンスに OS アップグレードを自動的に適用するかどうかを示します。 既定値は false です。

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

RollingUpgradePolicy

名前 説明
enableCrossZoneUpgrade アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、Update Domain と maxBatchInstancePercent を考慮してください。 [bool]
maxBatchInstancePercent 1 つのバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計の最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるために、バッチ内のインスタンスの割合が減少する可能性があります。 このパラメーターの既定値は 20% です。 INT

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

制約:
最小値 = 5
最大値 = 100
maxUnhealthyUpgradedInstancePercent 異常な状態にあることが検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に発生します。 この割合を超えた場合、ローリング 更新プログラムは中止されます。 このパラメーターの既定値は 20% です。 INT

制約:
最小値 = 0
最大値 = 100
pauseTimeBetweenBatches すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。 string
prioritizeUnhealthyInstances 正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 [bool]

VirtualMachineScaleSetVMProfile

名前 説明
billingProfile Azure Spot VMSS の課金関連の詳細を指定します。

最小 api-version: 2019-03-01。
BillingProfile
diagnosticsProfile ブート診断設定の状態を指定します。

最小 api-version: 2015-06-15。
DiagnosticsProfile
evictionPolicy Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。

Azure Spot 仮想マシンでは、'Deallocate' と 'Delete' の両方がサポートされており、api-version の最小値は 2019-03-01 です。

Azure スポット スケール セットでは、'Deallocate' と 'Delete' の両方がサポートされており、api-version の最小は 2017-10-30-preview です。
'割り当て解除'
'Delete'
extensionProfile スケール セット内の仮想マシンにインストールされる拡張機能の設定のコレクションを指定します。 VirtualMachineScaleSetExtensionProfile
licenseType 使用されているイメージまたはディスクがオンプレミスでライセンスされたことを指定します。

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

Windows_Client

Windows_Server

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

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

詳細については、「Windows Server の Azure ハイブリッド使用特典」を参照してください。

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

最小 api-version: 2015-06-15
string
networkProfile スケール セット内の仮想マシンのネットワーク インターフェイスのプロパティを指定します。 VirtualMachineScaleSetNetworkProfile
osProfile スケール セット内の仮想マシンのオペレーティング システム設定を指定します。 VirtualMachineScaleSetOSProfile
priority スケール セット内の仮想マシンの優先順位を指定します。

最小 api-version: 2017-10-30-preview
'Low'
'Regular'
'Spot'
scheduledEventsProfile スケジュールされたイベント関連の構成を指定します。 ScheduledEventsProfile
securityProfile スケール セット内の仮想マシンのセキュリティ関連のプロファイル設定を指定します。 SecurityProfile
storageProfile 仮想マシンのストレージ設定を指定します。 VirtualMachineScaleSetStorageProfile
Userdata スケール セット内の仮想マシンの UserData。Base-64 でエンコードする必要があります。 顧客はここでシークレットを渡すべきではありません。

最小 api-version: 2021-03-01
string

BillingProfile

名前 説明
maxPrice Azure スポット VM/VMSS に対して支払う最大料金を指定します。 この価格は米ドルです。

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

現在の Azure スポット価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は Azure スポット VM/VMSS の削除にも使用されます。

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

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

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

maxPrice を -1 に設定すると、価格上の理由から Azure Spot VM/VMSS を削除しないように指定できます。 また、既定の最大価格は、提供されていない場合は -1 です。

最小 api-version: 2019-03-01。 10 進値を指定するには、 json() 関数を使用します。
int または json decimal

DiagnosticsProfile

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

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

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

BootDiagnostics

名前 説明
enabled 仮想マシンでブート 診断を有効にする必要があるかどうか。 [bool]
storageUri コンソール出力の配置に使用するストレージ アカウントの URI とスクリーンショット。

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

VirtualMachineScaleSetExtensionProfile

名前 説明
拡張機能 仮想マシン スケール セットの子拡張機能リソース。 VirtualMachineScaleSetExtension[]
extensionsTimeBudget すべての拡張機能の開始時間を指定します。 期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。 既定値は 90 分 (PT1H30M)。

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

VirtualMachineScaleSetExtension

名前 説明
name 拡張機能の名前です。 string
properties 仮想マシン スケール セット拡張機能のプロパティについて説明します。 VirtualMachineScaleSetExtensionProperties

VirtualMachineScaleSetExtensionProperties

名前 説明
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
enableAutomaticUpgrade 新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 [bool]
forceUpdateTag 値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 string
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。 Bicep の場合は、 any() 関数を使用できます。
provisionAfterExtensions この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 string[]
publisher 拡張ハンドラーの発行元の名前。 string
settings 拡張機能の Json 形式のパブリック設定。 Bicep の場合は、 any() 関数を使用できます。
拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

VirtualMachineScaleSetNetworkProfile

名前 説明
healthProbe 仮想マシン スケール セット内のインスタンスの正常性を判断するために使用されるロード バランサー プローブへの参照。 参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}' の形式になります。 ApiEntityReference
networkApiVersion は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します '2020-11-01'
networkInterfaceConfigurations ネットワーク構成の一覧。 VirtualMachineScaleSetNetworkConfiguration[]

ApiEntityReference

名前 説明
id /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。 string

VirtualMachineScaleSetNetworkConfiguration

名前 説明
id リソース ID string
name ネットワーク構成名。 string (必須)
properties 仮想マシン スケール セットのネットワーク プロファイルの IP 構成について説明します。 VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationProperties

名前 説明
deleteOption VM が削除されたときのネットワーク インターフェイスの動作を指定する 'Delete'
'Detach'
dnsSettings ネットワーク インターフェイスに適用される DNS 設定。 VirtualMachineScaleSetNetworkConfigurationDnsSetting...
enableAcceleratedNetworking ネットワーク インターフェイスが高速ネットワーク対応かどうかを指定します。 [bool]
enableFpga ネットワーク インターフェイスが FPGA ネットワーク対応かどうかを指定します。 [bool]
enableIPForwarding この NIC で IP 転送が有効になっているかどうか。 [bool]
ipConfigurations ネットワーク インターフェイスの IP 構成を指定します。 VirtualMachineScaleSetIPConfiguration[] (必須)
networkSecurityGroup ネットワーク セキュリティ グループ。 サブリソース
更新 仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合に備えて、プライマリ ネットワーク インターフェイスを指定します。 [bool]

VirtualMachineScaleSetNetworkConfigurationDnsSetting...

名前 説明
dnsServers DNS サーバーの IP アドレスの一覧 string[]

VirtualMachineScaleSetIPConfiguration

名前 説明
id リソース ID string
name IP 構成名。 string (必須)
properties 仮想マシン スケール セット ネットワーク プロファイルの IP 構成プロパティについて説明します。 VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties

名前 説明
applicationGatewayBackendAddressPools アプリケーション ゲートウェイのバックエンド アドレス プールへの参照の配列を指定します。 スケール セットは、複数のアプリケーション ゲートウェイのバックエンド アドレス プールを参照できます。 複数のスケール セットで同じアプリケーション ゲートウェイを使用することはできません。 SubResource[]
applicationSecurityGroups アプリケーション セキュリティ グループへの参照の配列を指定します。 SubResource[]
loadBalancerBackendAddressPools ロード バランサーのバックエンド アドレス プールへの参照の配列を指定します。 スケール セットは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーのバックエンド アドレス プールを参照できます。 複数のスケール セットで同じ Basic SKU ロード バランサーを使用することはできません。 SubResource[]
loadBalancerInboundNatPools ロード バランサーの受信 Nat プールへの参照の配列を指定します。 スケール セットは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーの受信 nat プールを参照できます。 複数のスケール セットで同じ Basic SKU ロード バランサーを使用することはできません。 SubResource[]
更新 仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合に備えて、プライマリ ネットワーク インターフェイスを指定します。 [bool]
privateIPAddressVersion Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 'IPv4'
'IPv6'
publicIPAddressConfiguration publicIPAddressConfiguration。 VirtualMachineScaleSetPublicIPAddressConfiguration
サブネット サブネットの識別子を指定します。 ApiEntityReference

VirtualMachineScaleSetPublicIPAddressConfiguration

名前 説明
name publicIP アドレス構成名。 string (必須)
properties 仮想マシン スケール セット IP 構成の PublicIPAddress 構成について説明します VirtualMachineScaleSetPublicIPAddressConfigurationPr...
sku パブリック IP SKU について説明します PublicIPAddressSku

VirtualMachineScaleSetPublicIPAddressConfigurationPr...

名前 説明
deleteOption VM が削除されたときのパブリック IP の動作を指定する 'Delete'
'デタッチ'
dnsSettings publicIP アドレスに適用される DNS 設定。 VirtualMachineScaleSetPublicIPAddressConfigurationDn...
idleTimeoutInMinutes パブリック IP アドレスのアイドル タイムアウト。 INT
ipTags パブリック IP アドレスに関連付けられている IP タグの一覧。 VirtualMachineScaleSetIpTag[]
publicIPAddressVersion Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 'IPv4'
'IPv6'
publicIPPrefix publicIP アドレスの割り当て元となる PublicIPPrefix。 サブリソース

VirtualMachineScaleSetPublicIPAddressConfigurationDn...

名前 説明
domainNameLabel ドメイン名ラベル。ドメイン名ラベルと vm インデックスの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります string (必須)

VirtualMachineScaleSetIpTag

名前 説明
ipTagType IP タグの種類。 例: FirstPartyUsage。 string
タグ パブリック IP に関連付けられている IP タグ。 例: SQL、Storage など string

PublicIPAddressSku

名前 説明
name パブリック IP SKU 名を指定する 'Basic'
'Standard'
レベル パブリック IP SKU レベルを指定する 'Global'
'Regional'

VirtualMachineScaleSetOSProfile

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

最小長 (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、チェックまたは修復する」を参照してください。
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
adminUsername 管理者アカウントの名前を指定します。

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"、"test2"、"test3"、"user4"、"user5"。

最小長 (Linux): 1 文字

最大長 (Linux): 64 文字

最大長 (Windows): 20 文字
string
computerNamePrefix スケール セット内のすべての仮想マシンのコンピューター名プレフィックスを指定します。 コンピューター名のプレフィックスは、1 から 15 文字の長さにする必要があります。 string
customData カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。

VM に cloud-init を使用する場合は、「cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。
string
linuxConfiguration 仮想マシン上の Linux オペレーティング システムの設定を指定します。

サポートされている Linux ディストリビューションの一覧については、「Linux on Azure-Endorsed Distributions」を参照してください。
LinuxConfiguration
secrets スケール セット内の仮想マシンにインストールする必要がある証明書のセットを指定します。 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。 VaultSecretGroup[]
windowsConfiguration 仮想マシン上の Windows オペレーティング システムの設定を指定します。 WindowsConfiguration

LinuxConfiguration

名前 説明
disablePasswordAuthentication パスワード認証を無効にするかどうかを指定します。 [bool]
patchSettings [プレビュー機能]Linux での VM ゲストパッチ適用に関連する設定を指定します。 LinuxPatchSettings
provisionVMAgent 仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

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

LinuxPatchSettings

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

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

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

AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。
'AutomaticByPlatform'
'ImageDefault'
patchMode OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシン スケール セットに関連付けられている仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

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

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

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

SshConfiguration

名前 説明
publicKeys Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。 SshPublicKey[]

SshPublicKey

名前 説明
keyData SSH を使用して VM で認証するために使用される SSH 公開キー証明書。 キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。

SSH キーの作成については、「Azure の Linux VM 用 Linux および Mac で SSH キーを作成する」/「azure/virtual-machines/linux/create-ssh-keys-detailed」を参照してください。
string
path ssh 公開キーが格納されている、作成された VM 上の完全なパスを指定します。 ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。 例: /home/user/.ssh/authorized_keys string

VaultSecretGroup

名前 説明
sourceVault VaultCertificates 内のすべての証明書を含むKey Vaultの相対 URL。 サブリソース
vaultCertificates 証明書を含む SourceVault のキー コンテナー参照の一覧。 VaultCertificate[]

VaultCertificate

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

Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、ファイル名 <は X509 証明書ファイルの場合は UppercaseThumbprint.crt>、 <秘密キーの場合は UppercaseThumbprint.prv> です。 これらのファイルはどちらも .pem 形式です。
string
certificateUrl これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キー コンテナーにキーまたはシークレットを追加する」を参照してください。 この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。
string

WindowsConfiguration

名前 説明
additionalUnattendContent Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。 AdditionalUnattendContent[]
enableAutomaticUpdates Windows 仮想マシンに対して自動更新が有効になっているかどうかを示します。 既定値は true です。

仮想マシン スケール セットの場合、このプロパティを更新でき、更新は OS の再プロビジョニングで有効になります。
[bool]
patchSettings [プレビュー機能]Windows での VM ゲストパッチ適用に関連する設定を指定します。 PatchSettings
provisionVMAgent 仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
[bool]
timeZone 仮想マシンのタイム ゾーンを指定します。 例: "太平洋標準時"

指定できる値は、TimeZoneInfo.GetSystemTimeZones によって返されるタイム ゾーンから値を TimeZoneInfo.Id できます。
string
Winrm Windows リモート管理リスナーを指定します。 これによって、リモートの Windows PowerShell が有効になります。 WinRMConfiguration

AdditionalUnattendContent

名前 説明
componentName コンポーネントの名前。 現在、許容される値は Microsoft-Windows-Shell-Setup のみです。 'Microsoft-Windows-Shell-Setup'
content 指定したパスとコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満である必要があり、挿入される設定または機能のルート要素を含める必要があります。 string
passName パス名。 現在、許容される値は OobeSystem のみです。 'OobeSystem'
settingName コンテンツが適用される設定の名前を指定します。 使用できる値は、FirstLogonCommands と AutoLogon です。 'AutoLogon'
'FirstLogonCommands'

PatchSettings

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

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

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

AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。
'AutomaticByPlatform'
'ImageDefault'
enableHotpatching 再起動を必要とせずに、お客様が Azure VM にパッチを適用できるようにします。 enableHotpatching の場合、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。 [bool]
patchMode OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシン スケール セットに関連付けられている仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

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

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

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

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

WinRMConfiguration

名前 説明
リスナー Windows リモート管理リスナーの一覧 WinRMListener[]

WinRMListener

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

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。
string
protocol WinRM リスナーのプロトコルを指定します。

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

https
'Http'
'Https'

ScheduledEventsProfile

名前 説明
terminateNotificationProfile Terminate Scheduled Event 関連の構成を指定します。 TerminateNotificationProfile

TerminateNotificationProfile

名前 説明
有効化 (enable) Terminate Scheduled イベントを有効にするか無効にするかを指定します。 [bool]
notBeforeTimeout 削除される仮想マシンの構成可能な時間の長さは、イベントが自動承認 (タイムアウト) される前に、スケジュールされたイベントの終了を承認する必要があります。 構成は ISO 8601 形式で指定する必要があります。既定値は 5 分 (PT5M) です string

SecurityProfile

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

既定値: リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。
[bool]
securityType 仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch として設定されていない限り、UefiSettings は有効になりません。
'TrustedLaunch'
uefiSettings 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

最小 api-version: 2020-12-01
UefiSettings

UefiSettings

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

最小 api-version: 2020-12-01
[bool]
vTpmEnabled 仮想マシンで vTPM を有効にするかどうかを指定します。

最小 api-version: 2020-12-01
[bool]

VirtualMachineScaleSetStorageProfile

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

ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
VirtualMachineScaleSetDataDisk[]
imageReference 使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。 ImageReference
osDisk スケール セット内の仮想マシンによって使用されるオペレーティング システム ディスクに関する情報を指定します。

ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
VirtualMachineScaleSetOSDisk

VirtualMachineScaleSetDataDisk

名前 説明
キャッシュ キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値: Standard Storage の場合はなし。Premium Storage の ReadOnly
'None'
'ReadOnly'
'ReadWrite'
createOption create オプション。 'Attach'
'Empty'
'FromImage' (必須)
diskIOPSReadWrite マネージド ディスクの Read-Write IOPS を指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。 INT
diskMBpsReadWrite マネージド ディスクの帯域幅を 1 秒あたりの MB 単位で指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。 INT
diskSizeGB 空のデータ ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。

この値は 1023 GB より大きくすることはできません
INT
lun データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。 int (必須)
managedDisk マネージド ディスク のパラメーター。 VirtualMachineScaleSetManagedDiskParameters
name ディスク名。 string
writeAcceleratorEnabled ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 [bool]

VirtualMachineScaleSetManagedDiskParameters

名前 説明
diskEncryptionSet マネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。 DiskEncryptionSetParameters
storageAccountType マネージド ディスクのストレージ アカウントの種類を指定します。 注: UltraSSD_LRSはデータ ディスクでのみ使用できますが、OS ディスクでは使用できません。 'Premium_LRS'
'Premium_ZRS'
'StandardSSD_LRS'
'StandardSSD_ZRS'
'Standard_LRS'
'UltraSSD_LRS'

DiskEncryptionSetParameters

名前 説明
id リソース ID string

ImageReference

名前 説明
id リソース ID string
offer 仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのオファーを指定します。 string
publisher イメージの発行元。 string
sku イメージ SKU。 string
version 仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのバージョンを指定します。 使用できる形式は Major.Minor.Build または 'latest' です。 メジャー、マイナー、ビルドは 10 進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 'latest' を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ後に VM イメージは自動的に更新されません。 string

VirtualMachineScaleSetOSDisk

名前 説明
キャッシュ キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値: Standard Storage の場合はなし。Premium Storage の ReadOnly
'None'
'ReadOnly'
'ReadWrite'
createOption スケール セット内の仮想マシンの作成方法を指定します。

使用できる値は FromImage \u2013 のみです。この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用します。
'Attach'
'Empty'
'FromImage' (必須)
diffDiskSettings 仮想マシン スケール セットで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 DiffDiskSettings
diskSizeGB オペレーティング システム ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。

この値は 1023 GB より大きくすることはできません
INT
image スケール セットの基にするアンマネージド ユーザー イメージに関する情報を指定します。 VirtualHardDisk
managedDisk マネージド ディスク のパラメーター。 VirtualMachineScaleSetManagedDiskParameters
name ディスク名。 string
osType このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。

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

Windows

Linux
'Linux'
'Windows'
vhdContainers スケール セットのオペレーティング システム ディスクの格納に使用するコンテナー URL を指定します。 string[]
writeAcceleratorEnabled ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 [bool]

DiffDiskSettings

名前 説明
オプション オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 'Local'
配置 オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。

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

CacheDisk

ResourceDisk

既定値: VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk が使用されます。

キャッシュ ディスクを公開する VM サイズをチェックするには、/azure/virtual-machines/windows/sizes の Windows VM と /azure/virtual-machines/linux/sizes の Linux VM の VM サイズに関するドキュメントを参照してください。
'CacheDisk'
'ResourceDisk'

VirtualHardDisk

名前 説明
uri 仮想ハード ディスクの URI を指定します。 string

Sku

名前 説明
capacity スケール セット内の仮想マシンの数を指定します。 INT
name SKU 名。 string
レベル スケール セット内の仮想マシンの層を指定します。

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

Standard

Basic
string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
LB プローブと自動修復を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、正常性プローブが構成されたロード バランサーの背後に Linux VM の VM スケール セットをデプロイできます。 スケール セットには、30 分の猶予期間でインスタンスの自動修復ポリシーも有効になっています。
各 VM をAzure Files共有に接続する VMSS をデプロイする

Azure にデプロイする
このテンプレートは、Ubuntu 仮想マシン スケール セットをデプロイし、カスタム スクリプト拡張機能を使用して各 VM をAzure Files共有に接続します
カスタム スクリプト拡張機能を使用して Windows VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、さまざまな Windows バージョンの最新の修正プログラムが適用されたバージョンを使用して、Windows VM の VM スケール セットをデプロイできます。 これらの VM にはカスタマイズ用のカスタム スクリプト拡張機能があり、RDP 接続用の NAT 規則を持つロード バランサーの背後にあります。
既存の vnet にスケール セットをデプロイする

Azure にデプロイする
このテンプレートは、既存の vnet に VM スケール セットをデプロイします。
仮想マシン スケール セットに複数の VM を追加する

Azure にデプロイする
このテンプレートでは、マネージド ディスク、パブリック IP、ネットワーク インターフェイスを含む N 個の VM が作成されます。 フレキシブル オーケストレーション モードの仮想マシン スケール セットに VM が作成されます。 これらは、デプロイの一部として作成されるVirtual Networkでプロビジョニングされます
VMSS フレキシブル オーケストレーション モードのクイック スタート Linux

Azure にデプロイする
このテンプレートは、Azure Load Balancerの背後にインスタンスを含む単純な VM スケール セットをデプロイします。 VM スケール セットはフレキシブル オーケストレーション モードです。 os パラメーターを使用して、Linux (Ubuntu) または Windows (Windows Server Datacenter 2019) の展開を選択します。 注: このクイックスタート テンプレートでは、任意のインターネット アドレスから VM 管理ポート (SSH、RDP) へのネットワーク アクセスが可能であり、運用環境のデプロイには使用しないでください。
ILB の背後に Linux VM を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、修正プログラムが適用された最新バージョンの Ubuntu Linux 15.10 または 14.04.4-LTS を使用して、Linux VM の VM スケール セットをデプロイできます。 これらの VM は、SSH 接続の NAT 規則を持つ内部ロード バランサーの背後にあります。
Linux カスタム イメージを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、スケール セット内にカスタム VM Linux イメージをデプロイできます。 これらの VM は、HTTP 負荷分散を使用したロード バランサーの背後にあります (既定ではポート 80)。 この例では、カスタム スクリプトを使用してアプリケーションのデプロイと更新を行います。独自の更新手順用にカスタム スクリプトを指定する必要がある場合があります。 VMSS を作成するのと同じサブスクリプションとリージョンに、VM の一般化されたイメージを提供する必要があります。
Linux VM を使用して単純な VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、修正プログラムが適用された最新バージョンの Ubuntu Linux 14.04.4-LTS または 16.04-LTS を使用して、Linux VM の単純な VM スケール セットをデプロイできます。 これらの VM は、SSH 接続の NAT 規則を持つロード バランサーの背後にあります。
可用性ゾーンに Linux VM を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、修正プログラムが適用された最新バージョンの Ubuntu Linux 14.04.4-LTS または 16.04-LTS を使用して、Linux VM の単純な VM スケール セットをデプロイできます。 これらの VM は、SSH 接続の NAT 規則を持つロード バランサーの背後にあります。
プライマリ/セカンダリ アーキテクチャを使用して Linux VMSS をデプロイする

Azure にデプロイする
このテンプレートを使用すると、プライマリ セカンダリ アーキテクチャでカスタム スクリプト拡張機能を使用して Linux VMSS をデプロイできます
Linux VM と VM ごとのパブリック IPv4 を使用したシンプルな VM スケール セット

Azure にデプロイする
このテンプレートでは、ロード バランサー、受信 NAT 規則、および VM ごとのパブリック IP を使用した単純なスケール セットのデプロイを示します。
トラステッド起動対応の Windows VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンのWindows Server 2016、Windows Server 2019、または Windows Server 2022 Azure Edition を使用して、信頼された起動に対応した Windows VM スケール セットをデプロイできます。 これらの VM は、RDP 接続の NAT 規則を持つロード バランサーの背後にあります。 Secureboot と vTPM を有効にすると、ゲスト構成証明拡張機能が VMSS にインストールされます。 この拡張機能は、クラウドによるリモート 構成証明 を実行します。
Azure Application Gatewayを使用して Ubuntu VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、Azure Application Gatewayと統合されたシンプルな Ubuntu VM スケール セットをデプロイでき、最大 1,000 台の VM をサポートします
Linux VM と自動スケールを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、修正プログラムが適用された最新バージョンの Ubuntu Linux 15.04 または 14.04.4-LTS を使用して、Linux VM の単純な VM スケール セットをデプロイできます。 これらの VM は、SSH 接続の NAT 規則を持つロード バランサーの背後にあります。自動スケールも統合されています
SSL 対応 VM スケール セット

Azure にデプロイする
Azure Key Vaultから安全にデプロイされた SSL 証明書を使用して Web サーバー構成をデプロイします
Windows 上の既存の vnet にスケール セットをデプロイする

Azure にデプロイする
このテンプレートは、Windows 2016 Datacenter VM Scale Set を既存のリソース グループ、vnet、サブネットにデプロイします。
Azure Application Gatewayを使用して Windows VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、Azure Application Gatewayと統合されたシンプルな Windows VM スケール セットをデプロイでき、最大 1,000 台の VM をサポートします
Windows VM と自動スケールを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、Windows 2008-R2-SP1、2012-Datacenter、または 2012-R2-Datacenter のパッチが適用された最新バージョンを使用して、Windows VM の単純な VM スケール セットをデプロイできます。 これらの VM は、RDP 接続の NAT 規則を持つロード バランサーの背後にあります。 また、自動スケールが統合されています
Windows カスタム イメージを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、カスタム Windows イメージを使用して単純な VM スケール セットをデプロイできます。 これらの VM は、HTTP 負荷分散を使用するロード バランサーの背後にあります (ポート 80 では既定で)
Windows VM を使用して単純な VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、さまざまな Windows バージョンの最新のパッチが適用されたバージョンを使用して、Windows VM の単純な VM スケール セットをデプロイできます。 これらの VM は、RDP 接続用の NAT 規則を持つロード バランサーの背後にあります。
Availability Zonesに Windows VM を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、さまざまな Windows バージョンの最新のパッチが適用されたバージョンを使用して、Windows VM の VM スケール セットをデプロイできます。 これらの VM は、RDP 接続用の NAT 規則を持つロード バランサーの背後にあります。
パブリック IP プレフィックスを持つ VMSS

Azure にデプロイする
パブリック IP プレフィックスを使用して VMSS をデプロイするためのテンプレート

ARM テンプレート リソース定義

virtualMachineScaleSets リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Compute/virtualMachineScaleSets リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string"
  },
  "properties": {
    "additionalCapabilities": {
      "ultraSSDEnabled": "bool"
    },
    "automaticRepairsPolicy": {
      "enabled": "bool",
      "gracePeriod": "string"
    },
    "doNotRunExtensionsOnOverprovisionedVMs": "bool",
    "hostGroup": {
      "id": "string"
    },
    "orchestrationMode": "string",
    "overprovision": "bool",
    "platformFaultDomainCount": "int",
    "proximityPlacementGroup": {
      "id": "string"
    },
    "scaleInPolicy": {
      "rules": [ "string" ]
    },
    "singlePlacementGroup": "bool",
    "upgradePolicy": {
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": "bool",
        "enableAutomaticOSUpgrade": "bool"
      },
      "mode": "string",
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": "bool",
        "maxBatchInstancePercent": "int",
        "maxUnhealthyInstancePercent": "int",
        "maxUnhealthyUpgradedInstancePercent": "int",
        "pauseTimeBetweenBatches": "string",
        "prioritizeUnhealthyInstances": "bool"
      }
    },
    "virtualMachineProfile": {
      "billingProfile": {
        "maxPrice": "[json('decimal-as-string')]"
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": "bool",
          "storageUri": "string"
        }
      },
      "evictionPolicy": "string",
      "extensionProfile": {
        "extensions": [
          {
            "name": "string",
            "properties": {
              "autoUpgradeMinorVersion": "bool",
              "enableAutomaticUpgrade": "bool",
              "forceUpdateTag": "string",
              "protectedSettings": {},
              "provisionAfterExtensions": [ "string" ],
              "publisher": "string",
              "settings": {},
              "type": "string",
              "typeHandlerVersion": "string"
            }
          }
        ],
        "extensionsTimeBudget": "string"
      },
      "licenseType": "string",
      "networkProfile": {
        "healthProbe": {
          "id": "string"
        },
        "networkApiVersion": "2020-11-01",
        "networkInterfaceConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "deleteOption": "string",
              "dnsSettings": {
                "dnsServers": [ "string" ]
              },
              "enableAcceleratedNetworking": "bool",
              "enableFpga": "bool",
              "enableIPForwarding": "bool",
              "ipConfigurations": [
                {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "applicationGatewayBackendAddressPools": [
                      {
                        "id": "string"
                      }
                    ],
                    "applicationSecurityGroups": [
                      {
                        "id": "string"
                      }
                    ],
                    "loadBalancerBackendAddressPools": [
                      {
                        "id": "string"
                      }
                    ],
                    "loadBalancerInboundNatPools": [
                      {
                        "id": "string"
                      }
                    ],
                    "primary": "bool",
                    "privateIPAddressVersion": "string",
                    "publicIPAddressConfiguration": {
                      "name": "string",
                      "properties": {
                        "deleteOption": "string",
                        "dnsSettings": {
                          "domainNameLabel": "string"
                        },
                        "idleTimeoutInMinutes": "int",
                        "ipTags": [
                          {
                            "ipTagType": "string",
                            "tag": "string"
                          }
                        ],
                        "publicIPAddressVersion": "string",
                        "publicIPPrefix": {
                          "id": "string"
                        }
                      },
                      "sku": {
                        "name": "string",
                        "tier": "string"
                      }
                    },
                    "subnet": {
                      "id": "string"
                    }
                  }
                }
              ],
              "networkSecurityGroup": {
                "id": "string"
              },
              "primary": "bool"
            }
          }
        ]
      },
      "osProfile": {
        "adminPassword": "string",
        "adminUsername": "string",
        "computerNamePrefix": "string",
        "customData": "string",
        "linuxConfiguration": {
          "disablePasswordAuthentication": "bool",
          "patchSettings": {
            "assessmentMode": "string",
            "patchMode": "string"
          },
          "provisionVMAgent": "bool",
          "ssh": {
            "publicKeys": [
              {
                "keyData": "string",
                "path": "string"
              }
            ]
          }
        },
        "secrets": [
          {
            "sourceVault": {
              "id": "string"
            },
            "vaultCertificates": [
              {
                "certificateStore": "string",
                "certificateUrl": "string"
              }
            ]
          }
        ],
        "windowsConfiguration": {
          "additionalUnattendContent": [
            {
              "componentName": "Microsoft-Windows-Shell-Setup",
              "content": "string",
              "passName": "OobeSystem",
              "settingName": "string"
            }
          ],
          "enableAutomaticUpdates": "bool",
          "patchSettings": {
            "assessmentMode": "string",
            "enableHotpatching": "bool",
            "patchMode": "string"
          },
          "provisionVMAgent": "bool",
          "timeZone": "string",
          "winRM": {
            "listeners": [
              {
                "certificateUrl": "string",
                "protocol": "string"
              }
            ]
          }
        }
      },
      "priority": "string",
      "scheduledEventsProfile": {
        "terminateNotificationProfile": {
          "enable": "bool",
          "notBeforeTimeout": "string"
        }
      },
      "securityProfile": {
        "encryptionAtHost": "bool",
        "securityType": "TrustedLaunch",
        "uefiSettings": {
          "secureBootEnabled": "bool",
          "vTpmEnabled": "bool"
        }
      },
      "storageProfile": {
        "dataDisks": [
          {
            "caching": "string",
            "createOption": "string",
            "diskIOPSReadWrite": "int",
            "diskMBpsReadWrite": "int",
            "diskSizeGB": "int",
            "lun": "int",
            "managedDisk": {
              "diskEncryptionSet": {
                "id": "string"
              },
              "storageAccountType": "string"
            },
            "name": "string",
            "writeAcceleratorEnabled": "bool"
          }
        ],
        "imageReference": {
          "id": "string",
          "offer": "string",
          "publisher": "string",
          "sku": "string",
          "version": "string"
        },
        "osDisk": {
          "caching": "string",
          "createOption": "string",
          "diffDiskSettings": {
            "option": "Local",
            "placement": "string"
          },
          "diskSizeGB": "int",
          "image": {
            "uri": "string"
          },
          "managedDisk": {
            "diskEncryptionSet": {
              "id": "string"
            },
            "storageAccountType": "string"
          },
          "name": "string",
          "osType": "string",
          "vhdContainers": [ "string" ],
          "writeAcceleratorEnabled": "bool"
        }
      },
      "userData": "string"
    },
    "zoneBalance": "bool"
  },
  "zones": [ "string" ]
}

プロパティ値

virtualMachineScaleSets

名前 説明
type リソースの種類 'Microsoft.Compute/virtualMachineScaleSets'
apiVersion リソース API のバージョン '2021-03-01'
name リソース名 string (必須)

文字制限: 1 から 15 (Windows)
1-64 (Linux)



有効な文字:
スペース、制御文字、または次の文字は使用できません:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

アンダースコアで開始することはできません。 末尾をピリオドまたはハイフンにすることはできません。
location リソースの場所 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
sku 仮想マシン スケール セット SKU。 SKU
extendedLocation 仮想マシン スケール セットの拡張された場所。 ExtendedLocation
identity 構成されている場合は、仮想マシン スケール セットの ID。 VirtualMachineScaleSetIdentity
plan 仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。 プラン
properties 仮想マシン スケール セットのプロパティについて説明します。 VirtualMachineScaleSetProperties
ゾーン 仮想マシン スケール セット ゾーン。 注: 可用性ゾーンは、スケール セットを作成する場合にのみ設定できます string[]

ExtendedLocation

名前 説明
name 拡張場所の名前。 string
type 拡張場所の型。 'EdgeZone'

VirtualMachineScaleSetIdentity

名前 説明
type 仮想マシン スケール セットに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシン スケール セットからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned、UserAssigned'
'UserAssigned'
userAssignedIdentities 仮想マシン スケール セットに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 VirtualMachineScaleSetIdentityUserAssignedIdentities

VirtualMachineScaleSetIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} VirtualMachineScaleSetIdentityUserAssignedIdentities...

VirtualMachineScaleSetIdentityUserAssignedIdentities...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

プラン

名前 説明
name プラン ID。 string
product マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 string
promotionCode 販売促進コード。 string
publisher 発行元 ID。 string

VirtualMachineScaleSetProperties

名前 説明
additionalCapabilities 仮想マシン スケール セットのVirtual Machinesで有効または無効にする追加機能を指定します。 たとえば、ストレージ アカウントの種類を持つマネージド データ ディスクのアタッチをサポートする機能がVirtual MachinesにあるかどうかUltraSSD_LRS。 AdditionalCapabilities
automaticRepairsPolicy 自動修復のポリシー。 AutomaticRepairsPolicy
doNotRunExtensionsOnOverprovisionedVMs オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。 [bool]
hostGroup 仮想マシン スケール セットが存在する専用ホスト グループに関する情報を指定します。

最小 api-version: 2020-06-01。
サブリソース
orchestrationMode 仮想マシン スケール セットのオーケストレーション モードを指定します。 'フレキシブル'
'Uniform'
overprovision 仮想マシン スケール セットをオーバープロビジョニングするかどうかを指定します。 [bool]
platformFaultDomainCount 各配置グループの障害ドメイン数。 INT
proximityPlacementGroup 仮想マシン スケール セットを割り当てる必要がある近接配置グループに関する情報を指定します。

最小 api-version: 2018-04-01。
サブリソース
scaleInPolicy 仮想マシン スケール セットをスケールインするときに削除する仮想マシンを決定するスケールイン ポリシーを指定します。 ScaleInPolicy
singlePlacementGroup true の場合、スケール セットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更できます。 ただし、singlePlacementGroup が false の場合は、true に変更できません。 [bool]
upgradePolicy アップグレード ポリシー。 UpgradePolicy
virtualMachineProfile 仮想マシン プロファイル。 VirtualMachineScaleSetVMProfile
zoneBalance ゾーンの停止が発生した場合に備えて、仮想マシンの配布を厳密に X ゾーン間で強制するかどうか。 [bool]

AdditionalCapabilities

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

AutomaticRepairsPolicy

名前 説明
enabled 仮想マシン スケール セットで自動修復を有効にするかどうかを指定します。 既定値は false です。 [bool]
gracePeriod VM の状態の変更により自動修復が中断される時間。 猶予期間は、状態の変更が完了した後に開始されます。 これは、早期または偶発的な修復を回避するのに役立ちます。 期間は ISO 8601 形式で指定する必要があります。 許容される最小猶予期間は 30 分 (PT30M) で、既定値でもあります。 許可される猶予期間の上限は 90 分 (PT90M) です。 string

サブリソース

名前 説明
id リソース ID string

ScaleInPolicy

名前 説明
rules 仮想マシン スケール セットをスケーリングするときに従う規則。

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

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

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

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

次のいずれかを含む文字列配列:
'Default'
'NewestVM'
'OldestVM'

UpgradePolicy

名前 説明
automaticOSUpgradePolicy OS の自動アップグレードを実行するために使用される構成パラメーター。 AutomaticOSUpgradePolicy
mode スケール セット内の仮想マシンへのアップグレードモードを指定します。

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

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

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。
'Automatic'
'Manual'
'Rolling'
rollingUpgradePolicy ローリング アップグレードの実行中に使用される構成パラメーター。 RollingUpgradePolicy

AutomaticOSUpgradePolicy

名前 説明
disableAutomaticRollback OS イメージのロールバック機能を無効にするかどうか。 既定値は false です。 [bool]
enableAutomaticOSUpgrade 新しいバージョンの OS イメージが使用可能になったときに、スケール セット インスタンスに OS アップグレードを自動的に適用するかどうかを示します。 既定値は false です。

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

RollingUpgradePolicy

名前 説明
enableCrossZoneUpgrade アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、Update Domain と maxBatchInstancePercent を考慮してください。 [bool]
maxBatchInstancePercent 1 つのバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計の最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるために、バッチ内のインスタンスの割合が減少する可能性があります。 このパラメーターの既定値は 20% です。 INT

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

制約:
最小値 = 5
最大値 = 100
maxUnhealthyUpgradedInstancePercent 異常な状態にあることが検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に発生します。 この割合を超えた場合、ローリング 更新プログラムは中止されます。 このパラメーターの既定値は 20% です。 INT

制約:
最小値 = 0
最大値 = 100
pauseTimeBetweenBatches すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。 string
prioritizeUnhealthyInstances 正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 [bool]

VirtualMachineScaleSetVMProfile

名前 説明
billingProfile Azure Spot VMSS の課金関連の詳細を指定します。

最小 api-version: 2019-03-01。
BillingProfile
diagnosticsProfile ブート診断設定の状態を指定します。

最小 api-version: 2015-06-15。
DiagnosticsProfile
evictionPolicy Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。

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

Azure スポット スケール セットでは、"割り当て解除" と "削除" の両方がサポートされており、api-version の最小バージョンは 2017-10-30-preview です。
'割り当て解除'
'Delete'
extensionProfile スケール セット内の仮想マシンにインストールされる拡張機能の設定のコレクションを指定します。 VirtualMachineScaleSetExtensionProfile
licenseType 使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。

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

Windows_Client

Windows_Server

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

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

詳細については、「Windows Server の Azure ハイブリッド使用特典」を参照してください。

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

最小 api-version: 2015-06-15
string
networkProfile スケール セット内の仮想マシンのネットワーク インターフェイスのプロパティを指定します。 VirtualMachineScaleSetNetworkProfile
osProfile スケール セット内の仮想マシンのオペレーティング システム設定を指定します。 VirtualMachineScaleSetOSProfile
priority スケール セット内の仮想マシンの優先度を指定します。

最小 api-version: 2017-10-30-preview
'Low'
'Regular'
'Spot'
scheduledEventsProfile スケジュールされたイベント関連の構成を指定します。 ScheduledEventsProfile
securityProfile スケール セット内の仮想マシンのセキュリティ関連プロファイル設定を指定します。 SecurityProfile
storageProfile 仮想マシンのストレージ設定を指定します。 VirtualMachineScaleSetStorageProfile
Userdata スケール セット内の仮想マシンの UserData。Base-64 でエンコードする必要があります。 お客様はここでシークレットを渡さないでください。

最小 api-version: 2021-03-01
string

BillingProfile

名前 説明
maxPrice Azure スポット VM/VMSS に対して支払う最大価格を指定します。 この価格は米ドルです。

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

現在の Azure スポット価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は Azure スポット VM/VMSS の削除にも使用されます。

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

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

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

maxPrice を -1 に設定すると、価格上の理由から Azure Spot VM/VMSS を削除しないことを示すことができます。 また、提供されていない場合、既定の最大価格は -1 です。

最小 api-version: 2019-03-01。 10 進値を指定するには、 json() 関数を使用します。
int または json decimal

DiagnosticsProfile

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

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

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

BootDiagnostics

名前 説明
enabled 仮想マシンでブート 診断を有効にする必要があるかどうか。 [bool]
storageUri コンソール出力とスクリーンショットを配置するために使用するストレージ アカウントの URI。

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

VirtualMachineScaleSetExtensionProfile

名前 説明
拡張機能 仮想マシン スケール セットの子拡張機能リソース。 VirtualMachineScaleSetExtension[]
extensionsTimeBudget すべての拡張機能の開始時間を指定します。 期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。 既定値は 90 分 (PT1H30M)。

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

VirtualMachineScaleSetExtension

名前 説明
name 拡張機能の名前です。 string
properties 仮想マシン スケール セット拡張機能のプロパティについて説明します。 VirtualMachineScaleSetExtensionProperties

VirtualMachineScaleSetExtensionProperties

名前 説明
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用するかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
enableAutomaticUpgrade 使用可能な拡張機能の新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 [bool]
forceUpdateTag 値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 string
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることも、保護された設定をまったく含めることもできます。
provisionAfterExtensions この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 string[]
publisher 拡張ハンドラーパブリッシャーの名前。 string
settings 拡張機能の Json 形式のパブリック設定。
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

VirtualMachineScaleSetNetworkProfile

名前 説明
healthProbe 仮想マシン スケール セット内のインスタンスの正常性を判断するために使用されるロード バランサー プローブへの参照。 参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}' の形式になります。 ApiEntityReference
networkApiVersion は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します '2020-11-01'
networkInterfaceConfigurations ネットワーク構成の一覧。 VirtualMachineScaleSetNetworkConfiguration[]

ApiEntityReference

名前 説明
id /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。 string

VirtualMachineScaleSetNetworkConfiguration

名前 説明
id リソース ID string
name ネットワーク構成名。 string (必須)
properties 仮想マシン スケール セット ネットワーク プロファイルの IP 構成について説明します。 VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationProperties

名前 説明
deleteOption VM が削除されたときのネットワーク インターフェイスの動作を指定する 'Delete'
'デタッチ'
dnsSettings ネットワーク インターフェイスに適用される DNS 設定。 VirtualMachineScaleSetNetworkConfigurationDnsSetting...
enableAcceleratedNetworking ネットワーク インターフェイスが高速ネットワーク対応かどうかを指定します。 [bool]
enableFpga ネットワーク インターフェイスが FPGA ネットワーク対応かどうかを指定します。 [bool]
enableIPForwarding この NIC で IP 転送が有効になっているかどうか。 [bool]
ipConfigurations ネットワーク インターフェイスの IP 構成を指定します。 VirtualMachineScaleSetIPConfiguration[] (必須)
networkSecurityGroup ネットワーク セキュリティ グループ。 サブリソース
更新 仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合のプライマリ ネットワーク インターフェイスを指定します。 [bool]

VirtualMachineScaleSetNetworkConfigurationDnsSetting...

名前 説明
dnsServers DNS サーバーの IP アドレスの一覧 string[]

VirtualMachineScaleSetIPConfiguration

名前 説明
id リソース ID string
name IP 構成名。 string (必須)
properties 仮想マシン スケール セットネットワーク プロファイルの IP 構成プロパティについて説明します。 VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties

名前 説明
applicationGatewayBackendAddressPools アプリケーション ゲートウェイのバックエンド アドレス プールへの参照の配列を指定します。 スケール セットは、複数のアプリケーション ゲートウェイのバックエンド アドレス プールを参照できます。 複数のスケール セットで同じアプリケーション ゲートウェイを使用することはできません。 SubResource[]
applicationSecurityGroups アプリケーション セキュリティ グループへの参照の配列を指定します。 SubResource[]
loadBalancerBackendAddressPools ロード バランサーのバックエンド アドレス プールへの参照の配列を指定します。 スケール セットは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーのバックエンド アドレス プールを参照できます。 複数のスケール セットで同じ Basic SKU ロード バランサーを使用することはできません。 SubResource[]
loadBalancerInboundNatPools ロード バランサーの受信 Nat プールへの参照の配列を指定します。 スケール セットは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーの受信 nat プールを参照できます。 複数のスケール セットで同じ Basic SKU ロード バランサーを使用することはできません。 SubResource[]
更新 仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合のプライマリ ネットワーク インターフェイスを指定します。 [bool]
privateIPAddressVersion Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 'IPv4'
'IPv6'
publicIPAddressConfiguration publicIPAddressConfiguration。 VirtualMachineScaleSetPublicIPAddressConfiguration
サブネット サブネットの識別子を指定します。 ApiEntityReference

VirtualMachineScaleSetPublicIPAddressConfiguration

名前 説明
name publicIP アドレス構成名。 string (必須)
properties 仮想マシン スケール セットの IP 構成の PublicIPAddress 構成について説明します VirtualMachineScaleSetPublicIPAddressConfigurationPr...
sku パブリック IP SKU について説明します PublicIPAddressSku

VirtualMachineScaleSetPublicIPAddressConfigurationPr...

名前 説明
deleteOption VM が削除されたときのパブリック IP の動作を指定する 'Delete'
'Detach'
dnsSettings publicIP アドレスに適用される DNS 設定。 VirtualMachineScaleSetPublicIPAddressConfigurationDn...
idleTimeoutInMinutes パブリック IP アドレスのアイドル タイムアウト。 INT
ipTags パブリック IP アドレスに関連付けられている IP タグの一覧。 VirtualMachineScaleSetIpTag[]
publicIPAddressVersion Api-Version 2019-07-01 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 'IPv4'
'IPv6'
publicIPPrefix publicIP アドレスの割り当て元となる PublicIPPrefix。 サブリソース

VirtualMachineScaleSetPublicIPAddressConfigurationDn...

名前 説明
domainNameLabel ドメイン名ラベル。ドメイン名ラベルと vm インデックスの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります string (必須)

VirtualMachineScaleSetIpTag

名前 説明
ipTagType IP タグの種類。 例: FirstPartyUsage。 string
タグ パブリック IP に関連付けられている IP タグ。 例: SQL、Storage など string

PublicIPAddressSku

名前 説明
name パブリック IP SKU 名を指定する 'Basic'
'Standard'
レベル パブリック IP SKU レベルを指定する 'Global'
'Regional'

VirtualMachineScaleSetOSProfile

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

最小長 (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、チェックまたは修復する」を参照してください。
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
adminUsername 管理者アカウントの名前を指定します。

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"、"test2"、"test3"、"user4"、"user5"。

最小長 (Linux): 1 文字

最大長 (Linux): 64 文字

最大長 (Windows): 20 文字
string
computerNamePrefix スケール セット内のすべての仮想マシンのコンピューター名プレフィックスを指定します。 コンピューター名のプレフィックスは、1 から 15 文字の長さにする必要があります。 string
customData カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。

VM に cloud-init を使用する場合は、「cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。
string
linuxConfiguration 仮想マシン上の Linux オペレーティング システムの設定を指定します。

サポートされている Linux ディストリビューションの一覧については、「Linux on Azure-Endorsed Distributions」を参照してください。
LinuxConfiguration
secrets スケール セット内の仮想マシンにインストールする必要がある証明書のセットを指定します。 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。 VaultSecretGroup[]
windowsConfiguration 仮想マシン上の Windows オペレーティング システムの設定を指定します。 WindowsConfiguration

LinuxConfiguration

名前 説明
disablePasswordAuthentication パスワード認証を無効にするかどうかを指定します。 [bool]
patchSettings [プレビュー機能]Linux での VM ゲストパッチ適用に関連する設定を指定します。 LinuxPatchSettings
provisionVMAgent 仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

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

LinuxPatchSettings

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

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

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

AutomaticByPlatform - プラットフォームによって定期的なパッチ評価がトリガーされます。 プロパティ provisionVMAgent は true である必要があります。
'AutomaticByPlatform'
'ImageDefault'
patchMode OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシン スケール セットに関連付けられている仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

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

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

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

SshConfiguration

名前 説明
publicKeys Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。 SshPublicKey[]

SshPublicKey

名前 説明
keyData SSH を使用して VM で認証するために使用される SSH 公開キー証明書。 キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。

ssh キーの作成については、「Azure の Linux VM 用 Linux と Mac で SSH キーを作成する」/「azure/virtual-machines/linux/create-ssh-keys-detailed」を参照してください。
string
path ssh 公開キーが格納されている、作成された VM の完全パスを指定します。 ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。 例: /home/user/.ssh/authorized_keys string

VaultSecretGroup

名前 説明
sourceVault VaultCertificates のすべての証明書を含むKey Vaultの相対 URL。 サブリソース
vaultCertificates 証明書を含む SourceVault 内のキー コンテナー参照の一覧。 VaultCertificate[]

VaultCertificate

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

Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、X509 証明書ファイルのファイル名 <は UppercaseThumbprint.crt>、 <秘密キーの場合は UppercaseThumbprint.prv> です。 これらのファイルはどちらも .pem 形式です。
string
certificateUrl これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キー コンテナーにキーまたはシークレットを追加する」を参照してください。 この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。
string

WindowsConfiguration

名前 説明
additionalUnattendContent Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。 AdditionalUnattendContent[]
enableAutomaticUpdates Windows 仮想マシンに対して自動更新が有効かどうかを示します。 既定値は true です。

仮想マシン スケール セットの場合、このプロパティを更新でき、更新は OS の再プロビジョニングで有効になります。
[bool]
patchSettings [プレビュー機能]Windows での VM ゲストパッチ適用に関連する設定を指定します。 PatchSettings
provisionVMAgent 仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
[bool]
timeZone 仮想マシンのタイム ゾーンを指定します。 たとえば、"太平洋標準時" などです。

指定できる値は、TimeZoneInfo.GetSystemTimeZones によって返されるタイム ゾーンの値 TimeZoneInfo.Id できます。
string
Winrm Windows リモート管理リスナーを指定します。 これによって、リモートの Windows PowerShell が有効になります。 WinRMConfiguration

AdditionalUnattendContent

名前 説明
componentName コンポーネントの名前。 現在、許容される値は Microsoft-Windows-Shell-Setup のみです。 'Microsoft-Windows-Shell-Setup'
content 指定したパスとコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満で、挿入される設定または機能のルート要素を含める必要があります。 string
passName パス名。 現在、使用できる値は OobeSystem のみです。 'OobeSystem'
settingName コンテンツが適用される設定の名前を指定します。 使用できる値は、FirstLogonCommands および AutoLogon です。 'AutoLogon'
'FirstLogonCommands'

PatchSettings

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

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

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

AutomaticByPlatform - プラットフォームによって定期的なパッチ評価がトリガーされます。 プロパティ provisionVMAgent は true である必要があります。
'AutomaticByPlatform'
'ImageDefault'
enableHotpatching 再起動を必要とせずに、お客様が Azure VM にパッチを適用できるようにします。 enableHotpatching の場合、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。 [bool]
patchMode OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシン スケール セットに関連付けられている仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

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

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

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

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

WinRMConfiguration

名前 説明
リスナー Windows リモート管理リスナーの一覧 WinRMListener[]

WinRMListener

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

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。
string
protocol WinRM リスナーのプロトコルを指定します。

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

https
'Http'
'Https'

ScheduledEventsProfile

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

TerminateNotificationProfile

名前 説明
有効化 (enable) Terminate Scheduled イベントを有効にするか無効にするかを指定します。 [bool]
notBeforeTimeout 削除される仮想マシンの構成可能な時間は、イベントが自動的に承認される (タイムアウト) 前に、スケジュールされた終了イベントを承認する必要があります。 構成は ISO 8601 形式で指定する必要があります。既定値は 5 分 (PT5M) です string

SecurityProfile

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

既定値: リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。
[bool]
securityType 仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch として設定されていない限り、UefiSettings は有効になりません。
'TrustedLaunch'
uefiSettings 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

最小 api-version: 2020-12-01
UefiSettings

UefiSettings

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

最小 api-version: 2020-12-01
[bool]
vTpmEnabled 仮想マシンで vTPM を有効にするかどうかを指定します。

最小 api-version: 2020-12-01
[bool]

VirtualMachineScaleSetStorageProfile

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

ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
VirtualMachineScaleSetDataDisk[]
imageReference 使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。 ImageReference
osDisk スケール セット内の仮想マシンによって使用されるオペレーティング システム ディスクに関する情報を指定します。

ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
VirtualMachineScaleSetOSDisk

VirtualMachineScaleSetDataDisk

名前 説明
キャッシュ キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値: Standard Storage の場合はなし。Premium Storage の ReadOnly
'None'
'ReadOnly'
'ReadWrite'
createOption create オプション。 'Attach'
'Empty'
'FromImage' (必須)
diskIOPSReadWrite マネージド ディスクの Read-Write IOPS を指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。 INT
diskMBpsReadWrite マネージド ディスクの帯域幅を 1 秒あたりの MB 単位で指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。 INT
diskSizeGB 空のデータ ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。

この値は 1023 GB より大きくすることはできません
INT
lun データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。 int (必須)
managedDisk マネージド ディスク のパラメーター。 VirtualMachineScaleSetManagedDiskParameters
name ディスク名。 string
writeAcceleratorEnabled ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 [bool]

VirtualMachineScaleSetManagedDiskParameters

名前 説明
diskEncryptionSet マネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。 DiskEncryptionSetParameters
storageAccountType マネージド ディスクのストレージ アカウントの種類を指定します。 注: UltraSSD_LRSはデータ ディスクでのみ使用できますが、OS ディスクでは使用できません。 'Premium_LRS'
'Premium_ZRS'
'StandardSSD_LRS'
'StandardSSD_ZRS'
'Standard_LRS'
'UltraSSD_LRS'

DiskEncryptionSetParameters

名前 説明
id リソース ID string

ImageReference

名前 説明
id リソース ID string
offer 仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのオファーを指定します。 string
publisher イメージの発行元。 string
sku イメージ SKU。 string
version 仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのバージョンを指定します。 使用できる形式は Major.Minor.Build または 'latest' です。 メジャー、マイナー、ビルドは 10 進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 'latest' を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ後に VM イメージは自動的に更新されません。 string

VirtualMachineScaleSetOSDisk

名前 説明
キャッシュ キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値: Standard Storage の場合はなし。Premium Storage の ReadOnly
'None'
'ReadOnly'
'ReadWrite'
createOption スケール セット内の仮想マシンの作成方法を指定します。

使用できる値は FromImage \u2013 のみです。この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用します。
'Attach'
'Empty'
'FromImage' (必須)
diffDiskSettings 仮想マシン スケール セットで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 DiffDiskSettings
diskSizeGB オペレーティング システム ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。

この値は 1023 GB より大きくすることはできません
INT
image スケール セットの基にするアンマネージド ユーザー イメージに関する情報を指定します。 VirtualHardDisk
managedDisk マネージド ディスク のパラメーター。 VirtualMachineScaleSetManagedDiskParameters
name ディスク名。 string
osType このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。

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

Windows

Linux
'Linux'
'Windows'
vhdContainers スケール セットのオペレーティング システム ディスクの格納に使用するコンテナー URL を指定します。 string[]
writeAcceleratorEnabled ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 [bool]

DiffDiskSettings

名前 説明
オプション オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 'Local'
配置 オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。

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

CacheDisk

ResourceDisk

既定値: VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk が使用されます。

キャッシュ ディスクを公開する VM サイズをチェックするには、/azure/virtual-machines/windows/sizes の Windows VM と /azure/virtual-machines/linux/size の Linux VM の VM サイズに関するドキュメントを参照してください。
'CacheDisk'
'ResourceDisk'

VirtualHardDisk

名前 説明
uri 仮想ハード ディスクの URI を指定します。 string

Sku

名前 説明
capacity スケール セット内の仮想マシンの数を指定します。 INT
name SKU 名。 string
レベル スケール セット内の仮想マシンの層を指定します。

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

Standard

Basic
string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
LB プローブと自動修復を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、正常性プローブが構成されたロード バランサーの背後に Linux VM の VM スケール セットをデプロイできます。 スケール セットには、30 分の猶予期間でインスタンスの自動修復ポリシーも有効になっています。
各 VM をAzure Files共有に接続する VMSS をデプロイする

Azure にデプロイする
このテンプレートは、Ubuntu Virtual Machine Scale Set をデプロイし、カスタム スクリプト拡張機能を使用して各 VM をAzure Files共有に接続します
カスタム スクリプト拡張機能を使用して Windows VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、さまざまな Windows バージョンの最新のパッチが適用されたバージョンを使用して、Windows VM の VM スケール セットをデプロイできます。 これらの VM にはカスタマイズ用のカスタム スクリプト拡張機能があり、RDP 接続用の NAT 規則を持つロード バランサーの背後にあります。
既存の vnet にスケール セットをデプロイする

Azure にデプロイする
このテンプレートは、既存の vnet に VM スケール セットをデプロイします。
仮想マシン スケール セットに複数の VM を追加する

Azure にデプロイする
このテンプレートでは、マネージド ディスク、パブリック IP、ネットワーク インターフェイスを使用して、N 個の VM が作成されます。 フレキシブル オーケストレーション モードで仮想マシン スケール セットに VM を作成します。 これらは、デプロイの一部として作成されるVirtual Networkでプロビジョニングされます
VMSS フレキシブル オーケストレーション モードのクイック スタート Linux

Azure にデプロイする
このテンプレートは、Azure Load Balancerの背後にインスタンスを含む単純な VM スケール セットをデプロイします。 VM スケール セットはフレキシブル オーケストレーション モードです。 os パラメーターを使用して、Linux (Ubuntu) または Windows (Windows Server Datacenter 2019) の展開を選択します。 注: このクイックスタート テンプレートでは、任意のインターネット アドレスから VM 管理ポート (SSH、RDP) へのネットワーク アクセスを有効にするため、運用環境のデプロイには使用しないでください。
ILB の背後に Linux VM を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、最新のパッチが適用されたバージョンの Ubuntu Linux 15.10 または 14.04.4-LTS を使用して、Linux VM の VM スケール セットをデプロイできます。 これらの VM は、SSH 接続用の NAT 規則を持つ内部ロード バランサーの背後にあります。
Linux カスタム イメージを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、スケール セット内にカスタム VM Linux イメージをデプロイできます。 これらの VM は、HTTP 負荷分散を使用したロード バランサーの背後にあります (既定ではポート 80)。 この例では、カスタム スクリプトを使用してアプリケーションのデプロイと更新を行います。独自の更新手順にカスタム スクリプトを指定する必要がある場合があります。 VMSS を作成するのと同じサブスクリプションとリージョンに、VM の一般化されたイメージを提供する必要があります。
Linux VM を使用して単純な VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、最新のパッチが適用されたバージョンの Ubuntu Linux 14.04.4-LTS または 16.04-LTS を使用して、Linux VM の単純な VM スケール セットをデプロイできます。 これらの VM は、SSH 接続用の NAT 規則を持つロード バランサーの背後にあります。
Linux VM を含む VM スケール セットを Availabilitabilty Zones にデプロイする

Azure にデプロイする
このテンプレートを使用すると、最新のパッチが適用されたバージョンの Ubuntu Linux 14.04.4-LTS または 16.04-LTS を使用して、Linux VM の単純な VM スケール セットをデプロイできます。 これらの VM は、SSH 接続用の NAT 規則を持つロード バランサーの背後にあります。
Linux VMSS wth プライマリ/セカンダリ アーキテクチャをデプロイする

Azure にデプロイする
このテンプレートを使用すると、プライマリ セカンダリ アーキテクチャでカスタム スクリプト拡張機能を使用して Linux VMSS をデプロイできます
Linux VM と VM ごとのパブリック IPv4 を使用したシンプルな VM スケール セット

Azure にデプロイする
このテンプレートでは、ロード バランサー、受信 NAT 規則、および VM ごとのパブリック IP を使用して単純なスケール セットをデプロイする方法を示します。
トラステッド起動に対応した Windows VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンのWindows Server 2016、Windows Server 2019、または Windows Server 2022 Azure Edition を使用して、信頼された起動対応 VM スケール セットの Windows VM をデプロイできます。 これらの VM は、RDP 接続の NAT 規則を持つロード バランサーの背後にあります。 Secureboot と vTPM を有効にすると、ゲスト構成証明拡張機能が VMSS にインストールされます。 この拡張機能は、クラウドによるリモート 構成証明 を実行します。
Azure Application Gatewayを使用して Ubuntu VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、Azure Application Gatewayと統合されたシンプルな Ubuntu VM スケール セットをデプロイでき、最大 1,000 台の VM をサポートします
Linux VM と自動スケールを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、最新の修正プログラムが適用されたバージョンの Ubuntu Linux 15.04 または 14.04.4-LTS を使用して、Linux VM の単純な VM スケール セットをデプロイできます。 これらの VM は、SSH 接続用の NAT 規則を持つロード バランサーの背後にあります。また、自動スケールが統合されています
SSL 対応 VM スケール セット

Azure にデプロイする
Azure Key Vault を安全にデプロイした SSL 証明書を使用して構成する Web サーバーをデプロイします
Windows 上の既存の vnet にスケール セットをデプロイする

Azure にデプロイする
このテンプレートは、Windows 2016 Datacenter VM Scale Set を既存のリソース グループ、vnet、サブネットにデプロイします。
Azure Application Gatewayを使用して Windows VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、Azure Application Gatewayと統合されたシンプルな Windows VM スケール セットをデプロイでき、最大 1,000 台の VM をサポートします
Windows VM と自動スケールを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、Windows 2008-R2-SP1、2012-Datacenter、または 2012-R2-Datacenter のパッチが適用された最新バージョンを使用して、Windows VM の単純な VM スケール セットをデプロイできます。 これらの VM は、RDP 接続の NAT 規則を持つロード バランサーの背後にあります。 また、自動スケールが統合されています
Windows カスタム イメージを使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、カスタム Windows イメージを使用して単純な VM スケール セットをデプロイできます。 これらの VM は、HTTP 負荷分散を使用するロード バランサーの背後にあります (ポート 80 では既定で)
Windows VM を使用して単純な VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、さまざまな Windows バージョンの最新のパッチが適用されたバージョンを使用して、Windows VM の単純な VM スケール セットをデプロイできます。 これらの VM は、RDP 接続用の NAT 規則を持つロード バランサーの背後にあります。
Availability Zonesに Windows VM を使用して VM スケール セットをデプロイする

Azure にデプロイする
このテンプレートを使用すると、さまざまな Windows バージョンの最新のパッチが適用されたバージョンを使用して、Windows VM の VM スケール セットをデプロイできます。 これらの VM は、RDP 接続用の NAT 規則を持つロード バランサーの背後にあります。
パブリック IP プレフィックスを持つ VMSS

Azure にデプロイする
パブリック IP プレフィックスを使用して VMSS をデプロイするためのテンプレート

Terraform (AzAPI プロバイダー) リソース定義

virtualMachineScaleSets リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Compute/virtualMachineScaleSets リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets@2021-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      additionalCapabilities = {
        ultraSSDEnabled = bool
      }
      automaticRepairsPolicy = {
        enabled = bool
        gracePeriod = "string"
      }
      doNotRunExtensionsOnOverprovisionedVMs = bool
      hostGroup = {
        id = "string"
      }
      orchestrationMode = "string"
      overprovision = bool
      platformFaultDomainCount = int
      proximityPlacementGroup = {
        id = "string"
      }
      scaleInPolicy = {
        rules = [
          "string"
        ]
      }
      singlePlacementGroup = bool
      upgradePolicy = {
        automaticOSUpgradePolicy = {
          disableAutomaticRollback = bool
          enableAutomaticOSUpgrade = bool
        }
        mode = "string"
        rollingUpgradePolicy = {
          enableCrossZoneUpgrade = bool
          maxBatchInstancePercent = int
          maxUnhealthyInstancePercent = int
          maxUnhealthyUpgradedInstancePercent = int
          pauseTimeBetweenBatches = "string"
          prioritizeUnhealthyInstances = bool
        }
      }
      virtualMachineProfile = {
        billingProfile = {
          maxPrice = "decimal-as-string"
        }
        diagnosticsProfile = {
          bootDiagnostics = {
            enabled = bool
            storageUri = "string"
          }
        }
        evictionPolicy = "string"
        extensionProfile = {
          extensions = [
            {
              name = "string"
              properties = {
                autoUpgradeMinorVersion = bool
                enableAutomaticUpgrade = bool
                forceUpdateTag = "string"
                provisionAfterExtensions = [
                  "string"
                ]
                publisher = "string"
                type = "string"
                typeHandlerVersion = "string"
              }
            }
          ]
          extensionsTimeBudget = "string"
        }
        licenseType = "string"
        networkProfile = {
          healthProbe = {
            id = "string"
          }
          networkApiVersion = "2020-11-01"
          networkInterfaceConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                deleteOption = "string"
                dnsSettings = {
                  dnsServers = [
                    "string"
                  ]
                }
                enableAcceleratedNetworking = bool
                enableFpga = bool
                enableIPForwarding = bool
                ipConfigurations = [
                  {
                    id = "string"
                    name = "string"
                    properties = {
                      applicationGatewayBackendAddressPools = [
                        {
                          id = "string"
                        }
                      ]
                      applicationSecurityGroups = [
                        {
                          id = "string"
                        }
                      ]
                      loadBalancerBackendAddressPools = [
                        {
                          id = "string"
                        }
                      ]
                      loadBalancerInboundNatPools = [
                        {
                          id = "string"
                        }
                      ]
                      primary = bool
                      privateIPAddressVersion = "string"
                      publicIPAddressConfiguration = {
                        name = "string"
                        properties = {
                          deleteOption = "string"
                          dnsSettings = {
                            domainNameLabel = "string"
                          }
                          idleTimeoutInMinutes = int
                          ipTags = [
                            {
                              ipTagType = "string"
                              tag = "string"
                            }
                          ]
                          publicIPAddressVersion = "string"
                          publicIPPrefix = {
                            id = "string"
                          }
                        }
                        sku = {
                          name = "string"
                          tier = "string"
                        }
                      }
                      subnet = {
                        id = "string"
                      }
                    }
                  }
                ]
                networkSecurityGroup = {
                  id = "string"
                }
                primary = bool
              }
            }
          ]
        }
        osProfile = {
          adminPassword = "string"
          adminUsername = "string"
          computerNamePrefix = "string"
          customData = "string"
          linuxConfiguration = {
            disablePasswordAuthentication = bool
            patchSettings = {
              assessmentMode = "string"
              patchMode = "string"
            }
            provisionVMAgent = bool
            ssh = {
              publicKeys = [
                {
                  keyData = "string"
                  path = "string"
                }
              ]
            }
          }
          secrets = [
            {
              sourceVault = {
                id = "string"
              }
              vaultCertificates = [
                {
                  certificateStore = "string"
                  certificateUrl = "string"
                }
              ]
            }
          ]
          windowsConfiguration = {
            additionalUnattendContent = [
              {
                componentName = "Microsoft-Windows-Shell-Setup"
                content = "string"
                passName = "OobeSystem"
                settingName = "string"
              }
            ]
            enableAutomaticUpdates = bool
            patchSettings = {
              assessmentMode = "string"
              enableHotpatching = bool
              patchMode = "string"
            }
            provisionVMAgent = bool
            timeZone = "string"
            winRM = {
              listeners = [
                {
                  certificateUrl = "string"
                  protocol = "string"
                }
              ]
            }
          }
        }
        priority = "string"
        scheduledEventsProfile = {
          terminateNotificationProfile = {
            enable = bool
            notBeforeTimeout = "string"
          }
        }
        securityProfile = {
          encryptionAtHost = bool
          securityType = "TrustedLaunch"
          uefiSettings = {
            secureBootEnabled = bool
            vTpmEnabled = bool
          }
        }
        storageProfile = {
          dataDisks = [
            {
              caching = "string"
              createOption = "string"
              diskIOPSReadWrite = int
              diskMBpsReadWrite = int
              diskSizeGB = int
              lun = int
              managedDisk = {
                diskEncryptionSet = {
                  id = "string"
                }
                storageAccountType = "string"
              }
              name = "string"
              writeAcceleratorEnabled = bool
            }
          ]
          imageReference = {
            id = "string"
            offer = "string"
            publisher = "string"
            sku = "string"
            version = "string"
          }
          osDisk = {
            caching = "string"
            createOption = "string"
            diffDiskSettings = {
              option = "Local"
              placement = "string"
            }
            diskSizeGB = int
            image = {
              uri = "string"
            }
            managedDisk = {
              diskEncryptionSet = {
                id = "string"
              }
              storageAccountType = "string"
            }
            name = "string"
            osType = "string"
            vhdContainers = [
              "string"
            ]
            writeAcceleratorEnabled = bool
          }
        }
        userData = "string"
      }
      zoneBalance = bool
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
    plan = {
      name = "string"
      product = "string"
      promotionCode = "string"
      publisher = "string"
    }
  })
}

プロパティ値

virtualMachineScaleSets

名前 説明
type リソースの種類 "Microsoft.Compute/virtualMachineScaleSets@2021-03-01"
name リソース名 string (必須)

文字制限: 1 から 15 (Windows)
1-64 (Linux)



有効な文字:
スペース、制御文字、または次の文字は使用できません:
~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?

アンダースコアで開始することはできません。 末尾をピリオドまたはハイフンにすることはできません。
location リソースの場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。
sku 仮想マシン スケール セット SKU。 SKU
extendedLocation 仮想マシン スケール セットの拡張された場所。 ExtendedLocation
identity 構成されている場合は、仮想マシン スケール セットの ID。 VirtualMachineScaleSetIdentity
plan 仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。 プラン
properties 仮想マシン スケール セットのプロパティについて説明します。 VirtualMachineScaleSetProperties
ゾーン 仮想マシン スケール セット ゾーン。 注: 可用性ゾーンは、スケール セットを作成する場合にのみ設定できます string[]

ExtendedLocation

名前 説明
name 拡張場所の名前。 string
type 拡張場所の型。 "EdgeZone"

VirtualMachineScaleSetIdentity

名前 説明
type 仮想マシン スケール セットに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシン スケール セットからすべての ID を削除します。 "SystemAssigned"
"SystemAssigned、UserAssigned"
"UserAssigned"
identity_ids 仮想マシン スケール セットに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ユーザー ID ID の配列。

VirtualMachineScaleSetIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} VirtualMachineScaleSetIdentityUserAssignedIdentities...

VirtualMachineScaleSetIdentityUserAssignedIdentities...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

プラン

名前 説明
name プラン ID。 string
product マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。 string
promotionCode 販売促進コード。 string
publisher 発行元 ID。 string

VirtualMachineScaleSetProperties

名前 説明
additionalCapabilities 仮想マシン スケール セットのVirtual Machinesで有効または無効にする追加機能を指定します。 たとえば、ストレージ アカウントの種類を持つマネージド データ ディスクのアタッチをサポートする機能がVirtual MachinesにあるかどうかUltraSSD_LRS。 AdditionalCapabilities
automaticRepairsPolicy 自動修復のポリシー。 AutomaticRepairsPolicy
doNotRunExtensionsOnOverprovisionedVMs オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。 [bool]
hostGroup 仮想マシン スケール セットが存在する専用ホスト グループに関する情報を指定します。

最小 api-version: 2020-06-01。
サブリソース
orchestrationMode 仮想マシン スケール セットのオーケストレーション モードを指定します。 "フレキシブル"
"Uniform"
overprovision 仮想マシン スケール セットをオーバープロビジョニングするかどうかを指定します。 [bool]
platformFaultDomainCount 各配置グループの障害ドメイン数。 INT
proximityPlacementGroup 仮想マシン スケール セットを割り当てる必要がある近接配置グループに関する情報を指定します。

最小 api-version: 2018-04-01。
サブリソース
scaleInPolicy 仮想マシン スケール セットをスケールインするときに削除する仮想マシンを決定するスケールイン ポリシーを指定します。 ScaleInPolicy
singlePlacementGroup true の場合、スケール セットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更できます。 ただし、singlePlacementGroup が false の場合は、true に変更できません。 [bool]
upgradePolicy アップグレード ポリシー。 UpgradePolicy
virtualMachineProfile 仮想マシン プロファイル。 VirtualMachineScaleSetVMProfile
zoneBalance ゾーンの停止が発生した場合に備えて、仮想マシンの配布を厳密に X ゾーン間で強制するかどうか。 [bool]

AdditionalCapabilities

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

AutomaticRepairsPolicy

名前 説明
enabled 仮想マシン スケール セットで自動修復を有効にするかどうかを指定します。 既定値は false です。 [bool]
gracePeriod VM の状態の変更により自動修復が中断される時間。 猶予期間は、状態の変更が完了した後に開始されます。 これは、早期または偶発的な修復を回避するのに役立ちます。 期間は ISO 8601 形式で指定する必要があります。 許容される最小猶予期間は 30 分 (PT30M) で、既定値でもあります。 許可される猶予期間の上限は 90 分 (PT90M) です。 string

サブリソース

名前 説明
id リソース ID string

ScaleInPolicy

名前 説明
rules 仮想マシン スケール セットをスケーリングするときに従う規則。

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

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

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

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

次のいずれかを含む文字列配列:
"Default"
"NewestVM"
"OldestVM"

UpgradePolicy

名前 説明
automaticOSUpgradePolicy OS の自動アップグレードを実行するために使用される構成パラメーター。 AutomaticOSUpgradePolicy
mode スケール セット内の仮想マシンへのアップグレードモードを指定します。

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

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

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。
"自動"
"Manual"
"ローリング"
rollingUpgradePolicy ローリング アップグレードの実行中に使用される構成パラメーター。 RollingUpgradePolicy

AutomaticOSUpgradePolicy

名前 説明
disableAutomaticRollback OS イメージのロールバック機能を無効にするかどうか。 既定値は false です。 [bool]
enableAutomaticOSUpgrade 新しいバージョンの OS イメージが使用可能になったときに、スケール セット インスタンスに OS アップグレードを自動的に適用するかどうかを示します。 既定値は false です。

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

RollingUpgradePolicy

名前 説明
enableCrossZoneUpgrade アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、Update Domain と maxBatchInstancePercent を考慮してください。 [bool]
maxBatchInstancePercent 1 つのバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計の最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるために、バッチ内のインスタンスの割合が減少する可能性があります。 このパラメーターの既定値は 20% です。 INT

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

制約:
最小値 = 5
最大値 = 100
maxUnhealthyUpgradedInstancePercent 異常な状態にあることが検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に発生します。 この割合を超えた場合、ローリング 更新プログラムは中止されます。 このパラメーターの既定値は 20% です。 INT

制約:
最小値 = 0
最大値 = 100
pauseTimeBetweenBatches すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。 string
prioritizeUnhealthyInstances 正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 [bool]

VirtualMachineScaleSetVMProfile

名前 説明
billingProfile Azure Spot VMSS の課金関連の詳細を指定します。

最小 api-version: 2019-03-01。
BillingProfile
diagnosticsProfile ブート診断設定の状態を指定します。

最小 api-version: 2015-06-15。
DiagnosticsProfile
evictionPolicy Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。

Azure Spot 仮想マシンでは、'Deallocate' と 'Delete' の両方がサポートされており、api-version の最小値は 2019-03-01 です。

Azure スポット スケール セットでは、'Deallocate' と 'Delete' の両方がサポートされており、api-version の最小は 2017-10-30-preview です。
"割り当て解除"
"削除"
extensionProfile スケール セット内の仮想マシンにインストールされる拡張機能の設定のコレクションを指定します。 VirtualMachineScaleSetExtensionProfile
licenseType 使用されているイメージまたはディスクがオンプレミスでライセンスされたことを指定します。

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

Windows_Client

Windows_Server

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

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

詳細については、「Windows Server の Azure ハイブリッド使用特典」を参照してください。

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

最小 api-version: 2015-06-15
string
networkProfile スケール セット内の仮想マシンのネットワーク インターフェイスのプロパティを指定します。 VirtualMachineScaleSetNetworkProfile
osProfile スケール セット内の仮想マシンのオペレーティング システム設定を指定します。 VirtualMachineScaleSetOSProfile
priority スケール セット内の仮想マシンの優先順位を指定します。

最小 api-version: 2017-10-30-preview
"Low"
"Regular"
"スポット"
scheduledEventsProfile スケジュールされたイベント関連の構成を指定します。 ScheduledEventsProfile
securityProfile スケール セット内の仮想マシンのセキュリティ関連のプロファイル設定を指定します。 SecurityProfile
storageProfile 仮想マシンのストレージ設定を指定します。 VirtualMachineScaleSetStorageProfile
Userdata スケール セット内の仮想マシンの UserData。Base-64 でエンコードする必要があります。 顧客はここでシークレットを渡すべきではありません。

最小 api-version: 2021-03-01
string

BillingProfile

名前 説明
maxPrice Azure スポット VM/VMSS に対して支払う最大料金を指定します。 この価格は米ドルです。

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

現在の Azure スポット価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は Azure スポット VM/VMSS の削除にも使用されます。

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

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

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

maxPrice を -1 に設定すると、価格上の理由から Azure Spot VM/VMSS を削除しないように指定できます。 また、既定の最大価格は、提供されていない場合は -1 です。

最小 api-version: 2019-03-01。 文字列として 10 進値を指定します。
int または json decimal

DiagnosticsProfile

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

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

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

BootDiagnostics

名前 説明
enabled 仮想マシンでブート 診断を有効にする必要があるかどうか。 [bool]
storageUri コンソール出力とスクリーンショットを配置するために使用するストレージ アカウントの URI。

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

VirtualMachineScaleSetExtensionProfile

名前 説明
拡張機能 仮想マシン スケール セットの子拡張機能リソース。 VirtualMachineScaleSetExtension[]
extensionsTimeBudget すべての拡張機能の開始時間を指定します。 期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。 既定値は 90 分 (PT1H30M)。

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

VirtualMachineScaleSetExtension

名前 説明
name 拡張機能の名前です。 string
properties 仮想マシン スケール セット拡張機能のプロパティについて説明します。 VirtualMachineScaleSetExtensionProperties

VirtualMachineScaleSetExtensionProperties

名前 説明
autoUpgradeMinorVersion 展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用するかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。 [bool]
enableAutomaticUpgrade 使用可能な拡張機能の新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。 [bool]
forceUpdateTag 値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。 string
protectedSettings 拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることも、保護された設定をまったく含めることもできます。
provisionAfterExtensions この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。 string[]
publisher 拡張ハンドラーパブリッシャーの名前。 string
settings 拡張機能の Json 形式のパブリック設定。
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。 string
typeHandlerVersion スクリプト ハンドラーのバージョンを指定します。 string

VirtualMachineScaleSetNetworkProfile

名前 説明
healthProbe 仮想マシン スケール セット内のインスタンスの正常性を判断するために使用されるロード バランサー プローブへの参照。 参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}' の形式になります。 ApiEntityReference
networkApiVersion は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します "2020-11-01"
networkInterfaceConfigurations ネットワーク構成の一覧。 VirtualMachineScaleSetNetworkConfiguration[]

ApiEntityReference

名前 説明
id /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。 string

VirtualMachineScaleSetNetworkConfiguration

名前 説明
id リソース ID string
name ネットワーク構成名。 string (必須)
properties 仮想マシン スケール セット ネットワーク プロファイルの IP 構成について説明します。 VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationProperties

名前 説明
deleteOption VM が削除されたときのネットワーク インターフェイスの動作を指定する "削除"
"デタッチ"
dnsSettings ネットワーク インターフェイスに適用される DNS 設定。 VirtualMachineScaleSetNetworkConfigurationDnsSetting...
enableAcceleratedNetworking ネットワーク インターフェイスが高速ネットワーク対応かどうかを指定します。 [bool]
enableFpga ネットワーク インターフェイスが FPGA ネットワーク対応かどうかを指定します。 [bool]
enableIPForwarding この NIC で IP 転送が有効になっているかどうか。 [bool]
ipConfigurations ネットワーク インターフェイスの IP 構成を指定します。 VirtualMachineScaleSetIPConfiguration[] (必須)
networkSecurityGroup ネットワーク セキュリティ グループ。 サブリソース
更新 仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合のプライマリ ネットワーク インターフェイスを指定します。 [bool]

VirtualMachineScaleSetNetworkConfigurationDnsSetting...

名前 説明
dnsServers DNS サーバーの IP アドレスの一覧 string[]

VirtualMachineScaleSetIPConfiguration

名前 説明
id リソース ID string
name IP 構成名。 string (必須)
properties 仮想マシン スケール セットネットワーク プロファイルの IP 構成プロパティについて説明します。 VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties

名前 説明
applicationGatewayBackendAddressPools アプリケーション ゲートウェイのバックエンド アドレス プールへの参照の配列を指定します。 スケール セットは、複数のアプリケーション ゲートウェイのバックエンド アドレス プールを参照できます。 複数のスケール セットで同じアプリケーション ゲートウェイを使用することはできません。 SubResource[]
applicationSecurityGroups アプリケーション セキュリティ グループへの参照の配列を指定します。 SubResource[]
loadBalancerBackendAddressPools ロード バランサーのバックエンド アドレス プールへの参照の配列を指定します。 スケール セットは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーのバックエンド アドレス プールを参照できます。 複数のスケール セットで同じ Basic SKU ロード バランサーを使用することはできません。 SubResource[]
loadBalancerInboundNatPools ロード バランサーの受信 Nat プールへの参照の配列を指定します。 スケール セットは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーの受信 nat プールを参照できます。 複数のスケール セットで同じ Basic SKU ロード バランサーを使用することはできません。 SubResource[]
更新 仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合のプライマリ ネットワーク インターフェイスを指定します。 [bool]
privateIPAddressVersion Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 "IPv4"
"IPv6"
publicIPAddressConfiguration publicIPAddressConfiguration。 VirtualMachineScaleSetPublicIPAddressConfiguration
サブネット サブネットの識別子を指定します。 ApiEntityReference

VirtualMachineScaleSetPublicIPAddressConfiguration

名前 説明
name publicIP アドレス構成名。 string (必須)
properties 仮想マシン スケール セットの IP 構成の PublicIPAddress 構成について説明します VirtualMachineScaleSetPublicIPAddressConfigurationPr...
sku パブリック IP SKU について説明します PublicIPAddressSku

VirtualMachineScaleSetPublicIPAddressConfigurationPr...

名前 説明
deleteOption VM が削除されたときのパブリック IP の動作を指定する "削除"
"デタッチ"
dnsSettings publicIP アドレスに適用される DNS 設定。 VirtualMachineScaleSetPublicIPAddressConfigurationDn...
idleTimeoutInMinutes パブリック IP アドレスのアイドル タイムアウト。 INT
ipTags パブリック IP アドレスに関連付けられている IP タグの一覧。 VirtualMachineScaleSetIpTag[]
publicIPAddressVersion Api-Version 2019-07-01 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。 "IPv4"
"IPv6"
publicIPPrefix publicIP アドレスの割り当て元となる PublicIPPrefix。 サブリソース

VirtualMachineScaleSetPublicIPAddressConfigurationDn...

名前 説明
domainNameLabel ドメイン名ラベル。ドメイン名ラベルと vm インデックスの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります string (必須)

VirtualMachineScaleSetIpTag

名前 説明
ipTagType IP タグの種類。 例: FirstPartyUsage。 string
タグ パブリック IP に関連付けられている IP タグ。 例: SQL、Storage など string

PublicIPAddressSku

名前 説明
name パブリック IP SKU 名を指定する "Basic"
"Standard"
レベル パブリック IP SKU レベルを指定する "Global"
"地域"

VirtualMachineScaleSetOSProfile

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

最小長 (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、チェックまたは修復する」を参照してください。
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
adminUsername 管理者アカウントの名前を指定します。

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"、"test2"、"test3"、"user4"、"user5"。

最小長 (Linux): 1 文字

最大長 (Linux): 64 文字

最大長 (Windows): 20 文字
string
computerNamePrefix スケール セット内のすべての仮想マシンのコンピューター名プレフィックスを指定します。 コンピューター名のプレフィックスは、1 から 15 文字の長さにする必要があります。 string
customData カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。

VM に cloud-init を使用する場合は、「cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。
string
linuxConfiguration 仮想マシン上の Linux オペレーティング システムの設定を指定します。

サポートされている Linux ディストリビューションの一覧については、「Linux on Azure-Endorsed Distributions」を参照してください。
LinuxConfiguration
secrets スケール セット内の仮想マシンにインストールする必要がある証明書のセットを指定します。 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。 VaultSecretGroup[]
windowsConfiguration 仮想マシン上の Windows オペレーティング システムの設定を指定します。 WindowsConfiguration

LinuxConfiguration

名前 説明
disablePasswordAuthentication パスワード認証を無効にするかどうかを指定します。 [bool]
patchSettings [プレビュー機能]Linux での VM ゲストパッチ適用に関連する設定を指定します。 LinuxPatchSettings
provisionVMAgent 仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

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

LinuxPatchSettings

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

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

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

AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。
"AutomaticByPlatform"
"ImageDefault"
patchMode OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシン スケール セットに関連付けられている仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

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

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

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

SshConfiguration

名前 説明
publicKeys Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。 SshPublicKey[]

SshPublicKey

名前 説明
keyData SSH を使用して VM で認証するために使用される SSH 公開キー証明書。 キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。

SSH キーの作成については、「Azure の Linux VM 用 Linux および Mac で SSH キーを作成する」/「azure/virtual-machines/linux/create-ssh-keys-detailed」を参照してください。
string
path ssh 公開キーが格納されている、作成された VM 上の完全なパスを指定します。 ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。 例: /home/user/.ssh/authorized_keys string

VaultSecretGroup

名前 説明
sourceVault VaultCertificates 内のすべての証明書を含むKey Vaultの相対 URL。 サブリソース
vaultCertificates 証明書を含む SourceVault のキー コンテナー参照の一覧。 VaultCertificate[]

VaultCertificate

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

Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、ファイル名 <は X509 証明書ファイルの場合は UppercaseThumbprint.crt>、 <秘密キーの場合は UppercaseThumbprint.prv> です。 これらのファイルはどちらも .pem 形式です。
string
certificateUrl これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キー コンテナーにキーまたはシークレットを追加する」を参照してください。 この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。
string

WindowsConfiguration

名前 説明
additionalUnattendContent Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。 AdditionalUnattendContent[]
enableAutomaticUpdates Windows 仮想マシンに対して自動更新が有効になっているかどうかを示します。 既定値は true です。

仮想マシン スケール セットの場合、このプロパティを更新でき、更新は OS の再プロビジョニングで有効になります。
[bool]
patchSettings [プレビュー機能]Windows での VM ゲストパッチ適用に関連する設定を指定します。 PatchSettings
provisionVMAgent 仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
[bool]
timeZone 仮想マシンのタイム ゾーンを指定します。 例: "太平洋標準時"

指定できる値は、TimeZoneInfo.GetSystemTimeZones によって返されるタイム ゾーンから値を TimeZoneInfo.Id できます。
string
Winrm Windows リモート管理リスナーを指定します。 これによって、リモートの Windows PowerShell が有効になります。 WinRMConfiguration

AdditionalUnattendContent

名前 説明
componentName コンポーネントの名前。 現在、許容される値は Microsoft-Windows-Shell-Setup のみです。 "Microsoft-Windows-Shell-Setup"
content 指定したパスとコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満である必要があり、挿入される設定または機能のルート要素を含める必要があります。 string
passName パス名。 現在、許容される値は OobeSystem のみです。 "OobeSystem"
settingName コンテンツが適用される設定の名前を指定します。 使用できる値は、FirstLogonCommands と AutoLogon です。 "AutoLogon"
"FirstLogonCommands"

PatchSettings

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

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

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

AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。
"AutomaticByPlatform"
"ImageDefault"
enableHotpatching 再起動を必要とせずに、お客様が Azure VM にパッチを適用できるようにします。 enableHotpatching の場合、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。 [bool]
patchMode OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシン スケール セットに関連付けられている仮想マシンへの VM ゲスト パッチ適用のモードを指定します。

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

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

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

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

WinRMConfiguration

名前 説明
リスナー Windows リモート管理リスナーの一覧 WinRMListener[]

WinRMListener

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

{
"data":"{Base64-encoded-certificate}",
"dataType":"pfx",
"password":"{pfx-file-password}"
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。
string
protocol WinRM リスナーのプロトコルを指定します。

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

https
"Http"
"Https"

ScheduledEventsProfile

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

TerminateNotificationProfile

名前 説明
有効化 (enable) Terminate Scheduled イベントを有効にするか無効にするかを指定します。 [bool]
notBeforeTimeout 削除される仮想マシンの構成可能な時間は、イベントが自動的に承認される (タイムアウト) 前に、スケジュールされた終了イベントを承認する必要があります。 構成は ISO 8601 形式で指定する必要があります。既定値は 5 分 (PT5M) です string

SecurityProfile

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

既定値: リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。
[bool]
securityType 仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch として設定されていない限り、UefiSettings は有効になりません。
"TrustedLaunch"
uefiSettings 仮想マシンの作成時に使用されるセキュア ブートや vTPM などのセキュリティ設定を指定します。

最小 api-version: 2020-12-01
UefiSettings

UefiSettings

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

最小 api-version: 2020-12-01
[bool]
vTpmEnabled 仮想マシンで vTPM を有効にするかどうかを指定します。

最小 api-version: 2020-12-01
[bool]

VirtualMachineScaleSetStorageProfile

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

ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
VirtualMachineScaleSetDataDisk[]
imageReference 使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。 ImageReference
osDisk スケール セット内の仮想マシンによって使用されるオペレーティング システム ディスクに関する情報を指定します。

ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。
VirtualMachineScaleSetOSDisk

VirtualMachineScaleSetDataDisk

名前 説明
キャッシュ キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値: Standard Storage の場合はなし。Premium Storage の ReadOnly
"None"
"ReadOnly"
"ReadWrite"
createOption create オプション。 "アタッチ"
"Empty"
"FromImage" (必須)
diskIOPSReadWrite マネージド ディスクの Read-Write IOPS を指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。 INT
diskMBpsReadWrite マネージド ディスクの帯域幅を 1 秒あたりの MB 単位で指定します。 StorageAccountType がUltraSSD_LRSされている場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。 INT
diskSizeGB 空のデータ ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。

この値は 1023 GB より大きくすることはできません
INT
lun データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。 int (必須)
managedDisk マネージド ディスクのパラメーター。 VirtualMachineScaleSetManagedDiskParameters
name ディスク名。 string
writeAcceleratorEnabled ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 [bool]

VirtualMachineScaleSetManagedDiskParameters

名前 説明
diskEncryptionSet マネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。 DiskEncryptionSetParameters
storageAccountType マネージド ディスクのストレージ アカウントの種類を指定します。 注: UltraSSD_LRSはデータ ディスクでのみ使用できます。OS ディスクでは使用できません。 "Premium_LRS"
"Premium_ZRS"
"StandardSSD_LRS"
"StandardSSD_ZRS"
"Standard_LRS"
"UltraSSD_LRS"

DiskEncryptionSetParameters

名前 説明
id リソース ID string

ImageReference

名前 説明
id リソース ID string
offer 仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのオファーを指定します。 string
publisher イメージの発行元。 string
sku イメージ SKU。 string
version 仮想マシンの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージのバージョンを指定します。 使用できる形式は Major.Minor.Build または 'latest' です。 メジャー、マイナー、ビルドは 10 進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 'latest' を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ後に VM イメージは自動的に更新されません。 string

VirtualMachineScaleSetOSDisk

名前 説明
キャッシュ キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値: Standard Storage の場合はなし。Premium Storage の ReadOnly
"None"
"ReadOnly"
"ReadWrite"
createOption スケール セット内の仮想マシンの作成方法を指定します。

使用できる値は FromImage \u2013 のみです。この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用します。
"アタッチ"
"Empty"
"FromImage" (必須)
diffDiskSettings 仮想マシン スケール セットで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 DiffDiskSettings
diskSizeGB オペレーティング システム ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。

この値は 1023 GB より大きくすることはできません
INT
image スケール セットの基にするアンマネージド ユーザー イメージに関する情報を指定します。 VirtualHardDisk
managedDisk マネージド ディスクのパラメーター。 VirtualMachineScaleSetManagedDiskParameters
name ディスク名。 string
osType このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。

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

Windows

Linux
"Linux"
"Windows"
vhdContainers スケール セットのオペレーティング システム ディスクの格納に使用するコンテナー URL を指定します。 string[]
writeAcceleratorEnabled ディスクで writeAccelerator を有効または無効にするかどうかを指定します。 [bool]

DiffDiskSettings

名前 説明
オプション オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。 "Local"
配置 オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。

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

CacheDisk

ResourceDisk

既定値: VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk が使用されます。

キャッシュ ディスクを公開する VM サイズをチェックするには、/azure/virtual-machines/windows/sizes の Windows VM と /azure/virtual-machines/linux/size の Linux VM の VM サイズに関するドキュメントを参照してください。
"CacheDisk"
"ResourceDisk"

VirtualHardDisk

名前 説明
uri 仮想ハード ディスクの URI を指定します。 string

Sku

名前 説明
capacity スケール セット内の仮想マシンの数を指定します。 INT
name SKU 名。 string
レベル スケール セット内の仮想マシンの層を指定します。

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

Standard

Basic
string