Availability Sets - List
列出資源群組中的所有可用性設定組。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets?api-version=2025-04-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
資源群組的名稱。 名稱不區分大小寫。 |
|
subscription
|
path | True |
string minLength: 1 |
目標訂用帳戶的標識碼。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
要求已成功。 |
|
| Other Status Codes |
未預期的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
|
Availability |
|
Availability |
AvailabilitySet_List_MaximumSet_Gen
範例要求
範例回覆
{
"value": [
{
"name": "{availabilitySetName}",
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
"type": "Microsoft.Compute/availabilitySets",
"location": "australiasoutheast",
"properties": {
"platformUpdateDomainCount": 5,
"platformFaultDomainCount": 3,
"virtualMachines": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}"
}
],
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaa",
"message": "aaaaaa",
"time": "2021-11-30T13:39:56.427Z"
}
]
},
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaaaaaaaaaaa",
"capacity": 22
},
"tags": {
"key2039": "aaaaaaaaaaaaa"
}
},
{
"name": "{availabilitySetName}",
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
"type": "Microsoft.Compute/availabilitySets",
"location": "australiasoutheast",
"properties": {
"platformUpdateDomainCount": 5,
"platformFaultDomainCount": 3,
"virtualMachines": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}"
}
],
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaa",
"message": "aaaaaa",
"time": "2021-11-30T13:39:56.427Z"
}
]
},
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"capacity": 23
},
"tags": {
"key5849": "aaaaaaaaaaaaaaa"
}
},
{
"name": "{availabilitySetName}",
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
"type": "Microsoft.Compute/availabilitySets",
"location": "westcentralus",
"tags": {},
"properties": {
"platformUpdateDomainCount": 5,
"platformFaultDomainCount": 3,
"virtualMachines": [],
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaa",
"message": "aaaaaa",
"time": "2021-11-30T13:39:56.427Z"
}
]
},
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaaaaaaaaa",
"capacity": 26
}
},
{
"name": "{availabilitySetName}",
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
"type": "Microsoft.Compute/availabilitySets",
"location": "westcentralus",
"tags": {},
"properties": {
"platformUpdateDomainCount": 5,
"platformFaultDomainCount": 3,
"virtualMachines": [],
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"statuses": [
{
"code": "aaaaaaaaaaaaaaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaa",
"message": "aaaaaa",
"time": "2021-11-30T13:39:56.427Z"
}
]
},
"sku": {
"name": "Classic",
"tier": "aaaaaaaaaaaaaaaaaa",
"capacity": 6
}
}
],
"nextLink": "a://example.com/aaaaa"
}
AvailabilitySet_List_MinimumSet_Gen
範例要求
範例回覆
{
"value": [
{
"location": "australiasoutheast",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet1"
},
{
"location": "australiasoutheast",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet2"
},
{
"location": "westcentralus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet3"
},
{
"location": "westcentralus",
"id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet4"
}
]
}
定義
| 名稱 | Description |
|---|---|
|
All |
指定當所有執行個體關閉時,是否應自動核准排程事件。 |
|
Api |
Api 錯誤。 |
|
Api |
Api 錯誤基底。 |
|
Availability |
指定虛擬機應指派之可用性設定組的相關信息。 在相同可用性設定組中指定的虛擬機被配置到不同的節點,以最大化可用性。 如需可用性設定組的詳細資訊,請參閱 可用性設定組概觀。 如需 Azure 計劃性維護的詳細資訊,請參閱 Azure中虛擬機的維護和更新。 目前,VM 只能在建立時新增至可用性設定組。 現有的 VM 無法新增至可用性設定組。 |
|
Availability |
清單可用性設定組作業回應。 |
|
Cloud |
來自計算服務的錯誤回應。 |
|
created |
建立資源的身分識別類型。 |
|
Default |
指出透過 ConvertToVirtualMachineScaleSet API 觸發順暢移轉而不停機 VM 時的目標虛擬機器 ScaleSet 屬性。 |
|
Event |
指定 eventGridAndResourceGraph 相關的排程事件相關組態。 |
|
Inner |
內部錯誤詳細數據。 |
|
Instance |
實例檢視狀態。 |
|
Scheduled |
|
|
Scheduled |
指定 Redeploy、Reboot 和 ScheduledEventsAdditionalPublishingTargets 排程事件相關組態。 |
| Sku |
描述虛擬機器擴展集 SKU。 注意:如果擴展集目前所在的硬體上不支援新的 VM SKU,您必須先解除分配擴展集中的 VM,才能修改 SKU 名稱。 |
|
Status |
層級程序代碼。 |
|
Sub |
|
|
system |
與建立和上次修改資源相關的元數據。 |
|
User |
指定與「重新開機」相關的「排程事件」相關組態。 |
|
User |
指定與「重新部署」相關的「排程事件」相關組態。 |
|
Virtual |
描述與移轉至彈性虛擬機器擴展集相關的可用性設定組屬性。 |
AllInstancesDown
指定當所有執行個體關閉時,是否應自動核准排程事件。
| 名稱 | 類型 | Description |
|---|---|---|
| automaticallyApprove |
boolean |
指定當所有執行個體關閉時,是否應自動核准排程事件。 其預設值為 true |
ApiError
Api 錯誤。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
錯誤碼。 |
| details |
Api 錯誤詳細資料 |
|
| innererror |
Api 內部錯誤 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
特定錯誤的目標。 |
ApiErrorBase
Api 錯誤基底。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
錯誤碼。 |
| message |
string |
錯誤訊息。 |
| target |
string |
特定錯誤的目標。 |
AvailabilitySet
指定虛擬機應指派之可用性設定組的相關信息。 在相同可用性設定組中指定的虛擬機被配置到不同的節點,以最大化可用性。 如需可用性設定組的詳細資訊,請參閱 可用性設定組概觀。 如需 Azure 計劃性維護的詳細資訊,請參閱 Azure中虛擬機的維護和更新。 目前,VM 只能在建立時新增至可用性設定組。 現有的 VM 無法新增至可用性設定組。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location |
string |
資源所在的地理位置 |
| name |
string |
資源的名稱 |
| properties.platformFaultDomainCount |
integer (int32) |
容錯網域計數。 |
| properties.platformUpdateDomainCount |
integer (int32) |
更新網域計數。 |
| properties.proximityPlacementGroup |
指定可用性設定組應指派給之鄰近放置群組的相關信息。 API 版本下限:2018-04-01。 |
|
| properties.scheduledEventsPolicy |
指定可用性設定組的重新部署、重新啟動和 ScheduledEventsAdditionalPublishingTargets Scheduled 事件相關組態。 |
|
| properties.statuses |
資源狀態資訊。 |
|
| properties.virtualMachineScaleSetMigrationInfo |
描述可用性設定組上的移轉屬性。 |
|
| properties.virtualMachines |
可用性設定組中所有虛擬機的參考清單。 |
|
| sku |
可用性設定組的 SKU,只需要設定名稱。 如需可能的值集,請參閱 AvailabilitySetSkuTypes。 針對具有受控磁碟的虛擬機使用「對齊」,針對具有非受控磁碟的虛擬機使用「傳統」。 預設值為 『Classic』。 |
|
| systemData |
包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 中繼資料。 |
|
| tags |
object |
資源標籤。 |
| type |
string |
資源的類型。 例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」 |
AvailabilitySetListResult
清單可用性設定組作業回應。
| 名稱 | 類型 | Description |
|---|---|---|
| nextLink |
string (uri) |
擷取下一頁 AvailabilitySets 的 URI。 使用此 URI 呼叫 ListNext() 以擷取 AvailabilitySet 的下一頁。 |
| value |
可用性設定組清單。 |
CloudError
來自計算服務的錯誤回應。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
Api 錯誤。 |
createdByType
建立資源的身分識別類型。
| 值 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DefaultVirtualMachineScaleSetInfo
指出透過 ConvertToVirtualMachineScaleSet API 觸發順暢移轉而不停機 VM 時的目標虛擬機器 ScaleSet 屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| constrainedMaximumCapacity |
boolean |
指出移轉之後預設移轉虛擬機器擴展集的最大容量是否會限制為有限數目的 VM。 |
| defaultVirtualMachineScaleSet |
透過 ConvertToVirtualMachineScaleSet API 觸發順暢移轉時,可用性設定組將會移至的預設虛擬機器 ScaleSet URI。 |
EventGridAndResourceGraph
指定 eventGridAndResourceGraph 相關的排程事件相關組態。
| 名稱 | 類型 | Description |
|---|---|---|
| enable |
boolean |
指定已排程事件相關組態的事件方格和資源圖表是否已啟用。 |
| scheduledEventsApiVersion |
string |
指定 api-version 以決定將傳遞的排程事件組態結構描述版本。 |
InnerError
內部錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| errordetail |
string |
內部錯誤訊息或異常狀況傾出。 |
| exceptiontype |
string |
例外狀況類型。 |
InstanceViewStatus
實例檢視狀態。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
狀態代碼。 |
| displayStatus |
string |
狀態的簡短可當地語系化標籤。 |
| level |
層級程序代碼。 |
|
| message |
string |
詳細的狀態消息,包括警示和錯誤訊息。 |
| time |
string (date-time) |
狀態的時間。 |
ScheduledEventsAdditionalPublishingTargets
| 名稱 | 類型 | Description |
|---|---|---|
| eventGridAndResourceGraph |
建立 eventGridAndResourceGraph Scheduled Event 設定時所使用的組態參數。 |
ScheduledEventsPolicy
指定 Redeploy、Reboot 和 ScheduledEventsAdditionalPublishingTargets 排程事件相關組態。
| 名稱 | 類型 | Description |
|---|---|---|
| allInstancesDown |
建立 AllInstancesDown 排程事件設定建立時使用的組態參數。 |
|
| scheduledEventsAdditionalPublishingTargets |
發佈 scheduledEventsAdditionalPublishingTargets 時所使用的組態參數。 |
|
| userInitiatedReboot |
建立 userInitiatedReboot 排程事件設定建立時所使用的組態參數。 |
|
| userInitiatedRedeploy |
建立 userInitiatedRedeploy 排程事件設定建立時所使用的組態參數。 |
Sku
描述虛擬機器擴展集 SKU。 注意:如果擴展集目前所在的硬體上不支援新的 VM SKU,您必須先解除分配擴展集中的 VM,才能修改 SKU 名稱。
| 名稱 | 類型 | Description |
|---|---|---|
| capacity |
integer (int64) |
指定擴展集中的虛擬機數目。 |
| name |
string |
SKU 名稱。 |
| tier |
string |
指定擴展集中虛擬機的層級。 |
StatusLevelTypes
層級程序代碼。
| 值 | Description |
|---|---|
| Info | |
| Warning | |
| Error |
SubResource
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
資源標識碼 |
systemData
與建立和上次修改資源相關的元數據。
| 名稱 | 類型 | Description |
|---|---|---|
| createdAt |
string (date-time) |
資源建立的時間戳(UTC)。 |
| createdBy |
string |
建立資源的身分識別。 |
| createdByType |
建立資源的身分識別類型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的資源時間戳 (UTC) |
| lastModifiedBy |
string |
上次修改資源的身分識別。 |
| lastModifiedByType |
上次修改資源的身分識別類型。 |
UserInitiatedReboot
指定與「重新開機」相關的「排程事件」相關組態。
| 名稱 | 類型 | Description |
|---|---|---|
| automaticallyApprove |
boolean |
指定重新啟動排程的事件相關組態。 |
UserInitiatedRedeploy
指定與「重新部署」相關的「排程事件」相關組態。
| 名稱 | 類型 | Description |
|---|---|---|
| automaticallyApprove |
boolean |
指定重新部署排程的事件相關組態。 |
VirtualMachineScaleSetMigrationInfo
描述與移轉至彈性虛擬機器擴展集相關的可用性設定組屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| defaultVirtualMachineScaleSetInfo |
指出透過 ConvertToVirtualMachineScaleSet API 觸發順暢移轉而不停機 VM 時的目標虛擬機器 ScaleSet 屬性。 |
|
| migrateToVirtualMachineScaleSet |
指定可用性設定組移轉至的虛擬機器擴展集。 |