共用方式為

Microsoft.Compute virtualMachineScaleSets/virtualmachines 2020-12-01

  • 發行項

Bicep 資源定義

virtualMachineScaleSets/virtualmachines 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualmachines 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-12-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  plan: {
    name: 'string'
    product: 'string'
    promotionCode: 'string'
    publisher: 'string'
  }
  properties: {
    additionalCapabilities: {
      ultraSSDEnabled: bool
    }
    availabilitySet: {
      id: 'string'
    }
    diagnosticsProfile: {
      bootDiagnostics: {
        enabled: bool
        storageUri: 'string'
      }
    }
    hardwareProfile: {
      vmSize: 'string'
    }
    licenseType: 'string'
    networkProfile: {
      networkInterfaces: [
        {
          id: 'string'
          properties: {
            primary: bool
          }
        }
      ]
    }
    networkProfileConfiguration: {
      networkInterfaceConfigurations: [
        {
          id: 'string'
          name: 'string'
          properties: {
            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: {
                      dnsSettings: {
                        domainNameLabel: 'string'
                      }
                      idleTimeoutInMinutes: int
                      ipTags: [
                        {
                          ipTagType: 'string'
                          tag: 'string'
                        }
                      ]
                      publicIPAddressVersion: 'string'
                      publicIPPrefix: {
                        id: 'string'
                      }
                    }
                  }
                  subnet: {
                    id: 'string'
                  }
                }
              }
            ]
            networkSecurityGroup: {
              id: 'string'
            }
            primary: bool
          }
        }
      ]
    }
    osProfile: {
      adminPassword: 'string'
      adminUsername: 'string'
      allowExtensionOperations: bool
      computerName: 'string'
      customData: 'string'
      linuxConfiguration: {
        disablePasswordAuthentication: bool
        patchSettings: {
          patchMode: 'string'
        }
        provisionVMAgent: bool
        ssh: {
          publicKeys: [
            {
              keyData: 'string'
              path: 'string'
            }
          ]
        }
      }
      requireGuestProvisionSignal: bool
      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: {
          enableHotpatching: bool
          patchMode: 'string'
        }
        provisionVMAgent: bool
        timeZone: 'string'
        winRM: {
          listeners: [
            {
              certificateUrl: 'string'
              protocol: 'string'
            }
          ]
        }
      }
    }
    protectionPolicy: {
      protectFromScaleIn: bool
      protectFromScaleSetActions: bool
    }
    securityProfile: {
      encryptionAtHost: bool
      securityType: 'string'
      uefiSettings: {
        secureBootEnabled: bool
        vTpmEnabled: bool
      }
    }
    storageProfile: {
      dataDisks: [
        {
          caching: 'string'
          createOption: 'string'
          detachOption: 'string'
          diskSizeGB: int
          image: {
            uri: 'string'
          }
          lun: int
          managedDisk: {
            diskEncryptionSet: {
              id: 'string'
            }
            id: 'string'
            storageAccountType: 'string'
          }
          name: 'string'
          toBeDetached: bool
          vhd: {
            uri: 'string'
          }
          writeAcceleratorEnabled: bool
        }
      ]
      imageReference: {
        id: 'string'
        offer: 'string'
        publisher: 'string'
        sku: 'string'
        version: 'string'
      }
      osDisk: {
        caching: 'string'
        createOption: 'string'
        diffDiskSettings: {
          option: 'string'
          placement: 'string'
        }
        diskSizeGB: int
        encryptionSettings: {
          diskEncryptionKey: {
            secretUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
          enabled: bool
          keyEncryptionKey: {
            keyUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
        }
        image: {
          uri: 'string'
        }
        managedDisk: {
          diskEncryptionSet: {
            id: 'string'
          }
          id: 'string'
          storageAccountType: 'string'
        }
        name: 'string'
        osType: 'string'
        vhd: {
          uri: 'string'
        }
        writeAcceleratorEnabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

AdditionalCapabilities

名字 描述 價值
ultraSSDEnabled 旗標，可讓或停用在 VM 或 VMSS 上具有一或多個具有 UltraSSD_LRS記憶體帳戶類型的受控數據磁碟。 只有啟用此屬性，才能將具有記憶體帳戶類型的受控磁碟UltraSSD_LRS新增至虛擬機或虛擬機擴展集。 bool

AdditionalUnattendContent

名字 描述 價值
componentName 元件名稱。 目前，唯一允許的值是 Microsoft-Windows-Shell-Setup。 'Microsoft-Windows-Shell-Setup'
內容 指定新增至指定路徑和元件之 unattend.xml 檔案的 XML 格式化內容。 XML 必須小於 4KB，而且必須包含要插入之設定或功能的根元素。 字串
passName 傳遞名稱。 目前唯一允許的值是 OobeSystem。 'OobeSystem'
settingName 指定套用內容之設定的名稱。 可能的值為：FirstLogonCommands 和 AutoLogon。 'AutoLogon'
'FirstLogonCommands'

ApiEntityReference

名字 描述 價值
id 以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符 字串

BootDiagnostics

名字 描述 價值
啟用 是否應在虛擬機上啟用開機診斷。 bool
storageUri 用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。

如果在啟用開機診斷時未指定 storageUri，則會使用受控記憶體。		 字串

DataDisk

名字 描述 價值
緩存 指定快取需求。

可能的值為：

無

ReadOnly

ReadWrite

預設值：標準記憶體 None。進階記憶體的 ReadOnly		 'None'
'ReadOnly'
'ReadWrite'
createOption 指定應如何建立虛擬機。

可能的值為：

附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。

FromImage \u2013 當您使用映射建立虛擬機時，會使用此值。 如果您使用平臺映像，則也會使用上述的 imageReference 元素。 如果您使用市集映像，則也會使用先前所述的 plan 元素。		 'Attach'
'Empty'
'FromImage' （必要）
detachOption 指定卸離磁碟時所要使用的卸離行為，或已在從虛擬機中斷鏈接的過程中使用的行為。 支援的值：ForceDetach。

detachOption：ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁盤中斷鏈接嘗試未完成，因為虛擬機發生非預期的失敗，磁碟仍未釋放，則請使用強制卸離作為最後手段選項，強制中斷連結磁碟與 VM。 使用這個卸離行為時，所有寫入可能都沒有排清。

此功能仍處於預覽模式，VirtualMachineScaleSet 不支援此功能。 若要強制將數據磁碟更新強制卸離至 『true』，以及設定 detachOption： 'ForceDetach'。		 'ForceDetach'
diskSizeGB 指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB		 int
圖像 來源使用者映像虛擬硬碟。 在連接至虛擬機之前，將會先複製虛擬硬碟。 如果提供SourceImage，則目的地虛擬硬碟不得存在。 VirtualHardDisk
倫 指定數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。 int （必要）
managedDisk 受控磁碟參數。 ManagedDiskParameters
名字 磁碟名稱。 字串
toBeDetached 指定數據磁碟是否正在從 VirtualMachine/VirtualMachineScaleset 中斷連結 bool
vhd 虛擬硬碟。 VirtualHardDisk
writeAcceleratorEnabled 指定是否應該在磁碟上啟用或停用 writeAccelerator。 bool

DiagnosticsProfile

名字 描述 價值
bootDiagnostics 開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。

您可以輕鬆地檢視主控台記錄的輸出。

Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。		 BootDiagnostics

DiffDiskSettings

名字 描述 價值
選擇 指定作業系統磁碟的暫時磁碟設定。 'Local'
放置 指定作業系統磁碟的暫時磁碟位置。

可能的值為：

CacheDisk

ResourceDisk

默認值：如果已針對 VM 大小設定快取Disk ，否則會使用 resourceDisk 。

請參閱 /azure/virtual-machines/windows/size 和 Linux VM 在 /azure/virtual-machines/linux/size 上 Windows VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。		 'CacheDisk'
'ResourceDisk'

DiskEncryptionSetParameters

名字 描述 價值
id 資源標識碼 字串

DiskEncryptionSettings

名字 描述 價值
diskEncryptionKey 指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。 KeyVaultSecretReference
啟用 指定是否應在虛擬機上啟用磁碟加密。 bool
keyEncryptionKey 指定 Key Vault 中金鑰加密金鑰的位置。 KeyVaultKeyReference

HardwareProfile

名字 描述 價值
vmSize 指定虛擬機的大小。

列舉數據類型目前已被取代，將於 2023 年 12 月 23 日移除。

取得可用大小清單的建議方式是使用這些 API：

列出可用性設定組中的所有可用虛擬機大小

列出區域中所有可用的虛擬機大小

列出調整大小的所有可用虛擬機大小。 如需虛擬機器大小的詳細資訊，請參閱 虛擬機的大小。

可用的 VM 大小取決於區域和可用性設定組。		 'Basic_A0'
'Basic_A1'
'Basic_A2'
'Basic_A3'
'Basic_A4'
'Standard_A0'
'Standard_A1'
'Standard_A10'
'Standard_A11'
'Standard_A1_v2'
'Standard_A2'
'Standard_A2m_v2'
'Standard_A2_v2'
'Standard_A3'
'Standard_A4'
'Standard_A4m_v2'
'Standard_A4_v2'
'Standard_A5'
'Standard_A6'
'Standard_A7'
'Standard_A8'
'Standard_A8m_v2'
'Standard_A8_v2'
'Standard_A9'
'Standard_B1ms'
'Standard_B1s'
'Standard_B2ms'
'Standard_B2s'
'Standard_B4ms'
'Standard_B8ms'
'Standard_D1'
'Standard_D11'
'Standard_D11_v2'
'Standard_D12'
'Standard_D12_v2'
'Standard_D13'
'Standard_D13_v2'
'Standard_D14'
'Standard_D14_v2'
'Standard_D15_v2'
'Standard_D16s_v3'
'Standard_D16_v3'
'Standard_D1_v2'
'Standard_D2'
'Standard_D2s_v3'
'Standard_D2_v2'
'Standard_D2_v3'
'Standard_D3'
'Standard_D32s_v3'
'Standard_D32_v3'
'Standard_D3_v2'
'Standard_D4'
'Standard_D4s_v3'
'Standard_D4_v2'
'Standard_D4_v3'
'Standard_D5_v2'
'Standard_D64s_v3'
'Standard_D64_v3'
'Standard_D8s_v3'
'Standard_D8_v3'
'Standard_DS1'
'Standard_DS11'
'Standard_DS11_v2'
'Standard_DS12'
'Standard_DS12_v2'
'Standard_DS13'
'Standard_DS13-2_v2'
'Standard_DS13-4_v2'
'Standard_DS13_v2'
'Standard_DS14'
'Standard_DS14-4_v2'
'Standard_DS14-8_v2'
'Standard_DS14_v2'
'Standard_DS15_v2'
'Standard_DS1_v2'
'Standard_DS2'
'Standard_DS2_v2'
'Standard_DS3'
'Standard_DS3_v2'
'Standard_DS4'
'Standard_DS4_v2'
'Standard_DS5_v2'
'Standard_E16s_v3'
'Standard_E16_v3'
'Standard_E2s_v3'
'Standard_E2_v3'
'Standard_E32-16_v3'
'Standard_E32-8s_v3'
'Standard_E32s_v3'
'Standard_E32_v3'
'Standard_E4s_v3'
'Standard_E4_v3'
'Standard_E64-16s_v3'
'Standard_E64-32s_v3'
'Standard_E64s_v3'
'Standard_E64_v3'
'Standard_E8s_v3'
'Standard_E8_v3'
'Standard_F1'
'Standard_F16'
'Standard_F16s'
'Standard_F16s_v2'
'Standard_F1s'
'Standard_F2'
'Standard_F2s'
'Standard_F2s_v2'
'Standard_F32s_v2'
'Standard_F4'
'Standard_F4s'
'Standard_F4s_v2'
'Standard_F64s_v2'
'Standard_F72s_v2'
'Standard_F8'
'Standard_F8s'
'Standard_F8s_v2'
'Standard_G1'
'Standard_G2'
'Standard_G3'
'Standard_G4'
'Standard_G5'
'Standard_GS1'
'Standard_GS2'
'Standard_GS3'
'Standard_GS4'
'Standard_GS4-4'
'Standard_GS4-8'
'Standard_GS5'
'Standard_GS5-16'
'Standard_GS5-8'
'Standard_H16'
'Standard_H16m'
'Standard_H16mr'
'Standard_H16r'
'Standard_H8'
'Standard_H8m'
'Standard_L16s'
'Standard_L32s'
'Standard_L4s'
'Standard_L8s'
'Standard_M128-32ms'
'Standard_M128-64ms'
'Standard_M128ms'
'Standard_M128s'
'Standard_M64-16ms'
'Standard_M64-32ms'
'Standard_M64ms'
'Standard_M64s'
'Standard_NC12'
'Standard_NC12s_v2'
'Standard_NC12s_v3'
'Standard_NC24'
'Standard_NC24r'
'Standard_NC24rs_v2'
'Standard_NC24rs_v3'
'Standard_NC24s_v2'
'Standard_NC24s_v3'
'Standard_NC6'
'Standard_NC6s_v2'
'Standard_NC6s_v3'
'Standard_ND12s'
'Standard_ND24rs'
'Standard_ND24s'
'Standard_ND6s'
'Standard_NV12'
'Standard_NV24'
'Standard_NV6'

ImageReference

名字 描述 價值
id 資源標識碼 字串
提供 指定用來建立虛擬機的平臺映像或市集映像供應專案。 字串
發行人 映像發行者。 字串
sku 映像 SKU。 字串
版本 指定用來建立虛擬機的平臺映像或市集映像版本。 允許的格式為 Major.Minor.Build 或 'latest'。 主要、次要和組建是十進位數。 指定 'latest' 以在部署時間使用可用映像的最新版本。 即使您使用「最新」，即使有新版本可用，VM 映像也不會在部署時間之後自動更新。 字串

KeyVaultKeyReference

名字 描述 價值
keyUrl 參考 Key Vault 中金鑰加密金鑰的 URL。 字串 （必要）
sourceVault 包含金鑰之 Key Vault 的相對 URL。 SubResource （必要）

KeyVaultSecretReference

名字 描述 價值
secretUrl 參考 Key Vault 中秘密的 URL。 字串 （必要）
sourceVault 包含秘密之 Key Vault 的相對 URL。 SubResource （必要）

LinuxConfiguration

名字 描述 價值
disablePasswordAuthentication 指定是否應停用密碼驗證。 bool
patchSettings [預覽功能]指定與Linux上的VM客體修補相關的設定。 LinuxPatchSettings
provisionVMAgent 指出虛擬機器代理程式是否應該佈建在虛擬機上。

當要求本文中未指定此屬性時，預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。		 bool
ssh 指定 Linux OS 的 SSH 金鑰組態。 SshConfiguration

LinuxPatchSettings

名字 描述 價值
patchMode 指定 VM 客體修補至 IaaS 虛擬機的模式。

可能的值為：

ImageDefault - 會使用虛擬機的預設修補組態。

AutomaticByPlatform - 虛擬機將由平台自動更新。 屬性 provisionVMAgent 必須為 true		 'AutomaticByPlatform'
'ImageDefault'

ManagedDiskParameters

名字 描述 價值
diskEncryptionSet 指定受控磁碟的客戶受控磁碟加密集資源標識符。 DiskEncryptionSetParameters
id 資源標識碼 字串
storageAccountType 指定受控磁碟的記憶體帳戶類型。 只有當您建立擴展集時，才能設定受控 OS 磁碟記憶體帳戶類型。 注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。 'Premium_LRS'
'Premium_ZRS'
'StandardSSD_LRS'
'StandardSSD_ZRS'
'Standard_LRS'
'UltraSSD_LRS'

Microsoft.Compute/virtualMachineScaleSets/virtualmachines

名字 描述 價值
位置 資源位置 字串 （必要）
名字 資源名稱 字串 （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：virtualMachineScaleSets
計劃 指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用，才能從 API 使用市集映射。 在 Azure 入口網站中，尋找您想要使用的市集映像，然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊，然後按下 [儲存]。 計劃
性能 描述虛擬機擴展集虛擬機的屬性。 VirtualMachineScaleSetVMProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

NetworkInterfaceReference

名字 描述 價值
id 資源標識碼 字串
性能 描述網路介面參考屬性。 NetworkInterfaceReferenceProperties

NetworkInterfaceReferenceProperties

名字 描述 價值
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool

NetworkProfile

名字 描述 價值
networkInterfaces 指定與虛擬機相關聯之網路介面的資源標識符清單。 NetworkInterfaceReference[]

OSDisk

名字 描述 價值
緩存 指定快取需求。

可能的值為：

無

ReadOnly

ReadWrite

默認值：標準記憶體的無。 Premium 記憶體的 ReadOnly。		 'None'
'ReadOnly'
'ReadWrite'
createOption 指定應如何建立虛擬機。

可能的值為：

附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。

FromImage \u2013 當您使用映射建立虛擬機時，會使用此值。 如果您使用平臺映像，則也會使用上述的 imageReference 元素。 如果您使用市集映像，則也會使用先前所述的 plan 元素。		 'Attach'
'Empty'
'FromImage' （必要）
diffDiskSettings 指定虛擬機所用作業系統磁碟的暫時磁碟設定。 DiffDiskSettings
diskSizeGB 指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB		 int
encryptionSettings 指定 OS 磁碟的加密設定。

API 版本下限：2015-06-15		 DiskEncryptionSettings
圖像 來源使用者映像虛擬硬碟。 在連接至虛擬機之前，將會先複製虛擬硬碟。 如果提供SourceImage，則目的地虛擬硬碟不得存在。 VirtualHardDisk
managedDisk 受控磁碟參數。 ManagedDiskParameters
名字 磁碟名稱。 字串
osType 此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。

可能的值為：

Windows

Linux		 'Linux'
'Windows'
vhd 虛擬硬碟。 VirtualHardDisk
writeAcceleratorEnabled 指定是否應該在磁碟上啟用或停用 writeAccelerator。 bool

OSProfile

名字 描述 價值
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 擴充功能 管理使用者、SSH 及檢查或修復 Azure Linux VM 上的磁碟		 字串

約束：
敏感性值。 以安全參數的形式傳入。
adminUsername 指定系統管理員帳戶的名稱。

建立 VM 之後，就無法更新此屬性。

僅限 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 個字元

li 如需 Linux VM 的根存取權，請參閱在 Azure 中使用 Linux 虛擬機上的根許可權
<li> 如需不應該在此欄位中使用的 Linux 內建系統使用者清單，請參閱在 Azure 上選取 Linux 的使用者名稱 		字串
allowExtensionOperations 指定虛擬機上是否應該允許擴充功能作業。

只有在虛擬機上沒有擴充功能時，才會將此選項設定為 False。		 bool
computerName 指定虛擬機的主機OS名稱。

建立 VM 之後，無法更新此名稱。

長度上限 （Windows）： 15 個字元

長度上限（Linux）： 64 個字元。

如需命名慣例和限制，請參閱Azure 基礎結構服務實作指導方針。		 字串
customData 指定自訂數據的base-64編碼字串。 base-64 編碼字串會譯碼為儲存為虛擬機上檔案的二進位數組。 二進位陣列的最大長度為65535個字節。

注意：請勿在 customData 屬性中傳遞任何秘密或密碼

建立 VM 之後，就無法更新此屬性。

customData 會傳遞至要儲存為檔案的 VM，如需詳細資訊，請參閱在 Azure VM 上 自定義數據

如需針對Linux VM使用cloud-init，請參閱在 建立期間使用cloud-init自定義Linux VM 		字串
linuxConfiguration 指定虛擬機上的Linux作業系統設定。

如需支援的Linux發行版清單，請參閱 Azure-Endorsed 發行版上的 Linux

如需執行非背書散發套件，請參閱 非背書散發套件的資訊。		 LinuxConfiguration
requireGuestProvisionSignal 指定是否需要來賓布建訊號，才能推斷虛擬機的布建成功。 注意：此屬性僅適用於私人測試，而且所有客戶都不得將 屬性設定為 false。 bool
秘密 指定應該安裝在虛擬機上的憑證集。 VaultSecretGroup[]
windowsConfiguration 指定虛擬機上的 Windows 作業系統設定。 WindowsConfiguration

PatchSettings

名字 描述 價值
enableHotpatching 可讓客戶修補其 Azure VM，而不需要重新啟動。 針對 enableHotpatching，'provisionVMAgent' 必須設定為 true，且 'patchMode' 必須設定為 'AutomaticByPlatform'。 bool
patchMode 指定 VM 客體修補至 IaaS 虛擬機的模式。

可能的值為：

手動 - 您可以控制將修補程式的應用程式套用至虛擬機。 您可以手動在 VM 內套用修補程式來執行此動作。 在此模式中，會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。 屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。

AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true		 'AutomaticByOS'
'AutomaticByPlatform'
'Manual'

計劃

名字 描述 價值
名字 方案標識碼。 字串
產品 指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 字串
promotionCode 促銷碼。 字串
發行人 發行者標識碼。 字串

ResourceTags

名字 描述 價值

SecurityProfile

名字 描述 價值
encryptionAtHost 用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。

默認值：除非資源將此屬性設定為 true，否則將會停用主機的加密。		 bool
securityType 指定虛擬機的 SecurityType。 它會設定為 TrustedLaunch 以啟用 UefiSettings。

默認值：除非此屬性設定為 TrustedLaunch，否則不會啟用 UefiSettings。		 'TrustedLaunch'
uefiSettings 指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。

API 版本下限：2020-12-01		 UefiSettings

SshConfiguration

名字 描述 價值
publicKeys 用來向Linux型VM進行驗證的SSH公鑰清單。 SshPublicKey[]

SshPublicKey

名字 描述 價值
keyData 用來透過 ssh 向 VM 進行驗證的 SSH 公鑰憑證。 密鑰至少必須是 2048 位，且格式為 ssh-rsa。

如需建立 ssh 金鑰，請參閱 在 Azure中建立 Linux 和 Mac 上的 SSH 金鑰。		 字串
路徑 指定已建立 VM 上儲存 SSH 公鑰的完整路徑。 如果檔案已經存在，指定的索引鍵會附加至檔案。 範例：/home/user/.ssh/authorized_keys 字串

StorageProfile

名字 描述 價值
dataDisks 指定用來將數據磁碟新增至虛擬機的參數。

如需磁碟的詳細資訊，請參閱 關於 Azure 虛擬機器的磁碟和 VHD。		 DataDisk[]
imageReference 指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。 ImageReference
osDisk 指定虛擬機所使用的作業系統磁碟相關信息。

如需磁碟的詳細資訊，請參閱 關於 Azure 虛擬機器的磁碟和 VHD。		 OSDisk

SubResource

名字 描述 價值
id 資源標識碼 字串

UefiSettings

名字 描述 價值
secureBootEnabled 指定是否應在虛擬機上啟用安全開機。

API 版本下限：2020-12-01		 bool
vTpmEnabled 指定是否應在虛擬機上啟用 vTPM。

API 版本下限：2020-12-01		 bool

VaultCertificate

名字 描述 價值
certificateStore 針對 Windows VM，指定應新增憑證之虛擬機上的證書存儲。 指定的證書存儲隱含在 LocalMachine 帳戶中。

針對 Linux VM，憑證檔案會放在 /var/lib/waagent 目錄底下，檔名 <X509 憑證檔案的大寫Thumbprint>.crt，並針對私鑰 <大寫Thumbprint>.prv。 這兩個檔案都是 .pem 格式。		 字串
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault，請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8：

{
“data”：“<Base64 編碼憑證>”，
“dataType”：“pfx”，
“password”：“<pfx-file-password>”
}		 字串

VaultSecretGroup

名字 描述 價值
sourceVault Key Vault 的相對 URL，其中包含 VaultCertificates 中的所有憑證。 SubResource
vaultCertificates SourceVault 中包含憑證的金鑰保存庫參考清單。 VaultCertificate[]

VirtualHardDisk

名字 描述 價值
uri 指定虛擬硬碟的 URI。 字串

VirtualMachineScaleSetIPConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 IP 組態名稱。 字串 （必要）
性能 描述虛擬機擴展集網路配置檔的IP組態屬性。 VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties

名字 描述 價值
applicationGatewayBackendAddressPools 指定應用程式閘道後端位址池的參考數位。 擴展集可以參考多個應用程式閘道的後端位址池。 多個擴展集無法使用相同的應用程式閘道。 SubResource[]
applicationSecurityGroups 指定應用程式安全組參考的陣列。 SubResource[]
loadBalancerBackendAddressPools 指定負載平衡器後端位址池的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的後端位址池。 多個擴展集無法使用相同的基本 SKU 負載平衡器。 SubResource[]
loadBalancerInboundNatPools 指定負載平衡器輸入 Nat 集區的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的輸入 nat 集區。 多個擴展集無法使用相同的基本 SKU 負載平衡器。 SubResource[]
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool
privateIPAddressVersion 從 Api-Version 2017-03-30 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為：'IPv4' 和 'IPv6'。 'IPv4'
'IPv6'
publicIPAddressConfiguration publicIPAddressConfiguration。 VirtualMachineScaleSetPublicIPAddressConfiguration
子 指定子網的識別碼。 ApiEntityReference

VirtualMachineScaleSetIpTag

名字 描述 價值
ipTagType IP 標籤類型。 範例：FirstPartyUsage。 字串
標記 與公用IP相關聯的IP標籤。 範例：SQL、記憶體等。 字串

VirtualMachineScaleSetNetworkConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 網路組態名稱。 字串 （必要）
性能 描述虛擬機擴展集網路配置檔的IP組態。 VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationDnsSettings

名字 描述 價值
dnsServers DNS 伺服器 IP 位址清單 string[]

VirtualMachineScaleSetNetworkConfigurationProperties

名字 描述 價值
dnsSettings 要套用在網路介面上的 DNS 設定。 VirtualMachineScaleSetNetworkConfigurationDnsSettings
enableAcceleratedNetworking 指定網路介面是否已啟用加速網路功能。 bool
enableFpga 指定網路介面是否已啟用 FPGA 網路功能。 bool
enableIPForwarding 是否在此 NIC 上啟用 IP 轉送。 bool
ipConfigurations 指定網路介面的IP組態。 VirtualMachineScaleSetIPConfiguration[] （必要）
networkSecurityGroup 網路安全組。 SubResource
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool

VirtualMachineScaleSetPublicIPAddressConfiguration

名字 描述 價值
名字 publicIP 位址組態名稱。 字串 （必要）
性能 描述虛擬機擴展集IP組態的PublicIPAddress組態 VirtualMachineScaleSetPublicIPAddressConfigurationProperties

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

名字 描述 價值
domainNameLabel 功能變數名稱標籤。功能變數名稱標籤和 VM 索引的串連將是將要建立之 PublicIPAddress 資源的功能變數名稱標籤 字串 （必要）

VirtualMachineScaleSetPublicIPAddressConfigurationProperties

名字 描述 價值
dnsSettings 要套用至 publicIP 位址的 DNS 設定。 VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
idleTimeoutInMinutes 公用IP位址的閒置逾時。 int
ipTags 與公用IP位址相關聯的IP標籤清單。 VirtualMachineScaleSetIpTag[]
publicIPAddressVersion 從 Api-Version 2019-07-01 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為：'IPv4' 和 'IPv6'。 'IPv4'
'IPv6'
publicIPPrefix 要從中配置 publicIP 位址的 PublicIPPrefix。 SubResource

VirtualMachineScaleSetVMNetworkProfileConfiguration

名字 描述 價值
networkInterfaceConfigurations 網路組態的清單。 VirtualMachineScaleSetNetworkConfiguration[]

VirtualMachineScaleSetVMProperties

名字 描述 價值
additionalCapabilities 指定擴展集中虛擬機上啟用或停用的其他功能。 例如：虛擬機是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。 AdditionalCapabilities
availabilitySet 指定虛擬機應指派之可用性設定組的相關信息。 相同可用性設定組中指定的虛擬機會配置給不同的節點，以將可用性最大化。 如需可用性設定組的詳細資訊，請參閱 管理虛擬機的可用性。

如需 Azure 計劃性維護的詳細資訊，請參閱 Azure 中虛擬機的計畫性維護

目前，VM 只能在建立時新增至可用性設定組。 現有的 VM 無法新增至可用性設定組。		 SubResource
diagnosticsProfile 指定開機診斷設定狀態。

API 版本下限：2015-06-15。		 DiagnosticsProfile
hardwareProfile 指定虛擬機的硬體設定。 HardwareProfile
licenseType 指定所使用的映像或磁碟已獲內部部署授權。

Windows Server 操作系統的可能值為：

Windows_Client

Windows_Server

Linux Server 操作系統的可能值為：

RHEL_BYOS （RHEL）

SLES_BYOS （適用於 SUSE）

如需詳細資訊，請參閱 適用於 Windows Server 的 Azure Hybrid Use Benefit

適用於Linux Server的 Azure Hybrid Use Benefit

API 版本下限：2015-06-15		 字串
networkProfile 指定虛擬機的網路介面。 NetworkProfile
networkProfileConfiguration 指定虛擬機的網路配置檔組態。 VirtualMachineScaleSetVMNetworkProfileConfiguration
osProfile 指定虛擬機的作業系統設定。 OSProfile
protectionPolicy 指定虛擬機的保護原則。 VirtualMachineScaleSetVMProtectionPolicy
securityProfile 指定虛擬機的安全性相關配置檔設定。 SecurityProfile
storageProfile 指定虛擬機磁碟的記憶體設定。 StorageProfile

VirtualMachineScaleSetVMProtectionPolicy

名字 描述 價值
protectFromScaleIn 指出虛擬機擴展集 VM 不應該考慮在相應縮小作業期間刪除。 bool
protectFromScaleSetActions 指出虛擬機擴展集上起始的模型更新或動作（包括相應縮小），不應套用至虛擬機擴展集 VM。 bool

WindowsConfiguration

名字 描述 價值
additionalUnattendContent 指定其他base-64編碼的 XML 格式資訊，這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。 AdditionalUnattendContent[]
enableAutomaticUpdates 指出是否為 Windows 虛擬機啟用自動更新。 默認值為 true。

針對虛擬機擴展集，此屬性可以更新，更新將會在OS重新佈建上生效。		 bool
patchSettings [預覽功能]指定與 Windows 上的 VM 客體修補相關的設定。 PatchSettings
provisionVMAgent 指出虛擬機器代理程式是否應該佈建在虛擬機上。

當要求本文中未指定此屬性時，預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。		 bool
timeZone 指定虛擬機的時區。 例如「太平洋標準時間」。

可能的值可以從 TimeZoneInfo.GetSystemTimeZones 所傳回的時區 TimeZoneInfo.Id 值。		 字串
winRM 指定 Windows 遠端管理接聽程式。 這可啟用遠端 Windows PowerShell。 WinRMConfiguration

WinRMConfiguration

名字 描述 價值
聽眾 Windows 遠端管理接聽程式清單 WinRMListener[]

WinRMListener

名字 描述 價值
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault，請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8：

{
“data”：“<Base64 編碼憑證>”，
“dataType”：“pfx”，
“password”：“<pfx-file-password>”
}		 字串
協定 指定 WinRM 接聽程式的通訊協定。

可能的值為：
http

https		 'Http'
'Https'

ARM 樣本資源定義

virtualMachineScaleSets/virtualmachines 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualmachines 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "plan": {
    "name": "string",
    "product": "string",
    "promotionCode": "string",
    "publisher": "string"
  },
  "properties": {
    "additionalCapabilities": {
      "ultraSSDEnabled": "bool"
    },
    "availabilitySet": {
      "id": "string"
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": "bool",
        "storageUri": "string"
      }
    },
    "hardwareProfile": {
      "vmSize": "string"
    },
    "licenseType": "string",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "string",
          "properties": {
            "primary": "bool"
          }
        }
      ]
    },
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "id": "string",
          "name": "string",
          "properties": {
            "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": {
                      "dnsSettings": {
                        "domainNameLabel": "string"
                      },
                      "idleTimeoutInMinutes": "int",
                      "ipTags": [
                        {
                          "ipTagType": "string",
                          "tag": "string"
                        }
                      ],
                      "publicIPAddressVersion": "string",
                      "publicIPPrefix": {
                        "id": "string"
                      }
                    }
                  },
                  "subnet": {
                    "id": "string"
                  }
                }
              }
            ],
            "networkSecurityGroup": {
              "id": "string"
            },
            "primary": "bool"
          }
        }
      ]
    },
    "osProfile": {
      "adminPassword": "string",
      "adminUsername": "string",
      "allowExtensionOperations": "bool",
      "computerName": "string",
      "customData": "string",
      "linuxConfiguration": {
        "disablePasswordAuthentication": "bool",
        "patchSettings": {
          "patchMode": "string"
        },
        "provisionVMAgent": "bool",
        "ssh": {
          "publicKeys": [
            {
              "keyData": "string",
              "path": "string"
            }
          ]
        }
      },
      "requireGuestProvisionSignal": "bool",
      "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": {
          "enableHotpatching": "bool",
          "patchMode": "string"
        },
        "provisionVMAgent": "bool",
        "timeZone": "string",
        "winRM": {
          "listeners": [
            {
              "certificateUrl": "string",
              "protocol": "string"
            }
          ]
        }
      }
    },
    "protectionPolicy": {
      "protectFromScaleIn": "bool",
      "protectFromScaleSetActions": "bool"
    },
    "securityProfile": {
      "encryptionAtHost": "bool",
      "securityType": "string",
      "uefiSettings": {
        "secureBootEnabled": "bool",
        "vTpmEnabled": "bool"
      }
    },
    "storageProfile": {
      "dataDisks": [
        {
          "caching": "string",
          "createOption": "string",
          "detachOption": "string",
          "diskSizeGB": "int",
          "image": {
            "uri": "string"
          },
          "lun": "int",
          "managedDisk": {
            "diskEncryptionSet": {
              "id": "string"
            },
            "id": "string",
            "storageAccountType": "string"
          },
          "name": "string",
          "toBeDetached": "bool",
          "vhd": {
            "uri": "string"
          },
          "writeAcceleratorEnabled": "bool"
        }
      ],
      "imageReference": {
        "id": "string",
        "offer": "string",
        "publisher": "string",
        "sku": "string",
        "version": "string"
      },
      "osDisk": {
        "caching": "string",
        "createOption": "string",
        "diffDiskSettings": {
          "option": "string",
          "placement": "string"
        },
        "diskSizeGB": "int",
        "encryptionSettings": {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "enabled": "bool",
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          }
        },
        "image": {
          "uri": "string"
        },
        "managedDisk": {
          "diskEncryptionSet": {
            "id": "string"
          },
          "id": "string",
          "storageAccountType": "string"
        },
        "name": "string",
        "osType": "string",
        "vhd": {
          "uri": "string"
        },
        "writeAcceleratorEnabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

AdditionalCapabilities

名字 描述 價值
ultraSSDEnabled 旗標，可讓或停用在 VM 或 VMSS 上具有一或多個具有 UltraSSD_LRS記憶體帳戶類型的受控數據磁碟。 只有啟用此屬性，才能將具有記憶體帳戶類型的受控磁碟UltraSSD_LRS新增至虛擬機或虛擬機擴展集。 bool

AdditionalUnattendContent

名字 描述 價值
componentName 元件名稱。 目前，唯一允許的值是 Microsoft-Windows-Shell-Setup。 'Microsoft-Windows-Shell-Setup'
內容 指定新增至指定路徑和元件之 unattend.xml 檔案的 XML 格式化內容。 XML 必須小於 4KB，而且必須包含要插入之設定或功能的根元素。 字串
passName 傳遞名稱。 目前唯一允許的值是 OobeSystem。 'OobeSystem'
settingName 指定套用內容之設定的名稱。 可能的值為：FirstLogonCommands 和 AutoLogon。 'AutoLogon'
'FirstLogonCommands'

ApiEntityReference

名字 描述 價值
id 以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符 字串

BootDiagnostics

名字 描述 價值
啟用 是否應在虛擬機上啟用開機診斷。 bool
storageUri 用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。

如果在啟用開機診斷時未指定 storageUri，則會使用受控記憶體。		 字串

DataDisk

名字 描述 價值
緩存 指定快取需求。

可能的值為：

無

ReadOnly

ReadWrite

預設值：標準記憶體 None。進階記憶體的 ReadOnly		 'None'
'ReadOnly'
'ReadWrite'
createOption 指定應如何建立虛擬機。

可能的值為：

附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。

FromImage \u2013 當您使用映射建立虛擬機時，會使用此值。 如果您使用平臺映像，則也會使用上述的 imageReference 元素。 如果您使用市集映像，則也會使用先前所述的 plan 元素。		 'Attach'
'Empty'
'FromImage' （必要）
detachOption 指定卸離磁碟時所要使用的卸離行為，或已在從虛擬機中斷鏈接的過程中使用的行為。 支援的值：ForceDetach。

detachOption：ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁盤中斷鏈接嘗試未完成，因為虛擬機發生非預期的失敗，磁碟仍未釋放，則請使用強制卸離作為最後手段選項，強制中斷連結磁碟與 VM。 使用這個卸離行為時，所有寫入可能都沒有排清。

此功能仍處於預覽模式，VirtualMachineScaleSet 不支援此功能。 若要強制將數據磁碟更新強制卸離至 『true』，以及設定 detachOption： 'ForceDetach'。		 'ForceDetach'
diskSizeGB 指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB		 int
圖像 來源使用者映像虛擬硬碟。 在連接至虛擬機之前，將會先複製虛擬硬碟。 如果提供SourceImage，則目的地虛擬硬碟不得存在。 VirtualHardDisk
倫 指定數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。 int （必要）
managedDisk 受控磁碟參數。 ManagedDiskParameters
名字 磁碟名稱。 字串
toBeDetached 指定數據磁碟是否正在從 VirtualMachine/VirtualMachineScaleset 中斷連結 bool
vhd 虛擬硬碟。 VirtualHardDisk
writeAcceleratorEnabled 指定是否應該在磁碟上啟用或停用 writeAccelerator。 bool

DiagnosticsProfile

名字 描述 價值
bootDiagnostics 開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。

您可以輕鬆地檢視主控台記錄的輸出。

Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。		 BootDiagnostics

DiffDiskSettings

名字 描述 價值
選擇 指定作業系統磁碟的暫時磁碟設定。 'Local'
放置 指定作業系統磁碟的暫時磁碟位置。

可能的值為：

CacheDisk

ResourceDisk

默認值：如果已針對 VM 大小設定快取Disk ，否則會使用 resourceDisk 。

請參閱 /azure/virtual-machines/windows/size 和 Linux VM 在 /azure/virtual-machines/linux/size 上 Windows VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。		 'CacheDisk'
'ResourceDisk'

DiskEncryptionSetParameters

名字 描述 價值
id 資源標識碼 字串

DiskEncryptionSettings

名字 描述 價值
diskEncryptionKey 指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。 KeyVaultSecretReference
啟用 指定是否應在虛擬機上啟用磁碟加密。 bool
keyEncryptionKey 指定 Key Vault 中金鑰加密金鑰的位置。 KeyVaultKeyReference

HardwareProfile

名字 描述 價值
vmSize 指定虛擬機的大小。

列舉數據類型目前已被取代，將於 2023 年 12 月 23 日移除。

取得可用大小清單的建議方式是使用這些 API：

列出可用性設定組中的所有可用虛擬機大小

列出區域中所有可用的虛擬機大小

列出調整大小的所有可用虛擬機大小。 如需虛擬機器大小的詳細資訊，請參閱 虛擬機的大小。

可用的 VM 大小取決於區域和可用性設定組。		 'Basic_A0'
'Basic_A1'
'Basic_A2'
'Basic_A3'
'Basic_A4'
'Standard_A0'
'Standard_A1'
'Standard_A10'
'Standard_A11'
'Standard_A1_v2'
'Standard_A2'
'Standard_A2m_v2'
'Standard_A2_v2'
'Standard_A3'
'Standard_A4'
'Standard_A4m_v2'
'Standard_A4_v2'
'Standard_A5'
'Standard_A6'
'Standard_A7'
'Standard_A8'
'Standard_A8m_v2'
'Standard_A8_v2'
'Standard_A9'
'Standard_B1ms'
'Standard_B1s'
'Standard_B2ms'
'Standard_B2s'
'Standard_B4ms'
'Standard_B8ms'
'Standard_D1'
'Standard_D11'
'Standard_D11_v2'
'Standard_D12'
'Standard_D12_v2'
'Standard_D13'
'Standard_D13_v2'
'Standard_D14'
'Standard_D14_v2'
'Standard_D15_v2'
'Standard_D16s_v3'
'Standard_D16_v3'
'Standard_D1_v2'
'Standard_D2'
'Standard_D2s_v3'
'Standard_D2_v2'
'Standard_D2_v3'
'Standard_D3'
'Standard_D32s_v3'
'Standard_D32_v3'
'Standard_D3_v2'
'Standard_D4'
'Standard_D4s_v3'
'Standard_D4_v2'
'Standard_D4_v3'
'Standard_D5_v2'
'Standard_D64s_v3'
'Standard_D64_v3'
'Standard_D8s_v3'
'Standard_D8_v3'
'Standard_DS1'
'Standard_DS11'
'Standard_DS11_v2'
'Standard_DS12'
'Standard_DS12_v2'
'Standard_DS13'
'Standard_DS13-2_v2'
'Standard_DS13-4_v2'
'Standard_DS13_v2'
'Standard_DS14'
'Standard_DS14-4_v2'
'Standard_DS14-8_v2'
'Standard_DS14_v2'
'Standard_DS15_v2'
'Standard_DS1_v2'
'Standard_DS2'
'Standard_DS2_v2'
'Standard_DS3'
'Standard_DS3_v2'
'Standard_DS4'
'Standard_DS4_v2'
'Standard_DS5_v2'
'Standard_E16s_v3'
'Standard_E16_v3'
'Standard_E2s_v3'
'Standard_E2_v3'
'Standard_E32-16_v3'
'Standard_E32-8s_v3'
'Standard_E32s_v3'
'Standard_E32_v3'
'Standard_E4s_v3'
'Standard_E4_v3'
'Standard_E64-16s_v3'
'Standard_E64-32s_v3'
'Standard_E64s_v3'
'Standard_E64_v3'
'Standard_E8s_v3'
'Standard_E8_v3'
'Standard_F1'
'Standard_F16'
'Standard_F16s'
'Standard_F16s_v2'
'Standard_F1s'
'Standard_F2'
'Standard_F2s'
'Standard_F2s_v2'
'Standard_F32s_v2'
'Standard_F4'
'Standard_F4s'
'Standard_F4s_v2'
'Standard_F64s_v2'
'Standard_F72s_v2'
'Standard_F8'
'Standard_F8s'
'Standard_F8s_v2'
'Standard_G1'
'Standard_G2'
'Standard_G3'
'Standard_G4'
'Standard_G5'
'Standard_GS1'
'Standard_GS2'
'Standard_GS3'
'Standard_GS4'
'Standard_GS4-4'
'Standard_GS4-8'
'Standard_GS5'
'Standard_GS5-16'
'Standard_GS5-8'
'Standard_H16'
'Standard_H16m'
'Standard_H16mr'
'Standard_H16r'
'Standard_H8'
'Standard_H8m'
'Standard_L16s'
'Standard_L32s'
'Standard_L4s'
'Standard_L8s'
'Standard_M128-32ms'
'Standard_M128-64ms'
'Standard_M128ms'
'Standard_M128s'
'Standard_M64-16ms'
'Standard_M64-32ms'
'Standard_M64ms'
'Standard_M64s'
'Standard_NC12'
'Standard_NC12s_v2'
'Standard_NC12s_v3'
'Standard_NC24'
'Standard_NC24r'
'Standard_NC24rs_v2'
'Standard_NC24rs_v3'
'Standard_NC24s_v2'
'Standard_NC24s_v3'
'Standard_NC6'
'Standard_NC6s_v2'
'Standard_NC6s_v3'
'Standard_ND12s'
'Standard_ND24rs'
'Standard_ND24s'
'Standard_ND6s'
'Standard_NV12'
'Standard_NV24'
'Standard_NV6'

ImageReference

名字 描述 價值
id 資源標識碼 字串
提供 指定用來建立虛擬機的平臺映像或市集映像供應專案。 字串
發行人 映像發行者。 字串
sku 映像 SKU。 字串
版本 指定用來建立虛擬機的平臺映像或市集映像版本。 允許的格式為 Major.Minor.Build 或 'latest'。 主要、次要和組建是十進位數。 指定 'latest' 以在部署時間使用可用映像的最新版本。 即使您使用「最新」，即使有新版本可用，VM 映像也不會在部署時間之後自動更新。 字串

KeyVaultKeyReference

名字 描述 價值
keyUrl 參考 Key Vault 中金鑰加密金鑰的 URL。 字串 （必要）
sourceVault 包含金鑰之 Key Vault 的相對 URL。 SubResource （必要）

KeyVaultSecretReference

名字 描述 價值
secretUrl 參考 Key Vault 中秘密的 URL。 字串 （必要）
sourceVault 包含秘密之 Key Vault 的相對 URL。 SubResource （必要）

LinuxConfiguration

名字 描述 價值
disablePasswordAuthentication 指定是否應停用密碼驗證。 bool
patchSettings [預覽功能]指定與Linux上的VM客體修補相關的設定。 LinuxPatchSettings
provisionVMAgent 指出虛擬機器代理程式是否應該佈建在虛擬機上。

當要求本文中未指定此屬性時，預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。		 bool
ssh 指定 Linux OS 的 SSH 金鑰組態。 SshConfiguration

LinuxPatchSettings

名字 描述 價值
patchMode 指定 VM 客體修補至 IaaS 虛擬機的模式。

可能的值為：

ImageDefault - 會使用虛擬機的預設修補組態。

AutomaticByPlatform - 虛擬機將由平台自動更新。 屬性 provisionVMAgent 必須為 true		 'AutomaticByPlatform'
'ImageDefault'

ManagedDiskParameters

名字 描述 價值
diskEncryptionSet 指定受控磁碟的客戶受控磁碟加密集資源標識符。 DiskEncryptionSetParameters
id 資源標識碼 字串
storageAccountType 指定受控磁碟的記憶體帳戶類型。 只有當您建立擴展集時，才能設定受控 OS 磁碟記憶體帳戶類型。 注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。 'Premium_LRS'
'Premium_ZRS'
'StandardSSD_LRS'
'StandardSSD_ZRS'
'Standard_LRS'
'UltraSSD_LRS'

Microsoft.Compute/virtualMachineScaleSets/virtualmachines

名字 描述 價值
apiVersion API 版本 '2020-12-01'
位置 資源位置 字串 （必要）
名字 資源名稱 字串 （必要）
計劃 指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用，才能從 API 使用市集映射。 在 Azure 入口網站中，尋找您想要使用的市集映像，然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊，然後按下 [儲存]。 計劃
性能 描述虛擬機擴展集虛擬機的屬性。 VirtualMachineScaleSetVMProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.Compute/virtualMachineScaleSets/virtualmachines'

NetworkInterfaceReference

名字 描述 價值
id 資源標識碼 字串
性能 描述網路介面參考屬性。 NetworkInterfaceReferenceProperties

NetworkInterfaceReferenceProperties

名字 描述 價值
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool

NetworkProfile

名字 描述 價值
networkInterfaces 指定與虛擬機相關聯之網路介面的資源標識符清單。 NetworkInterfaceReference[]

OSDisk

名字 描述 價值
緩存 指定快取需求。

可能的值為：

無

ReadOnly

ReadWrite

默認值：標準記憶體的無。 Premium 記憶體的 ReadOnly。		 'None'
'ReadOnly'
'ReadWrite'
createOption 指定應如何建立虛擬機。

可能的值為：

附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。

FromImage \u2013 當您使用映射建立虛擬機時，會使用此值。 如果您使用平臺映像，則也會使用上述的 imageReference 元素。 如果您使用市集映像，則也會使用先前所述的 plan 元素。		 'Attach'
'Empty'
'FromImage' （必要）
diffDiskSettings 指定虛擬機所用作業系統磁碟的暫時磁碟設定。 DiffDiskSettings
diskSizeGB 指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB		 int
encryptionSettings 指定 OS 磁碟的加密設定。

API 版本下限：2015-06-15		 DiskEncryptionSettings
圖像 來源使用者映像虛擬硬碟。 在連接至虛擬機之前，將會先複製虛擬硬碟。 如果提供SourceImage，則目的地虛擬硬碟不得存在。 VirtualHardDisk
managedDisk 受控磁碟參數。 ManagedDiskParameters
名字 磁碟名稱。 字串
osType 此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。

可能的值為：

Windows

Linux		 'Linux'
'Windows'
vhd 虛擬硬碟。 VirtualHardDisk
writeAcceleratorEnabled 指定是否應該在磁碟上啟用或停用 writeAccelerator。 bool

OSProfile

名字 描述 價值
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 擴充功能 管理使用者、SSH 及檢查或修復 Azure Linux VM 上的磁碟		 字串

約束：
敏感性值。 以安全參數的形式傳入。
adminUsername 指定系統管理員帳戶的名稱。

建立 VM 之後，就無法更新此屬性。

僅限 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 個字元

li 如需 Linux VM 的根存取權，請參閱在 Azure 中使用 Linux 虛擬機上的根許可權
<li> 如需不應該在此欄位中使用的 Linux 內建系統使用者清單，請參閱在 Azure 上選取 Linux 的使用者名稱 		字串
allowExtensionOperations 指定虛擬機上是否應該允許擴充功能作業。

只有在虛擬機上沒有擴充功能時，才會將此選項設定為 False。		 bool
computerName 指定虛擬機的主機OS名稱。

建立 VM 之後，無法更新此名稱。

長度上限 （Windows）： 15 個字元

長度上限（Linux）： 64 個字元。

如需命名慣例和限制，請參閱Azure 基礎結構服務實作指導方針。		 字串
customData 指定自訂數據的base-64編碼字串。 base-64 編碼字串會譯碼為儲存為虛擬機上檔案的二進位數組。 二進位陣列的最大長度為65535個字節。

注意：請勿在 customData 屬性中傳遞任何秘密或密碼

建立 VM 之後，就無法更新此屬性。

customData 會傳遞至要儲存為檔案的 VM，如需詳細資訊，請參閱在 Azure VM 上 自定義數據

如需針對Linux VM使用cloud-init，請參閱在 建立期間使用cloud-init自定義Linux VM 		字串
linuxConfiguration 指定虛擬機上的Linux作業系統設定。

如需支援的Linux發行版清單，請參閱 Azure-Endorsed 發行版上的 Linux

如需執行非背書散發套件，請參閱 非背書散發套件的資訊。		 LinuxConfiguration
requireGuestProvisionSignal 指定是否需要來賓布建訊號，才能推斷虛擬機的布建成功。 注意：此屬性僅適用於私人測試，而且所有客戶都不得將 屬性設定為 false。 bool
秘密 指定應該安裝在虛擬機上的憑證集。 VaultSecretGroup[]
windowsConfiguration 指定虛擬機上的 Windows 作業系統設定。 WindowsConfiguration

PatchSettings

名字 描述 價值
enableHotpatching 可讓客戶修補其 Azure VM，而不需要重新啟動。 針對 enableHotpatching，'provisionVMAgent' 必須設定為 true，且 'patchMode' 必須設定為 'AutomaticByPlatform'。 bool
patchMode 指定 VM 客體修補至 IaaS 虛擬機的模式。

可能的值為：

手動 - 您可以控制將修補程式的應用程式套用至虛擬機。 您可以手動在 VM 內套用修補程式來執行此動作。 在此模式中，會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。 屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。

AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true		 'AutomaticByOS'
'AutomaticByPlatform'
'Manual'

計劃

名字 描述 價值
名字 方案標識碼。 字串
產品 指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 字串
promotionCode 促銷碼。 字串
發行人 發行者標識碼。 字串

ResourceTags

名字 描述 價值

SecurityProfile

名字 描述 價值
encryptionAtHost 用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。

默認值：除非資源將此屬性設定為 true，否則將會停用主機的加密。		 bool
securityType 指定虛擬機的 SecurityType。 它會設定為 TrustedLaunch 以啟用 UefiSettings。

默認值：除非此屬性設定為 TrustedLaunch，否則不會啟用 UefiSettings。		 'TrustedLaunch'
uefiSettings 指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。

API 版本下限：2020-12-01		 UefiSettings

SshConfiguration

名字 描述 價值
publicKeys 用來向Linux型VM進行驗證的SSH公鑰清單。 SshPublicKey[]

SshPublicKey

名字 描述 價值
keyData 用來透過 ssh 向 VM 進行驗證的 SSH 公鑰憑證。 密鑰至少必須是 2048 位，且格式為 ssh-rsa。

如需建立 ssh 金鑰，請參閱 在 Azure中建立 Linux 和 Mac 上的 SSH 金鑰。		 字串
路徑 指定已建立 VM 上儲存 SSH 公鑰的完整路徑。 如果檔案已經存在，指定的索引鍵會附加至檔案。 範例：/home/user/.ssh/authorized_keys 字串

StorageProfile

名字 描述 價值
dataDisks 指定用來將數據磁碟新增至虛擬機的參數。

如需磁碟的詳細資訊，請參閱 關於 Azure 虛擬機器的磁碟和 VHD。		 DataDisk[]
imageReference 指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。 ImageReference
osDisk 指定虛擬機所使用的作業系統磁碟相關信息。

如需磁碟的詳細資訊，請參閱 關於 Azure 虛擬機器的磁碟和 VHD。		 OSDisk

SubResource

名字 描述 價值
id 資源標識碼 字串

UefiSettings

名字 描述 價值
secureBootEnabled 指定是否應在虛擬機上啟用安全開機。

API 版本下限：2020-12-01		 bool
vTpmEnabled 指定是否應在虛擬機上啟用 vTPM。

API 版本下限：2020-12-01		 bool

VaultCertificate

名字 描述 價值
certificateStore 針對 Windows VM，指定應新增憑證之虛擬機上的證書存儲。 指定的證書存儲隱含在 LocalMachine 帳戶中。

針對 Linux VM，憑證檔案會放在 /var/lib/waagent 目錄底下，檔名 <X509 憑證檔案的大寫Thumbprint>.crt，並針對私鑰 <大寫Thumbprint>.prv。 這兩個檔案都是 .pem 格式。		 字串
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault，請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8：

{
“data”：“<Base64 編碼憑證>”，
“dataType”：“pfx”，
“password”：“<pfx-file-password>”
}		 字串

VaultSecretGroup

名字 描述 價值
sourceVault Key Vault 的相對 URL，其中包含 VaultCertificates 中的所有憑證。 SubResource
vaultCertificates SourceVault 中包含憑證的金鑰保存庫參考清單。 VaultCertificate[]

VirtualHardDisk

名字 描述 價值
uri 指定虛擬硬碟的 URI。 字串

VirtualMachineScaleSetIPConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 IP 組態名稱。 字串 （必要）
性能 描述虛擬機擴展集網路配置檔的IP組態屬性。 VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties

名字 描述 價值
applicationGatewayBackendAddressPools 指定應用程式閘道後端位址池的參考數位。 擴展集可以參考多個應用程式閘道的後端位址池。 多個擴展集無法使用相同的應用程式閘道。 SubResource[]
applicationSecurityGroups 指定應用程式安全組參考的陣列。 SubResource[]
loadBalancerBackendAddressPools 指定負載平衡器後端位址池的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的後端位址池。 多個擴展集無法使用相同的基本 SKU 負載平衡器。 SubResource[]
loadBalancerInboundNatPools 指定負載平衡器輸入 Nat 集區的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的輸入 nat 集區。 多個擴展集無法使用相同的基本 SKU 負載平衡器。 SubResource[]
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool
privateIPAddressVersion 從 Api-Version 2017-03-30 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為：'IPv4' 和 'IPv6'。 'IPv4'
'IPv6'
publicIPAddressConfiguration publicIPAddressConfiguration。 VirtualMachineScaleSetPublicIPAddressConfiguration
子 指定子網的識別碼。 ApiEntityReference

VirtualMachineScaleSetIpTag

名字 描述 價值
ipTagType IP 標籤類型。 範例：FirstPartyUsage。 字串
標記 與公用IP相關聯的IP標籤。 範例：SQL、記憶體等。 字串

VirtualMachineScaleSetNetworkConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 網路組態名稱。 字串 （必要）
性能 描述虛擬機擴展集網路配置檔的IP組態。 VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationDnsSettings

名字 描述 價值
dnsServers DNS 伺服器 IP 位址清單 string[]

VirtualMachineScaleSetNetworkConfigurationProperties

名字 描述 價值
dnsSettings 要套用在網路介面上的 DNS 設定。 VirtualMachineScaleSetNetworkConfigurationDnsSettings
enableAcceleratedNetworking 指定網路介面是否已啟用加速網路功能。 bool
enableFpga 指定網路介面是否已啟用 FPGA 網路功能。 bool
enableIPForwarding 是否在此 NIC 上啟用 IP 轉送。 bool
ipConfigurations 指定網路介面的IP組態。 VirtualMachineScaleSetIPConfiguration[] （必要）
networkSecurityGroup 網路安全組。 SubResource
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool

VirtualMachineScaleSetPublicIPAddressConfiguration

名字 描述 價值
名字 publicIP 位址組態名稱。 字串 （必要）
性能 描述虛擬機擴展集IP組態的PublicIPAddress組態 VirtualMachineScaleSetPublicIPAddressConfigurationProperties

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

名字 描述 價值
domainNameLabel 功能變數名稱標籤。功能變數名稱標籤和 VM 索引的串連將是將要建立之 PublicIPAddress 資源的功能變數名稱標籤 字串 （必要）

VirtualMachineScaleSetPublicIPAddressConfigurationProperties

名字 描述 價值
dnsSettings 要套用至 publicIP 位址的 DNS 設定。 VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
idleTimeoutInMinutes 公用IP位址的閒置逾時。 int
ipTags 與公用IP位址相關聯的IP標籤清單。 VirtualMachineScaleSetIpTag[]
publicIPAddressVersion 從 Api-Version 2019-07-01 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為：'IPv4' 和 'IPv6'。 'IPv4'
'IPv6'
publicIPPrefix 要從中配置 publicIP 位址的 PublicIPPrefix。 SubResource

VirtualMachineScaleSetVMNetworkProfileConfiguration

名字 描述 價值
networkInterfaceConfigurations 網路組態的清單。 VirtualMachineScaleSetNetworkConfiguration[]

VirtualMachineScaleSetVMProperties

名字 描述 價值
additionalCapabilities 指定擴展集中虛擬機上啟用或停用的其他功能。 例如：虛擬機是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。 AdditionalCapabilities
availabilitySet 指定虛擬機應指派之可用性設定組的相關信息。 相同可用性設定組中指定的虛擬機會配置給不同的節點，以將可用性最大化。 如需可用性設定組的詳細資訊，請參閱 管理虛擬機的可用性。

如需 Azure 計劃性維護的詳細資訊，請參閱 Azure 中虛擬機的計畫性維護

目前，VM 只能在建立時新增至可用性設定組。 現有的 VM 無法新增至可用性設定組。		 SubResource
diagnosticsProfile 指定開機診斷設定狀態。

API 版本下限：2015-06-15。		 DiagnosticsProfile
hardwareProfile 指定虛擬機的硬體設定。 HardwareProfile
licenseType 指定所使用的映像或磁碟已獲內部部署授權。

Windows Server 操作系統的可能值為：

Windows_Client

Windows_Server

Linux Server 操作系統的可能值為：

RHEL_BYOS （RHEL）

SLES_BYOS （適用於 SUSE）

如需詳細資訊，請參閱 適用於 Windows Server 的 Azure Hybrid Use Benefit

適用於Linux Server的 Azure Hybrid Use Benefit

API 版本下限：2015-06-15		 字串
networkProfile 指定虛擬機的網路介面。 NetworkProfile
networkProfileConfiguration 指定虛擬機的網路配置檔組態。 VirtualMachineScaleSetVMNetworkProfileConfiguration
osProfile 指定虛擬機的作業系統設定。 OSProfile
protectionPolicy 指定虛擬機的保護原則。 VirtualMachineScaleSetVMProtectionPolicy
securityProfile 指定虛擬機的安全性相關配置檔設定。 SecurityProfile
storageProfile 指定虛擬機磁碟的記憶體設定。 StorageProfile

VirtualMachineScaleSetVMProtectionPolicy

名字 描述 價值
protectFromScaleIn 指出虛擬機擴展集 VM 不應該考慮在相應縮小作業期間刪除。 bool
protectFromScaleSetActions 指出虛擬機擴展集上起始的模型更新或動作（包括相應縮小），不應套用至虛擬機擴展集 VM。 bool

WindowsConfiguration

名字 描述 價值
additionalUnattendContent 指定其他base-64編碼的 XML 格式資訊，這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。 AdditionalUnattendContent[]
enableAutomaticUpdates 指出是否為 Windows 虛擬機啟用自動更新。 默認值為 true。

針對虛擬機擴展集，此屬性可以更新，更新將會在OS重新佈建上生效。		 bool
patchSettings [預覽功能]指定與 Windows 上的 VM 客體修補相關的設定。 PatchSettings
provisionVMAgent 指出虛擬機器代理程式是否應該佈建在虛擬機上。

當要求本文中未指定此屬性時，預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。		 bool
timeZone 指定虛擬機的時區。 例如「太平洋標準時間」。

可能的值可以從 TimeZoneInfo.GetSystemTimeZones 所傳回的時區 TimeZoneInfo.Id 值。		 字串
winRM 指定 Windows 遠端管理接聽程式。 這可啟用遠端 Windows PowerShell。 WinRMConfiguration

WinRMConfiguration

名字 描述 價值
聽眾 Windows 遠端管理接聽程式清單 WinRMListener[]

WinRMListener

名字 描述 價值
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault，請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8：

{
“data”：“<Base64 編碼憑證>”，
“dataType”：“pfx”，
“password”：“<pfx-file-password>”
}		 字串
協定 指定 WinRM 接聽程式的通訊協定。

可能的值為：
http

https		 'Http'
'Https'

Terraform （AzAPI 提供者） 資源定義

virtualMachineScaleSets/virtualmachines 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualmachines 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-12-01"
  name = "string"
  location = "string"
  plan = {
    name = "string"
    product = "string"
    promotionCode = "string"
    publisher = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalCapabilities = {
        ultraSSDEnabled = bool
      }
      availabilitySet = {
        id = "string"
      }
      diagnosticsProfile = {
        bootDiagnostics = {
          enabled = bool
          storageUri = "string"
        }
      }
      hardwareProfile = {
        vmSize = "string"
      }
      licenseType = "string"
      networkProfile = {
        networkInterfaces = [
          {
            id = "string"
            properties = {
              primary = bool
            }
          }
        ]
      }
      networkProfileConfiguration = {
        networkInterfaceConfigurations = [
          {
            id = "string"
            name = "string"
            properties = {
              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 = {
                        dnsSettings = {
                          domainNameLabel = "string"
                        }
                        idleTimeoutInMinutes = int
                        ipTags = [
                          {
                            ipTagType = "string"
                            tag = "string"
                          }
                        ]
                        publicIPAddressVersion = "string"
                        publicIPPrefix = {
                          id = "string"
                        }
                      }
                    }
                    subnet = {
                      id = "string"
                    }
                  }
                }
              ]
              networkSecurityGroup = {
                id = "string"
              }
              primary = bool
            }
          }
        ]
      }
      osProfile = {
        adminPassword = "string"
        adminUsername = "string"
        allowExtensionOperations = bool
        computerName = "string"
        customData = "string"
        linuxConfiguration = {
          disablePasswordAuthentication = bool
          patchSettings = {
            patchMode = "string"
          }
          provisionVMAgent = bool
          ssh = {
            publicKeys = [
              {
                keyData = "string"
                path = "string"
              }
            ]
          }
        }
        requireGuestProvisionSignal = bool
        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 = {
            enableHotpatching = bool
            patchMode = "string"
          }
          provisionVMAgent = bool
          timeZone = "string"
          winRM = {
            listeners = [
              {
                certificateUrl = "string"
                protocol = "string"
              }
            ]
          }
        }
      }
      protectionPolicy = {
        protectFromScaleIn = bool
        protectFromScaleSetActions = bool
      }
      securityProfile = {
        encryptionAtHost = bool
        securityType = "string"
        uefiSettings = {
          secureBootEnabled = bool
          vTpmEnabled = bool
        }
      }
      storageProfile = {
        dataDisks = [
          {
            caching = "string"
            createOption = "string"
            detachOption = "string"
            diskSizeGB = int
            image = {
              uri = "string"
            }
            lun = int
            managedDisk = {
              diskEncryptionSet = {
                id = "string"
              }
              id = "string"
              storageAccountType = "string"
            }
            name = "string"
            toBeDetached = bool
            vhd = {
              uri = "string"
            }
            writeAcceleratorEnabled = bool
          }
        ]
        imageReference = {
          id = "string"
          offer = "string"
          publisher = "string"
          sku = "string"
          version = "string"
        }
        osDisk = {
          caching = "string"
          createOption = "string"
          diffDiskSettings = {
            option = "string"
            placement = "string"
          }
          diskSizeGB = int
          encryptionSettings = {
            diskEncryptionKey = {
              secretUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
            enabled = bool
            keyEncryptionKey = {
              keyUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
          }
          image = {
            uri = "string"
          }
          managedDisk = {
            diskEncryptionSet = {
              id = "string"
            }
            id = "string"
            storageAccountType = "string"
          }
          name = "string"
          osType = "string"
          vhd = {
            uri = "string"
          }
          writeAcceleratorEnabled = bool
        }
      }
    }
  })
}

