Availability Sets - List
Lists all availability sets in a resource group.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets?api-version=2023-03-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Availability |
Availability |
AvailabilitySet_List_MaximumSet_Gen
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets?api-version=2023-03-01
Sample Response
{
"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": "aaaaa"
}
AvailabilitySet_List_MinimumSet_Gen
Sample Request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets?api-version=2023-03-01
Sample Response
{
"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"
}
]
}
Definitions
Name | Description |
---|---|
Api |
Api error. |
Api |
Api error base. |
Availability |
Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set. |
Availability |
The List Availability Set operation response. |
Cloud |
An error response from the Compute service. |
Inner |
Inner error details. |
Instance |
Instance view status. |
Sku |
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name. |
Status |
The level code. |
Sub |
ApiError
Api error.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
details |
The Api error details |
|
innererror |
The Api inner error |
|
message |
string |
The error message. |
target |
string |
The target of the particular error. |
ApiErrorBase
Api error base.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
message |
string |
The error message. |
target |
string |
The target of the particular error. |
AvailabilitySet
Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |
location |
string |
Resource location |
name |
string |
Resource name |
properties.platformFaultDomainCount |
integer |
Fault Domain count. |
properties.platformUpdateDomainCount |
integer |
Update Domain count. |
properties.proximityPlacementGroup |
Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01. |
|
properties.statuses |
The resource status information. |
|
properties.virtualMachines |
A list of references to all virtual machines in the availability set. |
|
sku |
Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'. |
|
tags |
object |
Resource tags |
type |
string |
Resource type |
AvailabilitySetListResult
The List Availability Set operation response.
Name | Type | Description |
---|---|---|
nextLink |
string |
The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets. |
value |
The list of availability sets |
CloudError
An error response from the Compute service.
Name | Type | Description |
---|---|---|
error |
Api error. |
InnerError
Inner error details.
Name | Type | Description |
---|---|---|
errordetail |
string |
The internal error message or exception dump. |
exceptiontype |
string |
The exception type. |
InstanceViewStatus
Instance view status.
Name | Type | Description |
---|---|---|
code |
string |
The status code. |
displayStatus |
string |
The short localizable label for the status. |
level |
The level code. |
|
message |
string |
The detailed status message, including for alerts and error messages. |
time |
string |
The time of the status. |
Sku
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
Name | Type | Description |
---|---|---|
capacity |
integer |
Specifies the number of virtual machines in the scale set. |
name |
string |
The sku name. |
tier |
string |
Specifies the tier of virtual machines in a scale set. |
StatusLevelTypes
The level code.
Name | Type | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
SubResource
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |