This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Availability Zones

This section explains how to get a list with Azure availability zones.

Request

GET https://<hostname>/api/v1/cloudInfrastructure/availabilityZones

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

None.

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 HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property

Type

Description

offset

integer

Shows the offset value.

limit

integer

Shows the offset limit.

totalCount

integer

Shows the number of records in the results array.

results

Results Object

Contains the result object.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Results Object

Property

Type

Description

subscriptionId

string

Shows the identification number of the Azure subscription to which the availability zone belongs.

regionId

string

Shows the identification number of the Azure region to which the availability zone belongs.

name

string

Shows the name of the Azure availability zone.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/availabilityZones

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "offset": 0,

  "limit": 30,

  "totalCount": 66,

  "results":    [

           {

        "subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

        "regionId": "centralus",

        "name": "1",

        "_links": {"subscription": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"}}

     },

           {

        "subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

        "regionId": "centralus",

        "name": "2",

        "_links": {"subscription": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"}}

     },

           {

        "subscriptionId": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

        "regionId": "centralus",

        "name": "3",

        "_links": {"subscription": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"}}

     }

  ],

  "_links":    {

     "self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/availabilityZones?offset=0&limit=30"},

     "next": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/availabilityZones?offset=30&limit=30"}

  }

}

I want to report a typo

There is a misspelling right here:

 

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