Virtual Machine Scale Sets - Update

參考

服務:: Compute

API 版本:: 2019-03-01

更新 VM 擴展集。

HTTP

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2019-03-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vmScaleSetName	path	True	string	要建立或更新的 VM 擴展集名稱。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	類型	Description
identity	VirtualMachineScaleSetIdentity	如果已設定，則為虛擬機擴展集的身分識別。
plan	Plan	從 VM Marketplace 映射部署虛擬機擴展集時的購買方案。
properties.additionalCapabilities	AdditionalCapabilities	指定虛擬機擴展集中虛擬機器上啟用或停用的其他功能。例如：虛擬機器是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。
properties.automaticRepairsPolicy	AutomaticRepairsPolicy	自動修復的原則。
properties.doNotRunExtensionsOnOverprovisionedVMs	boolean	啟用 Overprovision 時，擴充功能只會在最後保留的要求 VM 數目上啟動。因此，此屬性可確保擴充功能不會在額外的過度布建 VM 上執行。
properties.overprovision	boolean	指定是否應該過度布建虛擬機擴展集。
properties.proximityPlacementGroup	SubResource	指定虛擬機擴展集應指派的鄰近放置群組相關信息。 API 版本下限：2018-04-01。
properties.scaleInPolicy	ScaleInPolicy	指定相應縮小原則，決定在虛擬機擴展集相應縮小時要移除的虛擬機。
properties.singlePlacementGroup	boolean	若為 true，則會將擴展集限制為單一放置群組，大小上限為 100 部虛擬機。注意：如果 singlePlacementGroup 為 true，它可能會修改為 false。不過，如果 singlePlacementGroup 為 false，則無法修改成 true。
properties.upgradePolicy	UpgradePolicy	升級原則。
properties.virtualMachineProfile	VirtualMachineScaleSetUpdateVMProfile	虛擬機器配置檔。
sku	Sku	虛擬機擴展集 SKU。
tags	object	資源標籤

回應

名稱	類型	Description
200 OK	VirtualMachineScaleSet	確定

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

定義