屬性值

AdditionalCapabilities

名字 描述 價值
ultraSSDEnabled 旗標，可讓或停用在 VM 或 VMSS 上具有一或多個具有 UltraSSD_LRS記憶體帳戶類型的受控數據磁碟。 只有啟用此屬性，才能將具有記憶體帳戶類型的受控磁碟UltraSSD_LRS新增至虛擬機或虛擬機擴展集。 bool

AdditionalUnattendContent

名字 描述 價值
componentName 元件名稱。 目前，唯一允許的值是 Microsoft-Windows-Shell-Setup。 'Microsoft-Windows-Shell-Setup'
內容 指定新增至指定路徑和元件之 unattend.xml 檔案的 XML 格式化內容。 XML 必須小於 4KB，而且必須包含要插入之設定或功能的根元素。 字串
passName 傳遞名稱。 目前唯一允許的值是 OobeSystem。 'OobeSystem'
settingName 指定套用內容之設定的名稱。 可能的值為：FirstLogonCommands 和 AutoLogon。 'AutoLogon'
'FirstLogonCommands'

ApiEntityReference

名字 描述 價值
id 以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符 字串

BootDiagnostics

名字 描述 價值
啟用 是否應在虛擬機上啟用開機診斷。 bool
storageUri 用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。

如果在啟用開機診斷時未指定 storageUri，則會使用受控記憶體。		 字串

