Get Availability Sets

You can get a list of all availability sets configured in the Microsoft Azure environment.

Request

To retrieve a representation of a collection of availability sets, send the HTTP GET request to the /cloudInfrastructure/availabilitySets endpoint.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/availabilitySets

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, Filter and the following query parameters:

Query Parameter

Value

Description

SubscriptionId

string

Returns only availability sets assigned to the specified subscription. For more information, see Filter Parameters.

RegionId

string

Returns only availability sets that belong to the Azure region with the specified ID. For more information, see Filter Parameters.

VmSizeName

string

Returns only availability sets that support Azure VM with the specified size. For more information, see Filter Parameters.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns the list of availability sets.

Query Parameter

Value

Description

id

string

Azure ID assigned to an availability set.

name

string

Name of the availability set.

regionName

string

Name of the Azure region where the availability set belongs.

Get Availability SetsExample

The following request returns the list of all availability sets.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/availabilitySets

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 

"offset": 0,

"limit": 200,

"totalCount": 1,

"results": [

  {

    "id": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/default/providers/microsoft.compute/availabilitysets/ad-availabilityset",

    "name": "AD-AvailabilitySet",

    "regionName": "southindia"

  }

],

 

"_links": {

  "self": {

    "href": "https://51.11.247.127/api/v2/cloudInfrastructure/availabilitySets?offset=0&limit=200&expand=None"

 

  }

}

 

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.