名稱	Description
AdditionalCapabilities	啟用或停用虛擬機或虛擬機擴展集上的功能。
AdditionalUnattendContent	指定 Windows 安裝程式所使用的 Unattend.xml 檔案中可包含的其他 XML 格式資訊。內容是透過設定名稱、元件名稱和套用內容的傳遞來定義。
ApiEntityReference	API 實體參考。
AutomaticOSUpgradePolicy	用於執行自動OS升級的組態參數。
AutomaticRepairsPolicy	指定虛擬機擴展集上自動修復的組態參數。
BillingProfile	指定 Azure Spot VM 或 VMSS 的計費相關詳細數據。 API 版本下限：2019-03-01。
BootDiagnostics	開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照來診斷 VM 狀態。您可以輕鬆地檢視主控台記錄的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。
CachingTypes	指定快取需求。可能的值包括：無 ReadOnly 讀寫預設值：標準記憶體無。進階記憶體的 ReadOnly
ComponentNames	元件名稱。目前唯一允許的值是 Microsoft-Windows-Shell-Setup。
DiagnosticsProfile	指定開機診斷設定狀態。 API 版本下限：2015-06-15。
DiffDiskOptions	指定作業系統磁碟的暫時磁碟設定。
DiffDiskSettings	描述可針對操作系統磁碟指定之暫時磁碟設定的參數。注意：暫時磁碟設定只能針對受控磁碟指定。
DiskCreateOptionTypes	指定虛擬機的建立方式。可能的值包括：附加 \u2013 當您使用特製化磁碟來建立虛擬機時，會使用此值。 FromImage \u2013 當您使用映射來建立虛擬機時，會使用此值。如果您使用平臺映像，則也會使用上述的 imageReference 元素。如果您使用市集映射，您也會使用先前所述的 plan 元素。
ImageReference	指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但不會用於其他建立作業時，需要此元素。注意：映像參考發行者和供應專案只能在您建立擴展集時設定。
IPVersion	從 Api-Version 2017-03-30 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。預設值會視為 IPv4。可能的值為：'IPv4' 和 'IPv6'。
LinuxConfiguration	指定虛擬機上的Linux作業系統設定。如需支援的Linux發行版清單，請參閱 Azure-Endorsed 發行版上的Linux 如需執行非背書散發套件，請參閱非背書散發套件的資訊。
OperatingSystemTypes	osDiskImage 的操作系統。
PassNames	傳遞名稱。目前唯一允許的值是 OobeSystem。
Plan	指定用來建立虛擬機之 Marketplace 映像的相關信息。此元素僅用於市集映像。您必須先啟用映像以供程序設計使用，才能從 API 使用市集映射。在 Azure 入口網站中，尋找您想要使用的市集映射，然後按兩下 [以程序設計方式部署] [開始使用] -> 。輸入任何必要資訊，然後按兩下 [ 儲存]。
ProtocolTypes	指定接聽程式的通訊協定。可能的值包括： http https
ResourceIdentityType	用於虛擬機的身分識別類型。「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別，和一組使用者指派的身分識別。類型『None』將會從虛擬機中移除任何身分識別。
RollingUpgradePolicy	執行滾動升級時所使用的組態參數。
ScaleInPolicy	描述虛擬機擴展集的相應縮小原則。
ScheduledEventsProfile
SettingNames	指定要套用內容之設定的名稱。可能的值為：FirstLogonCommands 和 AutoLogon。
Sku	描述虛擬機擴展集 SKU。注意：如果擴展集目前所在的硬體上不支援新的 VM SKU，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。
SshConfiguration	在 Azure 上執行的 Linux 型 VM SSH 組態
SshPublicKey	包含 SSH 憑證公鑰的相關信息，以及放置公鑰之 Linux VM 上的路徑。
StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，它不能與OS磁碟搭配使用。
SubResource
TerminateNotificationProfile
UpgradeMode	指定升級至擴展集中虛擬機的模式。可能的值包括：手動 - 您可以控制擴充集中虛擬機更新的應用程式。您可以使用 manualUpgrade 宏指令來執行此動作。自動 -擴展集中的所有虛擬機都會同時自動更新。
UpgradePolicy	描述升級原則 - 自動、手動或滾動。
UserAssignedIdentities	與虛擬機相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
VaultCertificate	描述金鑰保存庫中的單一憑證參考，以及憑證應該位於 VM 上的位置。
VaultSecretGroup	描述一組相同金鑰保存庫中的所有憑證。
VirtualHardDisk	描述磁碟的 URI。
VirtualMachineEvictionPolicyTypes	指定 Azure Spot 虛擬機的收回原則。只有支援的值為『Deallocate』。最低 api-version：2019-03-01
VirtualMachinePriorityTypes	指定虛擬機的優先順序。最低 api-version：2019-03-01
VirtualMachineScaleSet	描述虛擬機擴展集。
VirtualMachineScaleSetDataDisk	描述虛擬機擴展集數據磁碟。
VirtualMachineScaleSetExtension	描述虛擬機擴展集擴充功能。
VirtualMachineScaleSetExtensionProfile	描述虛擬機擴展集擴充配置檔。
VirtualMachineScaleSetIdentity	虛擬機擴展集的身分識別。
VirtualMachineScaleSetIPConfiguration	描述虛擬機擴展集網路配置檔的IP組態。
VirtualMachineScaleSetIpTag	包含與公用IP位址相關聯的IP標記。
VirtualMachineScaleSetManagedDiskParameters	描述 ScaleSet 受控磁碟的參數。
VirtualMachineScaleSetNetworkConfiguration	描述虛擬機擴展集網路配置檔的網路組態。
VirtualMachineScaleSetNetworkConfigurationDnsSettings	描述虛擬機擴展集網路設定的 DNS 設定。
VirtualMachineScaleSetNetworkProfile	描述虛擬機擴展集網路配置檔。
VirtualMachineScaleSetOSDisk	描述虛擬機擴展集作業系統磁碟。
VirtualMachineScaleSetOSProfile	描述虛擬機擴展集 OS 配置檔。
VirtualMachineScaleSetPublicIPAddressConfiguration	描述虛擬機擴展集IP組態的PublicIPAddress設定
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	描述虛擬機擴展集網路設定的 DNS 設定。
VirtualMachineScaleSetScaleInRules	調整虛擬機擴展集時要遵循的規則。可能的值包括：預設當虛擬機擴展集相應縮小時，如果擴展集是區域性擴展集，則擴展集會先跨區域平衡。然後，它將會盡可能跨容錯網域進行平衡。在每個容錯網域內，選擇移除的虛擬機將會是不受相應縮小保護的最新虛擬機。 OldestVM 當虛擬機擴展集進行相應縮小時，將會選擇未受相應縮小保護的最舊虛擬機進行移除。針對區域性虛擬機擴展集，擴展集會先跨區域平衡。在每個區域內，將會選擇未受保護的最舊虛擬機來移除。 NewestVM 當虛擬機擴展集正在相應縮小時，系統會選擇未受相應縮小保護的最新虛擬機，以移除。針對區域性虛擬機擴展集，擴展集會先跨區域平衡。在每個區域中，將會選擇未受保護的最新虛擬機來移除。
VirtualMachineScaleSetStorageProfile	描述虛擬機擴展集記憶體配置檔。
VirtualMachineScaleSetUpdate	描述虛擬機擴展集。
VirtualMachineScaleSetUpdateIPConfiguration	描述虛擬機擴展集網路配置檔的IP組態。
VirtualMachineScaleSetUpdateNetworkConfiguration	描述虛擬機擴展集網路配置檔的網路組態。
VirtualMachineScaleSetUpdateNetworkProfile	描述虛擬機擴展集網路配置檔。
VirtualMachineScaleSetUpdateOSDisk	描述虛擬機擴展集作業系統磁碟 Update 物件。這應該用於更新 VMSS OS 磁碟。
VirtualMachineScaleSetUpdateOSProfile	描述虛擬機擴展集 OS 配置檔。
VirtualMachineScaleSetUpdatePublicIPAddressConfiguration	描述虛擬機擴展集IP組態的PublicIPAddress設定
VirtualMachineScaleSetUpdateStorageProfile	描述虛擬機擴展集記憶體配置檔。
VirtualMachineScaleSetUpdateVMProfile	描述虛擬機擴展集虛擬機配置檔。
VirtualMachineScaleSetVMProfile	描述虛擬機擴展集虛擬機配置檔。
WindowsConfiguration	指定虛擬機器上的 Windows 作業系統設定。
WinRMConfiguration	描述 VM 的 Windows 遠端管理設定
WinRMListener	描述 Windows 遠端管理接聽程式的通訊協議和指紋