DataDisk

名字 描述 價值
緩存 指定快取需求。

可能的值為：

無

ReadOnly

ReadWrite

預設值：標準記憶體 None。進階記憶體的 ReadOnly		 'None'
'ReadOnly'
'ReadWrite'
createOption 指定應如何建立虛擬機。

可能的值為：

附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。

FromImage \u2013 當您使用映射建立虛擬機時，會使用此值。 如果您使用平臺映像，則也會使用上述的 imageReference 元素。 如果您使用市集映像，則也會使用先前所述的 plan 元素。		 'Attach'
'Empty'
'FromImage' （必要）
detachOption 指定卸離磁碟時所要使用的卸離行為，或已在從虛擬機中斷鏈接的過程中使用的行為。 支援的值：ForceDetach。

detachOption：ForceDetach 僅適用於受控數據磁碟。 如果先前的數據磁盤中斷鏈接嘗試未完成，因為虛擬機發生非預期的失敗，磁碟仍未釋放，則請使用強制卸離作為最後手段選項，強制中斷連結磁碟與 VM。 使用這個卸離行為時，所有寫入可能都沒有排清。

此功能仍處於預覽模式，VirtualMachineScaleSet 不支援此功能。 若要強制將數據磁碟更新強制卸離至 『true』，以及設定 detachOption： 'ForceDetach'。		 'ForceDetach'
diskSizeGB 指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB		 int
圖像 來源使用者映像虛擬硬碟。 在連接至虛擬機之前，將會先複製虛擬硬碟。 如果提供SourceImage，則目的地虛擬硬碟不得存在。 VirtualHardDisk
倫 指定數據磁碟的邏輯單元編號。 這個值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言都必須是唯一的。 int （必要）
managedDisk 受控磁碟參數。 ManagedDiskParameters
名字 磁碟名稱。 字串
toBeDetached 指定數據磁碟是否正在從 VirtualMachine/VirtualMachineScaleset 中斷連結 bool
vhd 虛擬硬碟。 VirtualHardDisk
writeAcceleratorEnabled 指定是否應該在磁碟上啟用或停用 writeAccelerator。 bool

