This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Regions
This section explains how to get a list of Azure regions.
Request
GET https://<hostname>/api/v1/cloudInfrastructure/regions |
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 | Contains the result object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the Azure region. |
name | string | Shows the name of the region. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/regions
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "totalCount": 38, "results": [ { "id": "australiaeast", "name": "Australia East" }, { "id": "australiasoutheast", "name": "Australia Southeast" }, { "id": "brazilsouth", "name": "Brazil South" }, { "id": "canadacentral", "name": "Canada Central" }, { "id": "canadaeast", "name": "Canada East" }, { "id": "centralindia", "name": "Central India" }, { "id": "centralus", "name": "Central US" }, { "id": "eastasia", "name": "East Asia" }, { "id": "eastus", "name": "East US" }, { "id": "eastus2", "name": "East US 2" }, { "id": "francecentral", "name": "France Central" }, { "id": "francesouth", "name": "France South" }, { "id": "germanynorth", "name": "Germany North" }, { "id": "germanywestcentral", "name": "Germany West Central" }, { "id": "japaneast", "name": "Japan East" }, { "id": "japanwest", "name": "Japan West" }, { "id": "koreacentral", "name": "Korea Central" }, { "id": "koreasouth", "name": "Korea South" }, { "id": "northcentralus", "name": "North Central US" }, { "id": "northeurope", "name": "North Europe" }, { "id": "norwayeast", "name": "Norway East" }, { "id": "norwaywest", "name": "Norway West" }, { "id": "southafricanorth", "name": "South Africa North" }, { "id": "southafricawest", "name": "South Africa West" }, { "id": "southcentralus", "name": "South Central US" }, { "id": "southindia", "name": "South India" }, { "id": "southeastasia", "name": "Southeast Asia" }, { "id": "switzerlandnorth", "name": "Switzerland North" }, { "id": "switzerlandwest", "name": "Switzerland West" }, { "id": "uaecentral", "name": "UAE Central" } ], "_links": { "self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/regions?offset=0&limit=30"}, "next": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/regions?offset=30&limit=30"} } } |