AdditionalCapabilities

啟用或停用虛擬機或虛擬機擴展集上的功能。

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

AdditionalUnattendContent

指定 Windows 安裝程式所使用的 Unattend.xml 檔案中可包含的其他 XML 格式資訊。內容是透過設定名稱、元件名稱和套用內容的傳遞來定義。

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

ApiEntityReference

API 實體參考。

名稱	類型	Description
id	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... 格式的 ARM 資源標識符

AutomaticOSUpgradePolicy

用於執行自動OS升級的組態參數。

名稱	類型	Description
disableAutomaticRollback	boolean	是否應該停用OS映像復原功能。預設值為 False。
enableAutomaticOSUpgrade	boolean	指出當較新版本的OS映像可供使用時，是否應該以滾動方式將操作系統升級自動套用至擴展集實例。預設值為 False。如果 Windows 擴展集將此設定為 true，enableAutomaticUpdates 會自動設定為 false，而且無法設定為 true。

AutomaticRepairsPolicy

指定虛擬機擴展集上自動修復的組態參數。

名稱	類型	Description
enabled	boolean	指定是否應在虛擬機擴展集上啟用自動修復。預設值為 false。
gracePeriod	string	因為 VM 上的狀態變更而暫停自動修復的時間量。寬限時間會在狀態變更完成之後開始。這有助於避免提前或意外修復。時間持續時間應以 ISO 8601 格式指定。允許的寬限期下限為 30 分鐘， (PT30M) ，這也是預設值。允許的寬限期上限為 90 分鐘， (PT90M) 。

BillingProfile

指定 Azure Spot VM 或 VMSS 的計費相關詳細數據。

API 版本下限：2019-03-01。

名稱	類型	Description
maxPrice	number	指定您願意支付 Azure Spot VM/VMSS 的最大價格。此價格以美元為單位。此價格將會與 VM 大小的目前 Azure Spot 價格進行比較。此外，價格會在建立/更新 Azure Spot VM/VMSS 時進行比較，而且只有在 maxPrice 大於目前的 Azure Spot 價格時，作業才會成功。如果目前的 Azure Spot 價格在建立 VM/VMSS 之後超過 maxPrice，則 maxPrice 也會用於收回 Azure Spot VM/VMSS。可能的值包括： - 大於零的任何十進位值。範例：0.01538 -1 – 表示預設價格為隨選。您可以將 maxPrice 設定為 -1，以指出基於價格考慮，不應收回 Azure Spot VM/VMSS。此外，如果預設的最大值價格不是由您提供，則為 -1。 API 版本下限：2019-03-01。

BootDiagnostics

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

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

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

名稱	類型	Description
enabled	boolean	虛擬機上是否應該啟用開機診斷。
storageUri	string	用來放置主控台輸出和螢幕快照的記憶體帳戶 URI。

CachingTypes

指定快取需求。

可能的值包括：

無

ReadOnly

讀寫

預設值： 標準記憶體無。進階記憶體的 ReadOnly

名稱	類型	Description
None	string
ReadOnly	string
ReadWrite	string

ComponentNames

元件名稱。目前唯一允許的值是 Microsoft-Windows-Shell-Setup。

名稱	類型	Description
Microsoft-Windows-Shell-Setup	string