DiagnosticsProfile

名字 描述 價值
bootDiagnostics 開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。

您可以輕鬆地檢視主控台記錄的輸出。

Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。		 BootDiagnostics

DiffDiskSettings

名字 描述 價值
選擇 指定作業系統磁碟的暫時磁碟設定。 'Local'
放置 指定作業系統磁碟的暫時磁碟位置。

可能的值為：

CacheDisk

ResourceDisk

默認值：如果已針對 VM 大小設定快取Disk ，否則會使用 resourceDisk 。

請參閱 /azure/virtual-machines/windows/size 和 Linux VM 在 /azure/virtual-machines/linux/size 上 Windows VM 的 VM 大小檔，以檢查哪些 VM 大小會公開快取磁碟。		 'CacheDisk'
'ResourceDisk'

DiskEncryptionSetParameters

名字 描述 價值
id 資源標識碼 字串

DiskEncryptionSettings

名字 描述 價值
diskEncryptionKey 指定磁碟加密密鑰的位置，也就是 Key Vault 秘密。 KeyVaultSecretReference
啟用 指定是否應在虛擬機上啟用磁碟加密。 bool
keyEncryptionKey 指定 Key Vault 中金鑰加密金鑰的位置。 KeyVaultKeyReference

HardwareProfile

名字 描述 價值
vmSize 指定虛擬機的大小。

