Virtual Machine Scale Sets - List

參考

服務:: Compute

API 版本:: 2018-10-01

取得資源群組下所有 VM 擴展集的清單。

HTTP

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

URI 參數

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

回應

名稱	類型	Description
200 OK	VirtualMachineScaleSetListResult	確定

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

範圍

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

定義

名稱	Description
AdditionalCapabilities	啟用或停用虛擬機或虛擬機擴展集上的功能。
AdditionalUnattendContent	指定其他 XML 格式資訊，這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.xml 檔案中。內容是藉由設定名稱、元件名稱和套用內容的傳遞來定義。
ApiEntityReference	API 實體參考。
AutomaticOSUpgradePolicy	用於執行自動OS升級的組態參數。
AutomaticRepairsPolicy	指定虛擬機擴展集上自動修復的組態參數。
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	執行滾動升級時所使用的組態參數。
SettingNames	指定要套用內容之設定的名稱。可能的值為：FirstLogonCommands 和 AutoLogon。
Sku	描述虛擬機擴展集 SKU。注意：如果擴展集目前所在的硬體上不支援新的 VM SKU，您必須先解除分配擴展集中的 VM，才能修改 SKU 名稱。
SshConfiguration	在 Azure 上執行的 Linux 型 VM SSH 設定
SshPublicKey	包含 SSH 憑證公鑰的相關信息，以及放置公鑰之 Linux VM 上的路徑。
StorageAccountTypes	指定受控磁碟的記憶體帳戶類型。注意：UltraSSD_LRS只能與數據磁碟搭配使用，它不能與OS磁碟搭配使用。
SubResource
UpgradeMode	指定升級至擴展集中虛擬機的模式。可能的值包括：手動 - 您可以控制擴充集中虛擬機更新的應用程式。您可以使用 manualUpgrade 動作來執行此動作。自動 -擴展集中的所有虛擬機都會同時自動更新。
UpgradePolicy	描述升級原則 - 自動、手動或滾動。
UserAssignedIdentities	與虛擬機相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
VaultCertificate	描述金鑰保存庫中的單一憑證參考，以及憑證應該位於 VM 上的位置。
VaultSecretGroup	描述一組相同金鑰保存庫的憑證。
VirtualHardDisk	描述磁碟的 URI。
VirtualMachineEvictionPolicyTypes	指定低優先順序擴展集中虛擬機的收回原則。最低 API 版本：2017-10-30-preview
VirtualMachinePriorityTypes	指定擴展集中虛擬機的優先順序。最低 API 版本：2017-10-30-preview
VirtualMachineScaleSet	描述虛擬機擴展集。
VirtualMachineScaleSetDataDisk	描述虛擬機擴展集數據磁碟。
VirtualMachineScaleSetExtension	描述虛擬機擴展集擴充功能。
VirtualMachineScaleSetExtensionProfile	描述虛擬機擴展集擴充功能配置檔。
VirtualMachineScaleSetIdentity	虛擬機擴展集的身分識別。
VirtualMachineScaleSetIPConfiguration	描述虛擬機擴展集網路配置檔的IP組態。
VirtualMachineScaleSetIpTag	包含與公用IP位址相關聯的IP標記。
VirtualMachineScaleSetListResult	列出虛擬機作業回應。
VirtualMachineScaleSetManagedDiskParameters	描述 ScaleSet 受控磁碟的參數。
VirtualMachineScaleSetNetworkConfiguration	描述虛擬機擴展集網路配置檔的網路組態。
VirtualMachineScaleSetNetworkConfigurationDnsSettings	描述虛擬機擴展集網路設定的 DNS 設定。
VirtualMachineScaleSetNetworkProfile	描述虛擬機擴展集網路配置檔。
VirtualMachineScaleSetOSDisk	描述虛擬機擴展集作業系統磁碟。
VirtualMachineScaleSetOSProfile	描述虛擬機擴展集 OS 配置檔。
VirtualMachineScaleSetPublicIPAddressConfiguration	描述虛擬機擴展集IP組態的PublicIPAddress設定
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	描述虛擬機擴展集網路設定的 DNS 設定。
VirtualMachineScaleSetStorageProfile	描述虛擬機擴展集記憶體配置檔。
VirtualMachineScaleSetVMProfile	描述虛擬機擴展集虛擬機配置檔。
WindowsConfiguration	指定虛擬機器上的 Windows 作業系統設定。
WinRMConfiguration	描述 VM 的 Windows 遠端管理設定
WinRMListener	描述 Windows 遠端管理接聽程式的通訊協議和指紋

AdditionalCapabilities

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

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

AdditionalUnattendContent

指定其他 XML 格式資訊，這些資訊可以包含在 Windows 安裝程式所使用的 Unattend.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映像可用時，是否應該以滾動方式自動套用OS升級至擴展集實例。預設值為 False。如果 Windows 擴展集將此設定為 true，建議將 enableAutomaticUpdates 設定為 false。

AutomaticRepairsPolicy

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

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

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

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	資源標識碼

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

指定低優先順序擴展集中虛擬機的收回原則。

最低 API 版本：2017-10-30-preview

名稱	類型	Description
Deallocate	string
Delete	string

VirtualMachinePriorityTypes

指定擴展集中虛擬機的優先順序。

最低 API 版本：2017-10-30-preview

名稱	類型	Description
Low	string
Regular	string