DiagnosticsProfile

指定開機診斷設定狀態。

API 版本下限：2015-06-15。

名稱	類型	Description
bootDiagnostics	BootDiagnostics	開機診斷是一項偵錯功能，可讓您檢視控制台輸出和螢幕快照以診斷 VM 狀態。您可以輕鬆地檢視主控台記錄檔的輸出。 Azure 也可讓您從 Hypervisor 查看 VM 的螢幕快照。

DiffDiskOptions

指定作業系統磁碟的暫時磁碟設定。

名稱	類型	Description
Local	string

DiffDiskSettings

描述可針對操作系統磁碟指定之暫時磁碟設定的參數。

注意：暫時磁碟設定只能針對受控磁碟指定。

名稱	類型	Description
option	DiffDiskOptions	指定作業系統磁碟的暫時磁碟設定。

DiskCreateOptionTypes

指定虛擬機的建立方式。

可能的值包括：

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

FromImage \u2013 當您使用映射來建立虛擬機時，會使用此值。如果您使用平臺映像，則也會使用上述的 imageReference 元素。如果您使用市集映射，您也會使用先前所述的 plan 元素。

名稱	類型	Description
Attach	string
Empty	string
FromImage	string

ImageReference

指定要使用之映像的相關信息。您可以指定平臺映像、市集映像或虛擬機映像的相關信息。當您想要使用平臺映像、市集映像或虛擬機映像，但不會用於其他建立作業時，需要此元素。注意：映像參考發行者和供應專案只能在您建立擴展集時設定。

名稱	類型	Description
id	string	資源標識碼
offer	string	指定用來建立虛擬機的平臺映像或 Marketplace 映像供應專案。
publisher	string	映像發行者。
sku	string	映像 SKU。
version	string	指定用來建立虛擬機的平臺映像或 Marketplace 映像版本。允許的格式為 Major.Minor.Build 或 'latest'。主要、次要和組建是十進位數。指定「最新」以使用部署階段可用的最新映像版本。即使您使用「最新」，即使有新版本可供使用，VM 映像也不會在部署時間之後自動更新。

IPVersion

從 Api-Version 2017-03-30 起提供，它代表特定 ipconfiguration 是 IPv4 或 IPv6。預設值會視為 IPv4。可能的值為：'IPv4' 和 'IPv6'。

名稱	類型	Description
IPv4	string
IPv6	string

LinuxConfiguration

指定虛擬機上的Linux作業系統設定。

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

如需執行非背書散發套件，請參閱非背書散發套件的資訊。

名稱	類型	Description
disablePasswordAuthentication	boolean	指定是否應該停用密碼驗證。
provisionVMAgent	boolean	指出是否應該在虛擬機器上佈建虛擬機器代理程式。當要求本文中未指定這個屬性時，預設行為是將它設定為 true。這可確保 VM 代理程式已安裝在 VM 上，以便稍後將擴充功能新增至 VM。
ssh	SshConfiguration	指定 Linux OS 的 SSH 金鑰組態。

OperatingSystemTypes

osDiskImage 的操作系統。

名稱	類型	Description
Linux	string
Windows	string

PassNames

傳遞名稱。目前唯一允許的值是 OobeSystem。

名稱	類型	Description
OobeSystem	string

Plan

指定用來建立虛擬機之 Marketplace 映像的相關信息。此元素僅用於市集映像。您必須先啟用映像以供程序設計使用，才能從 API 使用市集映射。在 Azure 入口網站中，尋找您想要使用的市集映射，然後按兩下 [以程序設計方式部署] [開始使用] -> 。輸入任何必要資訊，然後按兩下 [ 儲存]。

名稱	類型	Description
name	string	方案標識碼。
product	string	指定市集中映像的產品。這與 imageReference 元素下的 Offer 值相同。
promotionCode	string	促銷碼。
publisher	string	發行者標識碼。

ProtocolTypes

指定接聽程式的通訊協定。

可能的值包括：
http

https

名稱	類型	Description
Http	string
Https	string

ResourceIdentityType

用於虛擬機的身分識別類型。「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別，和一組使用者指派的身分識別。類型『None』將會從虛擬機中移除任何身分識別。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

RollingUpgradePolicy

執行滾動升級時所使用的組態參數。