列舉數據類型目前已被取代，將於 2023 年 12 月 23 日移除。

取得可用大小清單的建議方式是使用這些 API：

列出可用性設定組中的所有可用虛擬機大小

列出區域中所有可用的虛擬機大小

列出調整大小的所有可用虛擬機大小。 如需虛擬機器大小的詳細資訊，請參閱 虛擬機的大小。

可用的 VM 大小取決於區域和可用性設定組。		 'Basic_A0'
'Basic_A1'
'Basic_A2'
'Basic_A3'
'Basic_A4'
'Standard_A0'
'Standard_A1'
'Standard_A10'
'Standard_A11'
'Standard_A1_v2'
'Standard_A2'
'Standard_A2m_v2'
'Standard_A2_v2'
'Standard_A3'
'Standard_A4'
'Standard_A4m_v2'
'Standard_A4_v2'
'Standard_A5'
'Standard_A6'
'Standard_A7'
'Standard_A8'
'Standard_A8m_v2'
'Standard_A8_v2'
'Standard_A9'
'Standard_B1ms'
'Standard_B1s'
'Standard_B2ms'
'Standard_B2s'
'Standard_B4ms'
'Standard_B8ms'
'Standard_D1'
'Standard_D11'
'Standard_D11_v2'
'Standard_D12'
'Standard_D12_v2'
'Standard_D13'
'Standard_D13_v2'
'Standard_D14'
'Standard_D14_v2'
'Standard_D15_v2'
'Standard_D16s_v3'
'Standard_D16_v3'
'Standard_D1_v2'
'Standard_D2'
'Standard_D2s_v3'
'Standard_D2_v2'
'Standard_D2_v3'
'Standard_D3'
'Standard_D32s_v3'
'Standard_D32_v3'
'Standard_D3_v2'
'Standard_D4'
'Standard_D4s_v3'
'Standard_D4_v2'
'Standard_D4_v3'
'Standard_D5_v2'
'Standard_D64s_v3'
'Standard_D64_v3'
'Standard_D8s_v3'
'Standard_D8_v3'
'Standard_DS1'
'Standard_DS11'
'Standard_DS11_v2'
'Standard_DS12'
'Standard_DS12_v2'
'Standard_DS13'
'Standard_DS13-2_v2'
'Standard_DS13-4_v2'
'Standard_DS13_v2'
'Standard_DS14'
'Standard_DS14-4_v2'
'Standard_DS14-8_v2'
'Standard_DS14_v2'
'Standard_DS15_v2'
'Standard_DS1_v2'
'Standard_DS2'
'Standard_DS2_v2'
'Standard_DS3'
'Standard_DS3_v2'
'Standard_DS4'
'Standard_DS4_v2'
'Standard_DS5_v2'
'Standard_E16s_v3'
'Standard_E16_v3'
'Standard_E2s_v3'
'Standard_E2_v3'
'Standard_E32-16_v3'
'Standard_E32-8s_v3'
'Standard_E32s_v3'
'Standard_E32_v3'
'Standard_E4s_v3'
'Standard_E4_v3'
'Standard_E64-16s_v3'
'Standard_E64-32s_v3'
'Standard_E64s_v3'
'Standard_E64_v3'
'Standard_E8s_v3'
'Standard_E8_v3'
'Standard_F1'
'Standard_F16'
'Standard_F16s'
'Standard_F16s_v2'
'Standard_F1s'
'Standard_F2'
'Standard_F2s'
'Standard_F2s_v2'
'Standard_F32s_v2'
'Standard_F4'
'Standard_F4s'
'Standard_F4s_v2'
'Standard_F64s_v2'
'Standard_F72s_v2'
'Standard_F8'
'Standard_F8s'
'Standard_F8s_v2'
'Standard_G1'
'Standard_G2'
'Standard_G3'
'Standard_G4'
'Standard_G5'
'Standard_GS1'
'Standard_GS2'
'Standard_GS3'
'Standard_GS4'
'Standard_GS4-4'
'Standard_GS4-8'
'Standard_GS5'
'Standard_GS5-16'
'Standard_GS5-8'
'Standard_H16'
'Standard_H16m'
'Standard_H16mr'
'Standard_H16r'
'Standard_H8'
'Standard_H8m'
'Standard_L16s'
'Standard_L32s'
'Standard_L4s'
'Standard_L8s'
'Standard_M128-32ms'
'Standard_M128-64ms'
'Standard_M128ms'
'Standard_M128s'
'Standard_M64-16ms'
'Standard_M64-32ms'
'Standard_M64ms'
'Standard_M64s'
'Standard_NC12'
'Standard_NC12s_v2'
'Standard_NC12s_v3'
'Standard_NC24'
'Standard_NC24r'
'Standard_NC24rs_v2'
'Standard_NC24rs_v3'
'Standard_NC24s_v2'
'Standard_NC24s_v3'
'Standard_NC6'
'Standard_NC6s_v2'
'Standard_NC6s_v3'
'Standard_ND12s'
'Standard_ND24rs'
'Standard_ND24s'
'Standard_ND6s'
'Standard_NV12'
'Standard_NV24'
'Standard_NV6'