名稱	類型	Description
maxBatchInstancePercent	integer	一個批次中的滾動升級會同時升級的虛擬機實例總數百分比上限。由於這是最大值，先前或未來批次中狀況不良的實例可能會導致批次中的實例百分比降低，以確保更高的可靠性。此參數的預設值為 20%。
maxUnhealthyInstancePercent	integer	擴展集中可同時狀況不良之虛擬機實例總數的百分比上限，可能是因為升級而發生，或是在滾動升級中止之前，虛擬機健康情況檢查處於狀況不良狀態。啟動任何批次之前，將會先檢查此條件約束。此參數的預設值為 20%。
maxUnhealthyUpgradedInstancePercent	integer	已升級的虛擬機實例百分比上限，這些實例可能處於狀況不良狀態。升級每個批次之後，就會進行這項檢查。如果超過此百分比，滾動更新就會中止。此參數的預設值為 20%。
pauseTimeBetweenBatches	string	在一個批次中完成所有虛擬機的更新，以及啟動下一個批次之間的等候時間。時間持續時間應以 ISO 8601 格式指定。默認值為 0 秒， (PT0S) 。

ScaleInPolicy

描述虛擬機擴展集的相應縮小原則。

名稱	類型	Description
rules	VirtualMachineScaleSetScaleInRules[]	調整虛擬機擴展集時要遵循的規則。可能的值包括：預設當虛擬機擴展集相應縮小時，如果擴展集是區域性擴展集，則擴展集會先跨區域平衡。然後，它將會盡可能跨容錯網域進行平衡。在每個容錯網域內，選擇移除的虛擬機將會是不受相應縮小保護的最新虛擬機。 OldestVM 當虛擬機擴展集進行相應縮小時，將會選擇未受相應縮小保護的最舊虛擬機進行移除。針對區域性虛擬機擴展集，擴展集會先跨區域平衡。在每個區域內，將會選擇未受保護的最舊虛擬機來移除。 NewestVM 當虛擬機擴展集正在相應縮小時，系統會選擇未受相應縮小保護的最新虛擬機，以移除。針對區域性虛擬機擴展集，擴展集會先跨區域平衡。在每個區域中，將會選擇未受保護的最新虛擬機來移除。

ScheduledEventsProfile

名稱	類型	Description
terminateNotificationProfile	TerminateNotificationProfile	指定終止排程事件相關組態。

SettingNames

指定要套用內容之設定的名稱。可能的值為：FirstLogonCommands 和 AutoLogon。

名稱	類型	Description
AutoLogon	string
FirstLogonCommands	string

Sku

描述虛擬機擴展集 SKU。注意：如果擴展集目前所在的硬體上不支援新的 VM SKU，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。

名稱	類型	Description
capacity	integer	指定擴展集中的虛擬機數目。
name	string	SKU 名稱。
tier	string	指定擴展集中的虛擬機層。可能的值如下：標準基本

SshConfiguration

在 Azure 上執行的 Linux 型 VM SSH 組態

名稱	類型	Description
publicKeys	SshPublicKey[]	用來向Linux型VM進行驗證的SSH公鑰清單。

SshPublicKey

包含 SSH 憑證公鑰的相關信息，以及放置公鑰之 Linux VM 上的路徑。

名稱	類型	Description
keyData	string	用來透過 ssh 向 VM 進行驗證的 SSH 公鑰憑證。密鑰至少必須是 2048 位，且以 ssh-rsa 格式表示。如需建立 ssh 金鑰，請參閱在 Azure 中的 Linux 和 Mac 上建立 Linux VM 上的 SSH 金鑰。
path	string	指定儲存 ssh 公鑰之已建立 VM 上的完整路徑。如果檔案已經存在，指定的金鑰就會附加至該檔案。範例：/home/user/.ssh/authorized_keys

StorageAccountTypes

指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，它不能與OS磁碟搭配使用。

名稱	類型	Description
Premium_LRS	string
StandardSSD_LRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

名稱	類型	Description
id	string	資源標識碼

TerminateNotificationProfile

名稱	類型	Description
enable	boolean	指定是否啟用或停用 Terminate Scheduled 事件。
notBeforeTimeout	string	刪除虛擬機的可設定時間長度，在自動核准事件之前，虛擬機必須核准終止排程事件， (逾時) 。設定必須以 ISO 8601 格式指定，預設值為 5 分鐘， (PT5M)

UpgradeMode

指定升級至擴展集中虛擬機的模式。

可能的值包括：

手動 - 您可以控制擴充集中虛擬機更新的應用程式。您可以使用 manualUpgrade 宏指令來執行此動作。

自動 -擴展集中的所有虛擬機都會同時自動更新。

名稱	類型	Description
Automatic	string
Manual	string
Rolling	string

UpgradePolicy

描述升級原則 - 自動、手動或滾動。

名稱	類型	Description
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	用於執行自動作業系統升級的組態參數。
mode	UpgradeMode	指定升級至擴展集中虛擬機的模式。可能的值包括：手動 - 您可以控制擴充集中虛擬機更新的應用程式。您可以使用 manualUpgrade 宏指令來執行此動作。自動 -擴展集中的所有虛擬機都會同時自動更新。
rollingUpgradePolicy	RollingUpgradePolicy	執行滾動升級時所使用的組態參數。

UserAssignedIdentities

與虛擬機相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱	類型	Description

VaultCertificate

描述金鑰保存庫中的單一憑證參考，以及憑證應該位於 VM 上的位置。

名稱	類型	Description
certificateStore	string	針對 Windows VM，指定應在其中新增憑證之虛擬機上的證書存儲。指定的證書存儲會隱含地在 LocalMachine 帳戶中。針對Linux VM，憑證檔案會放在 /var/lib/waagent 目錄底下，而 X509 憑證檔案的檔名 <為 UppercaseThumbprint.crt>， <而私鑰則為 UppercaseThumbprint.prv>。這兩個檔案都是 .pem 格式。
certificateUrl	string	這是已上傳至金鑰保存庫作為秘密之憑證的 URL。如需將秘密新增至金鑰保存庫，請參閱將密鑰或秘密新增至密鑰保存庫。在此情況下，您的憑證必須是下列 JSON 物件的 Base64 編碼方式，此物件是以 UTF-8 編碼： { “data”：“”， “dataType”：“pfx”， “password”：“” }

VaultSecretGroup

描述一組相同金鑰保存庫中的所有憑證。

名稱	類型	Description
sourceVault	SubResource	包含 VaultCertificates 中所有憑證之金鑰保存庫的相對 URL。
vaultCertificates	VaultCertificate[]	SourceVault 中包含憑證的金鑰保存庫參考清單。

VirtualHardDisk

描述磁碟的 URI。

名稱	類型	Description
uri	string	指定虛擬硬碟的 URI。

VirtualMachineEvictionPolicyTypes

指定 Azure Spot 虛擬機的收回原則。只有支援的值為『Deallocate』。

最低 api-version：2019-03-01

名稱	類型	Description
Deallocate	string
Delete	string

VirtualMachinePriorityTypes

指定虛擬機的優先順序。

最低 api-version：2019-03-01

名稱	類型	Description
Low	string
Regular	string
Spot	string

VirtualMachineScaleSet

描述虛擬機擴展集。

名稱	類型	Description
id	string	資源標識碼
identity	VirtualMachineScaleSetIdentity	如果已設定，則為虛擬機擴展集的身分識別。
location	string	資源位置
name	string	資源名稱
plan	Plan	指定用來建立虛擬機之 Marketplace 映像的相關信息。此元素僅用於市集映像。您必須先啟用映像以供程序設計使用，才能從 API 使用市集映射。在 Azure 入口網站中，尋找您想要使用的市集映射，然後按兩下 [以程序設計方式部署] [開始使用] -> 。輸入任何必要資訊，然後按兩下 [ 儲存]。
properties.additionalCapabilities	AdditionalCapabilities	指定虛擬機擴展集中虛擬機器上啟用或停用的其他功能。例如：虛擬機器是否能夠支援使用UltraSSD_LRS記憶體帳戶類型鏈接受控數據磁碟。
properties.automaticRepairsPolicy	AutomaticRepairsPolicy	自動修復的原則。
properties.doNotRunExtensionsOnOverprovisionedVMs	boolean	啟用 Overprovision 時，擴充功能只會在最後保留的要求 VM 數目上啟動。因此，此屬性可確保擴充功能不會在額外的過度布建 VM 上執行。
properties.overprovision	boolean	指定是否應過度布建虛擬機擴展集。
properties.platformFaultDomainCount	integer	每個放置群組的容錯網域計數。
properties.provisioningState	string	布建狀態，只會出現在回應中。
properties.proximityPlacementGroup	SubResource	指定虛擬機擴展集應指派給之鄰近放置群組的相關信息。 API 版本下限：2018-04-01。
properties.scaleInPolicy	ScaleInPolicy	指定相應縮小原則，決定在調整虛擬機擴展集時要移除的虛擬機。
properties.singlePlacementGroup	boolean	若為 true，則會將擴展集限制為單一放置群組，大小上限為 100 部虛擬機。
properties.uniqueId	string	指定可唯一識別虛擬機擴展集的標識碼。
properties.upgradePolicy	UpgradePolicy	升級原則。
properties.virtualMachineProfile	VirtualMachineScaleSetVMProfile	虛擬機器配置檔。
properties.zoneBalance	boolean	如果發生區域中斷，是否強制嚴格地跨 x 區域散發虛擬機。
sku	Sku	虛擬機擴展集 SKU。
tags	object	資源標籤
type	string	資源類型
zones	string[]	虛擬機擴展集區域。注意：只有在您建立擴展集時，才能設定可用性區域。