ImageReference

名字 描述 價值
id 資源標識碼 字串
提供 指定用來建立虛擬機的平臺映像或市集映像供應專案。 字串
發行人 映像發行者。 字串
sku 映像 SKU。 字串
版本 指定用來建立虛擬機的平臺映像或市集映像版本。 允許的格式為 Major.Minor.Build 或 'latest'。 主要、次要和組建是十進位數。 指定 'latest' 以在部署時間使用可用映像的最新版本。 即使您使用「最新」，即使有新版本可用，VM 映像也不會在部署時間之後自動更新。 字串

KeyVaultKeyReference

名字 描述 價值
keyUrl 參考 Key Vault 中金鑰加密金鑰的 URL。 字串 （必要）
sourceVault 包含金鑰之 Key Vault 的相對 URL。 SubResource （必要）

KeyVaultSecretReference

名字 描述 價值
secretUrl 參考 Key Vault 中秘密的 URL。 字串 （必要）
sourceVault 包含秘密之 Key Vault 的相對 URL。 SubResource （必要）

LinuxConfiguration

名字 描述 價值
disablePasswordAuthentication 指定是否應停用密碼驗證。 bool
patchSettings [預覽功能]指定與Linux上的VM客體修補相關的設定。 LinuxPatchSettings
provisionVMAgent 指出虛擬機器代理程式是否應該佈建在虛擬機上。

當要求本文中未指定此屬性時，預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。		 bool
ssh 指定 Linux OS 的 SSH 金鑰組態。 SshConfiguration

LinuxPatchSettings

名字 描述 價值
patchMode 指定 VM 客體修補至 IaaS 虛擬機的模式。

可能的值為：

ImageDefault - 會使用虛擬機的預設修補組態。

AutomaticByPlatform - 虛擬機將由平台自動更新。 屬性 provisionVMAgent 必須為 true		 'AutomaticByPlatform'
'ImageDefault'

ManagedDiskParameters

名字 描述 價值
diskEncryptionSet 指定受控磁碟的客戶受控磁碟加密集資源標識符。 DiskEncryptionSetParameters
id 資源標識碼 字串
storageAccountType 指定受控磁碟的記憶體帳戶類型。 只有當您建立擴展集時，才能設定受控 OS 磁碟記憶體帳戶類型。 注意：UltraSSD_LRS只能與數據磁碟搭配使用，因此無法與OS磁碟搭配使用。 'Premium_LRS'
'Premium_ZRS'
'StandardSSD_LRS'
'StandardSSD_ZRS'
'Standard_LRS'
'UltraSSD_LRS'

Microsoft.Compute/virtualMachineScaleSets/virtualmachines

名字 描述 價值
位置 資源位置 字串 （必要）
名字 資源名稱 字串 （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：virtualMachineScaleSets
計劃 指定用來建立虛擬機之 Marketplace 映像的相關信息。 此元素僅用於市集映像。 您必須先啟用映像以程序設計方式使用，才能從 API 使用市集映射。 在 Azure 入口網站中，尋找您想要使用的市集映像，然後按兩下 [想要以程序設計方式部署]、[開始使用] ->。 輸入任何必要資訊，然後按下 [儲存]。 計劃
性能 描述虛擬機擴展集虛擬機的屬性。 VirtualMachineScaleSetVMProperties
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.Compute/virtualMachineScaleSets/virtualmachines@2020-12-01”

NetworkInterfaceReference

名字 描述 價值
id 資源標識碼 字串
性能 描述網路介面參考屬性。 NetworkInterfaceReferenceProperties

NetworkInterfaceReferenceProperties

名字 描述 價值
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool

NetworkProfile

名字 描述 價值
networkInterfaces 指定與虛擬機相關聯之網路介面的資源標識符清單。 NetworkInterfaceReference[]

OSDisk

名字 描述 價值
緩存 指定快取需求。

可能的值為：

無

ReadOnly

ReadWrite

默認值：標準記憶體的無。 Premium 記憶體的 ReadOnly。		 'None'
'ReadOnly'
'ReadWrite'
createOption 指定應如何建立虛擬機。

可能的值為：

附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。

FromImage \u2013 當您使用映射建立虛擬機時，會使用此值。 如果您使用平臺映像，則也會使用上述的 imageReference 元素。 如果您使用市集映像，則也會使用先前所述的 plan 元素。		 'Attach'
'Empty'
'FromImage' （必要）
diffDiskSettings 指定虛擬機所用作業系統磁碟的暫時磁碟設定。 DiffDiskSettings
diskSizeGB 指定以 GB 為單位的空白資料磁碟大小。 這個元素可用來覆寫虛擬機映像中的磁碟大小。

此值不能大於 1023 GB		 int
encryptionSettings 指定 OS 磁碟的加密設定。

API 版本下限：2015-06-15		 DiskEncryptionSettings
圖像 來源使用者映像虛擬硬碟。 在連接至虛擬機之前，將會先複製虛擬硬碟。 如果提供SourceImage，則目的地虛擬硬碟不得存在。 VirtualHardDisk
managedDisk 受控磁碟參數。 ManagedDiskParameters
名字 磁碟名稱。 字串
osType 此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。

可能的值為：

Windows

Linux		 'Linux'
'Windows'
vhd 虛擬硬碟。 VirtualHardDisk
writeAcceleratorEnabled 指定是否應該在磁碟上啟用或停用 writeAccelerator。 bool

OSProfile

名字 描述 價值
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 擴充功能 管理使用者、SSH 及檢查或修復 Azure Linux VM 上的磁碟		 字串

約束：
敏感性值。 以安全參數的形式傳入。
adminUsername 指定系統管理員帳戶的名稱。

建立 VM 之後，就無法更新此屬性。

僅限 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 個字元

li 如需 Linux VM 的根存取權，請參閱在 Azure 中使用 Linux 虛擬機上的根許可權
<li> 如需不應該在此欄位中使用的 Linux 內建系統使用者清單，請參閱在 Azure 上選取 Linux 的使用者名稱 		字串
allowExtensionOperations 指定虛擬機上是否應該允許擴充功能作業。

只有在虛擬機上沒有擴充功能時，才會將此選項設定為 False。		 bool
computerName 指定虛擬機的主機OS名稱。

建立 VM 之後，無法更新此名稱。

長度上限 （Windows）： 15 個字元

長度上限（Linux）： 64 個字元。

如需命名慣例和限制，請參閱Azure 基礎結構服務實作指導方針。		 字串
customData 指定自訂數據的base-64編碼字串。 base-64 編碼字串會譯碼為儲存為虛擬機上檔案的二進位數組。 二進位陣列的最大長度為65535個字節。

注意：請勿在 customData 屬性中傳遞任何秘密或密碼

建立 VM 之後，就無法更新此屬性。

customData 會傳遞至要儲存為檔案的 VM，如需詳細資訊，請參閱在 Azure VM 上 自定義數據

如需針對Linux VM使用cloud-init，請參閱在 建立期間使用cloud-init自定義Linux VM 		字串
linuxConfiguration 指定虛擬機上的Linux作業系統設定。

如需支援的Linux發行版清單，請參閱 Azure-Endorsed 發行版上的 Linux

如需執行非背書散發套件，請參閱 非背書散發套件的資訊。		 LinuxConfiguration
requireGuestProvisionSignal 指定是否需要來賓布建訊號，才能推斷虛擬機的布建成功。 注意：此屬性僅適用於私人測試，而且所有客戶都不得將 屬性設定為 false。 bool
秘密 指定應該安裝在虛擬機上的憑證集。 VaultSecretGroup[]
windowsConfiguration 指定虛擬機上的 Windows 作業系統設定。 WindowsConfiguration

PatchSettings

名字 描述 價值
enableHotpatching 可讓客戶修補其 Azure VM，而不需要重新啟動。 針對 enableHotpatching，'provisionVMAgent' 必須設定為 true，且 'patchMode' 必須設定為 'AutomaticByPlatform'。 bool
patchMode 指定 VM 客體修補至 IaaS 虛擬機的模式。

可能的值為：

手動 - 您可以控制將修補程式的應用程式套用至虛擬機。 您可以手動在 VM 內套用修補程式來執行此動作。 在此模式中，會停用自動更新;屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 false