VirtualMachineScaleSetDataDisk

描述虛擬機擴展集數據磁碟。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值包括：無 ReadOnly 讀寫預設值：標準記憶體無。進階記憶體的 ReadOnly
createOption	DiskCreateOptionTypes	建立選項。
diskSizeGB	integer	指定以 GB 為單位的空白資料磁碟大小。此元素可用來覆寫虛擬機映像中的磁碟大小。此值不能大於 1023 GB
lun	integer	指定數據磁碟的邏輯單位編號。此值是用來識別 VM 內的數據磁碟，因此對於連結至 VM 的每個數據磁碟而言，都必須是唯一的。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	受控磁碟參數。
name	string	磁碟名稱。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

VirtualMachineScaleSetExtension

描述虛擬機擴展集擴充功能。

名稱	類型	Description
id	string	資源標識碼
name	string	延伸模組的名稱。
properties.autoUpgradeMinorVersion	boolean	指出擴充功能是否應該在部署期間使用較新的次要版本。不過，部署之後，除非重新部署延伸模組，否則延伸模組將不會升級次要版本，即使此屬性設定為 true 亦然。
properties.forceUpdateTag	string	如果提供值且與先前的值不同，即使延伸模組組態尚未變更，擴充處理程式仍會強制更新。
properties.protectedSettings	object	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或完全不包含受保護的設定。
properties.provisionAfterExtensions	string[]	延伸模組名稱的集合，之後必須布建此延伸模組。
properties.provisioningState	string	布建狀態，只會出現在回應中。
properties.publisher	string	擴充處理程序發行者的名稱。
properties.settings	object	延伸模組的 Json 格式化公用設定。
properties.type	string	指定延伸模組的類型;例如“CustomScriptExtension”。
properties.typeHandlerVersion	string	指定文稿處理程式的版本。

VirtualMachineScaleSetExtensionProfile

描述虛擬機擴展集擴充配置檔。

名稱	類型	Description
extensions	VirtualMachineScaleSetExtension[]	虛擬機擴展集子擴充功能資源。

VirtualMachineScaleSetIdentity

虛擬機擴展集的身分識別。

名稱	類型	Description
principalId	string	虛擬機擴展集身分識別的主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	與虛擬機擴展集相關聯的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於虛擬機擴展集的身分識別類型。「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別，和一組使用者指派的身分識別。類型『None』將會從虛擬機擴展集移除任何身分識別。
userAssignedIdentities	UserAssignedIdentities	與虛擬機擴展集相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

VirtualMachineScaleSetIPConfiguration

描述虛擬機擴展集網路配置檔的IP組態。

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

VirtualMachineScaleSetIpTag

包含與公用IP位址相關聯的IP標記。

名稱	類型	Description
ipTagType	string	IP 標籤類型。範例：FirstPartyUsage。
tag	string	與公用IP相關聯的IP標籤。範例：SQL、記憶體等。

VirtualMachineScaleSetManagedDiskParameters

描述 ScaleSet 受控磁碟的參數。

名稱	類型	Description
storageAccountType	StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。只有在建立擴展集時，才能設定受控 OS 磁碟記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，它不能與OS磁碟搭配使用。

VirtualMachineScaleSetNetworkConfiguration

描述虛擬機擴展集網路配置檔的網路組態。

名稱	類型	Description
id	string	資源標識碼
name	string	網路組態名稱。
properties.dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	要套用在網路介面上的 DNS 設定。
properties.enableAcceleratedNetworking	boolean	指定網路介面是否已啟用加速網路功能。
properties.enableIPForwarding	boolean	是否在此 NIC 上啟用 IP 轉送。
properties.ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	指定網路介面的IP組態。
properties.networkSecurityGroup	SubResource	網路安全組。
properties.primary	boolean	指定虛擬機有1個以上的網路介面時的主要網路介面。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

描述虛擬機擴展集網路設定的 DNS 設定。

名稱	類型	Description
dnsServers	string[]	DNS 伺服器 IP 位址清單

VirtualMachineScaleSetNetworkProfile

描述虛擬機擴展集網路配置檔。

名稱	類型	Description
healthProbe	ApiEntityReference	負載平衡器探查的參考，用來判斷虛擬機擴展集中實例的健康情況。參考的格式為：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'。
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	網路組態的清單。

VirtualMachineScaleSetOSDisk

描述虛擬機擴展集作業系統磁碟。