AutomaticByOS - 作業系統會自動更新虛擬機。 屬性 WindowsConfiguration.enableAutomaticUpdates 必須為 true。

AutomaticByPlatform - 虛擬機會由平台自動更新。 provisionVMAgent 和 WindowsConfiguration.enableAutomaticUpdates 的屬性必須是 true		 'AutomaticByOS'
'AutomaticByPlatform'
'Manual'

計劃

名字 描述 價值
名字 方案標識碼。 字串
產品 指定來自市集的映像產品。 這個值與 imageReference 元素下的 Offer 值相同。 字串
promotionCode 促銷碼。 字串
發行人 發行者標識碼。 字串

ResourceTags

名字 描述 價值

SecurityProfile

名字 描述 價值
encryptionAtHost 用戶可以在要求中使用這個屬性來啟用或停用虛擬機或虛擬機擴展集的主機加密。 這會啟用所有磁碟的加密，包括主機本身的資源/暫存磁碟。

默認值：除非資源將此屬性設定為 true，否則將會停用主機的加密。		 bool
securityType 指定虛擬機的 SecurityType。 它會設定為 TrustedLaunch 以啟用 UefiSettings。

默認值：除非此屬性設定為 TrustedLaunch，否則不會啟用 UefiSettings。		 'TrustedLaunch'
uefiSettings 指定建立虛擬機時所使用的安全開機和 vTPM 等安全性設定。

API 版本下限：2020-12-01		 UefiSettings

SshConfiguration

名字 描述 價值
publicKeys 用來向Linux型VM進行驗證的SSH公鑰清單。 SshPublicKey[]

SshPublicKey

名字 描述 價值
keyData 用來透過 ssh 向 VM 進行驗證的 SSH 公鑰憑證。 密鑰至少必須是 2048 位，且格式為 ssh-rsa。

如需建立 ssh 金鑰，請參閱 在 Azure中建立 Linux 和 Mac 上的 SSH 金鑰。		 字串
路徑 指定已建立 VM 上儲存 SSH 公鑰的完整路徑。 如果檔案已經存在，指定的索引鍵會附加至檔案。 範例：/home/user/.ssh/authorized_keys 字串

StorageProfile

名字 描述 價值
dataDisks 指定用來將數據磁碟新增至虛擬機的參數。

如需磁碟的詳細資訊，請參閱 關於 Azure 虛擬機器的磁碟和 VHD。		 DataDisk[]
imageReference 指定要使用之映像的相關信息。 您可以指定平臺映像、市集映像或虛擬機映像的相關信息。 當您想要使用平臺映像、市集映像或虛擬機映像，但未用於其他建立作業時，則需要此元素。 ImageReference
osDisk 指定虛擬機所使用的作業系統磁碟相關信息。

如需磁碟的詳細資訊，請參閱 關於 Azure 虛擬機器的磁碟和 VHD。		 OSDisk

SubResource

名字 描述 價值
id 資源標識碼 字串

UefiSettings

名字 描述 價值
secureBootEnabled 指定是否應在虛擬機上啟用安全開機。

API 版本下限：2020-12-01		 bool
vTpmEnabled 指定是否應在虛擬機上啟用 vTPM。

API 版本下限：2020-12-01		 bool

VaultCertificate

名字 描述 價值
certificateStore 針對 Windows VM，指定應新增憑證之虛擬機上的證書存儲。 指定的證書存儲隱含在 LocalMachine 帳戶中。

針對 Linux VM，憑證檔案會放在 /var/lib/waagent 目錄底下，檔名 <X509 憑證檔案的大寫Thumbprint>.crt，並針對私鑰 <大寫Thumbprint>.prv。 這兩個檔案都是 .pem 格式。		 字串
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault，請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8：

{
“data”：“<Base64 編碼憑證>”，
“dataType”：“pfx”，
“password”：“<pfx-file-password>”
}		 字串

VaultSecretGroup

名字 描述 價值
sourceVault Key Vault 的相對 URL，其中包含 VaultCertificates 中的所有憑證。 SubResource
vaultCertificates SourceVault 中包含憑證的金鑰保存庫參考清單。 VaultCertificate[]

VirtualHardDisk

名字 描述 價值
uri 指定虛擬硬碟的 URI。 字串

VirtualMachineScaleSetIPConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 IP 組態名稱。 字串 （必要）
性能 描述虛擬機擴展集網路配置檔的IP組態屬性。 VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties

名字 描述 價值
applicationGatewayBackendAddressPools 指定應用程式閘道後端位址池的參考數位。 擴展集可以參考多個應用程式閘道的後端位址池。 多個擴展集無法使用相同的應用程式閘道。 SubResource[]
applicationSecurityGroups 指定應用程式安全組參考的陣列。 SubResource[]
loadBalancerBackendAddressPools 指定負載平衡器後端位址池的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的後端位址池。 多個擴展集無法使用相同的基本 SKU 負載平衡器。 SubResource[]
loadBalancerInboundNatPools 指定負載平衡器輸入 Nat 集區的參考陣列。 擴展集可以參考一個公用和一個內部負載平衡器的輸入 nat 集區。 多個擴展集無法使用相同的基本 SKU 負載平衡器。 SubResource[]
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool
privateIPAddressVersion 從 Api-Version 2017-03-30 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為：'IPv4' 和 'IPv6'。 'IPv4'
'IPv6'
publicIPAddressConfiguration publicIPAddressConfiguration。 VirtualMachineScaleSetPublicIPAddressConfiguration
子 指定子網的識別碼。 ApiEntityReference

VirtualMachineScaleSetIpTag

名字 描述 價值
ipTagType IP 標籤類型。 範例：FirstPartyUsage。 字串
標記 與公用IP相關聯的IP標籤。 範例：SQL、記憶體等。 字串

VirtualMachineScaleSetNetworkConfiguration

名字 描述 價值
id 資源標識碼 字串
名字 網路組態名稱。 字串 （必要）
性能 描述虛擬機擴展集網路配置檔的IP組態。 VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationDnsSettings

名字 描述 價值
dnsServers DNS 伺服器 IP 位址清單 string[]

VirtualMachineScaleSetNetworkConfigurationProperties

名字 描述 價值
dnsSettings 要套用在網路介面上的 DNS 設定。 VirtualMachineScaleSetNetworkConfigurationDnsSettings
enableAcceleratedNetworking 指定網路介面是否已啟用加速網路功能。 bool
enableFpga 指定網路介面是否已啟用 FPGA 網路功能。 bool
enableIPForwarding 是否在此 NIC 上啟用 IP 轉送。 bool
ipConfigurations 指定網路介面的IP組態。 VirtualMachineScaleSetIPConfiguration[] （必要）
networkSecurityGroup 網路安全組。 SubResource
主要 指定虛擬機有1個以上的網路介面時的主要網路介面。 bool

VirtualMachineScaleSetPublicIPAddressConfiguration

名字 描述 價值
名字 publicIP 位址組態名稱。 字串 （必要）
性能 描述虛擬機擴展集IP組態的PublicIPAddress組態 VirtualMachineScaleSetPublicIPAddressConfigurationProperties

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

名字 描述 價值
domainNameLabel 功能變數名稱標籤。功能變數名稱標籤和 VM 索引的串連將是將要建立之 PublicIPAddress 資源的功能變數名稱標籤 字串 （必要）

VirtualMachineScaleSetPublicIPAddressConfigurationProperties

名字 描述 價值
dnsSettings 要套用至 publicIP 位址的 DNS 設定。 VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
idleTimeoutInMinutes 公用IP位址的閒置逾時。 int
ipTags 與公用IP位址相關聯的IP標籤清單。 VirtualMachineScaleSetIpTag[]
publicIPAddressVersion 從 Api-Version 2019-07-01 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。 預設值會視為 IPv4。 可能的值為：'IPv4' 和 'IPv6'。 'IPv4'
'IPv6'
publicIPPrefix 要從中配置 publicIP 位址的 PublicIPPrefix。 SubResource

VirtualMachineScaleSetVMNetworkProfileConfiguration

名字 描述 價值
networkInterfaceConfigurations 網路組態的清單。 VirtualMachineScaleSetNetworkConfiguration[]

VirtualMachineScaleSetVMProperties

名字 描述 價值
additionalCapabilities 指定擴展集中虛擬機上啟用或停用的其他功能。 例如：虛擬機是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。 AdditionalCapabilities
availabilitySet 指定虛擬機應指派之可用性設定組的相關信息。 相同可用性設定組中指定的虛擬機會配置給不同的節點，以將可用性最大化。 如需可用性設定組的詳細資訊，請參閱 管理虛擬機的可用性。

如需 Azure 計劃性維護的詳細資訊，請參閱 Azure 中虛擬機的計畫性維護

目前，VM 只能在建立時新增至可用性設定組。 現有的 VM 無法新增至可用性設定組。		 SubResource
diagnosticsProfile 指定開機診斷設定狀態。

API 版本下限：2015-06-15。		 DiagnosticsProfile
hardwareProfile 指定虛擬機的硬體設定。 HardwareProfile
licenseType 指定所使用的映像或磁碟已獲內部部署授權。

Windows Server 操作系統的可能值為：

Windows_Client

Windows_Server

Linux Server 操作系統的可能值為：

RHEL_BYOS （RHEL）

SLES_BYOS （適用於 SUSE）

如需詳細資訊，請參閱 適用於 Windows Server 的 Azure Hybrid Use Benefit

適用於Linux Server的 Azure Hybrid Use Benefit

API 版本下限：2015-06-15		 字串
networkProfile 指定虛擬機的網路介面。 NetworkProfile
networkProfileConfiguration 指定虛擬機的網路配置檔組態。 VirtualMachineScaleSetVMNetworkProfileConfiguration
osProfile 指定虛擬機的作業系統設定。 OSProfile
protectionPolicy 指定虛擬機的保護原則。 VirtualMachineScaleSetVMProtectionPolicy
securityProfile 指定虛擬機的安全性相關配置檔設定。 SecurityProfile
storageProfile 指定虛擬機磁碟的記憶體設定。 StorageProfile

VirtualMachineScaleSetVMProtectionPolicy

名字 描述 價值
protectFromScaleIn 指出虛擬機擴展集 VM 不應該考慮在相應縮小作業期間刪除。 bool
protectFromScaleSetActions 指出虛擬機擴展集上起始的模型更新或動作（包括相應縮小），不應套用至虛擬機擴展集 VM。 bool

WindowsConfiguration

名字 描述 價值
additionalUnattendContent 指定其他base-64編碼的 XML 格式資訊，這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。 AdditionalUnattendContent[]
enableAutomaticUpdates 指出是否為 Windows 虛擬機啟用自動更新。 默認值為 true。

針對虛擬機擴展集，此屬性可以更新，更新將會在OS重新佈建上生效。		 bool
patchSettings [預覽功能]指定與 Windows 上的 VM 客體修補相關的設定。 PatchSettings
provisionVMAgent 指出虛擬機器代理程式是否應該佈建在虛擬機上。

當要求本文中未指定此屬性時，預設行為是將它設定為 true。 這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。		 bool
timeZone 指定虛擬機的時區。 例如「太平洋標準時間」。

可能的值可以從 TimeZoneInfo.GetSystemTimeZones 所傳回的時區 TimeZoneInfo.Id 值。		 字串
winRM 指定 Windows 遠端管理接聽程式。 這可啟用遠端 Windows PowerShell。 WinRMConfiguration

WinRMConfiguration

名字 描述 價值
聽眾 Windows 遠端管理接聽程式清單 WinRMListener[]

WinRMListener

名字 描述 價值
certificateUrl 這是已上傳至 Key Vault 做為秘密之憑證的 URL。 如需將秘密新增至 Key Vault，請參閱 將金鑰或秘密新增至金鑰保存庫。 在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼，其編碼方式為 UTF-8：

{
“data”：“<Base64 編碼憑證>”，
“dataType”：“pfx”，
“password”：“<pfx-file-password>”
}		 字串
協定 指定 WinRM 接聽程式的通訊協定。

可能的值為：
http

https		 'Http'
'Https'