名稱	類型	Description
caching	CachingTypes	指定快取需求。可能的值包括：無 ReadOnly 讀寫預設值：標準記憶體無。進階記憶體的 ReadOnly
createOption	DiskCreateOptionTypes	指定應該如何建立擴展集中的虛擬機。唯一允許的值是： FromImage \u2013 當您使用映像來建立虛擬機時，會使用此值。如果您使用平臺映像，則也會使用上述的 imageReference 元素。如果您使用市集映射，您也會使用先前所述的 plan 元素。
diffDiskSettings	DiffDiskSettings	指定虛擬機擴展集所使用作業系統磁碟的暫時磁碟設定。
diskSizeGB	integer	指定以 GB 為單位的作業系統磁碟大小。此元素可用來覆寫虛擬機映像中的磁碟大小。此值不能大於 1023 GB
image	VirtualHardDisk	指定要根據擴展集的 Unmanaged 使用者映像相關信息。
managedDisk	VirtualMachineScaleSetManagedDiskParameters	受控磁碟參數。
name	string	磁碟名稱。
osType	OperatingSystemTypes	此屬性可讓您指定從使用者映像或特製化 VHD 建立 VM 時，磁碟包含的 OS 類型。可能的值包括： Windows Linux
vhdContainers	string[]	指定用來儲存擴展集作業系統磁碟的容器 URL。
writeAcceleratorEnabled	boolean	指定是否應該在磁碟上啟用或停用 writeAccelerator。

VirtualMachineScaleSetOSProfile

描述虛擬機擴展集 OS 配置檔。

名稱	類型	Description
adminPassword	string	指定系統管理員帳戶的密碼。 Windows) 長度下限 (： 8 個字元 Linux) 長度下限 (： 6 個字元 Windows) 長度上限 (： 123 個字元 Linux) 長度上限 (： 72 個字元複雜度需求：下列 4 個條件中需要滿足 3 個條件字元較低具有大字元具有數位具有特殊字元 (Regex 比對 [\W_]) 不允許的值： “abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password！”、“Password1”、“Password22”、“P@ssword123”、“pa$$word”、“Password！”、“Password1”、“Password22”、“P@ssword123！” 如需重設密碼，請參閱如何在 Windows VM 中重設遠端桌面服務或其登入密碼如需重設根密碼，請參閱使用 VMAccess 擴充功能管理使用者、SSH 及檢查或修復 Azure Linux VM 上的磁碟
adminUsername	string	指定系統管理員帳戶的名稱。僅限 Windows 的限制：無法結束於 “.” 不允許的值： “administrator”、“admin”、“user”、“user1”、“test”、“user2”、“test1”、“user3”、“admin1”、“1”、 “123”、“a”、“actuser”、“adm”、“admin2”、“aspnet”、“backup”、“console”、“david”、“guest”、“john”、“owner”、“root”、“server”、“sql”、“support”、“support_388945a0”、“sys”、“test2”、“test3”、“user4”、“user5”。 Linux) 長度下限 (： 1 個字元 Linux) 長度上限 (： 64 個字元 Windows) 長度上限 (： 20 個字元如需 Linux VM 的根存取權，請參閱在 Azure 中的 Linux 虛擬機上使用根許可權如需 Linux 上不應該用於此欄位的內建系統使用者清單，請參閱在 Azure 上選取 Linux 的用戶名稱
computerNamePrefix	string	指定擴展集中所有虛擬機的計算機名稱前置詞。計算機名稱前置詞長度必須為1到15個字元。
customData	string	指定自訂資料的 Base-64 編碼字串。 Base-64 編碼字串會解碼成二進位陣列而儲存為虛擬機器上的檔案。二進位陣列的長度上限是 65535 個位元組。如需針對 VM 使用 cloud-init，請參閱在建立期間使用 cloud-init 自定義 Linux VM
linuxConfiguration	LinuxConfiguration	指定虛擬機上的Linux作業系統設定。如需支援的Linux發行版清單，請參閱 linux on Azure-Endorsed Distributions 如需執行非背書散發套件，請參閱非背書散發套件的資訊。
secrets	VaultSecretGroup[]	指定應該安裝在擴展集中虛擬機上的憑證集。
windowsConfiguration	WindowsConfiguration	指定虛擬機器上的 Windows 作業系統設定。

VirtualMachineScaleSetPublicIPAddressConfiguration

描述虛擬機擴展集IP組態的PublicIPAddress設定

名稱	類型	Description
name	string	publicIP 位址組態名稱。
properties.dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	要套用至 publicIP 位址的 DNS 設定。
properties.idleTimeoutInMinutes	integer	公用IP位址的閒置逾時。
properties.ipTags	VirtualMachineScaleSetIpTag[]	與公用IP位址相關聯的IP標籤清單。
properties.publicIPPrefix	SubResource	要從中配置 publicIP 位址的 PublicIPPrefix。

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings