This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Regions by Backup Policy ID
This section explains how to get a list of regions that are added to the specified backup policy processing list.
Request
GET https://<hostname>/api/v1/policies/{policyId}/regions |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Description |
policyId | The identification numbers of the backup policy. Can be obtained as described in Getting Backup Policies. |
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 | integer | Shows the identification number of the region. |
name | string | Shows the name region. |
_embeddedResources | Contains the result object. |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the Azure subscription. |
environment | string | Shows the Azure environment. |
tenantId | string | Shows the identification number of the tenant. |
name | string | Shows the name of the Azure subscription. |
status | string | Shows the status of the Azure subscription. |
_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/policies/d4ec0e97-8ce4-455c-a699-c1b3635886ae/regions
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "totalCount": 3, "results": [ { "id": "northeurope", "name": "North Europe", "_embeddedResources": {"subscriptions": [ { "id": "3a9a8330-7bbc-4b03-9c68-15d674fbc809", "environment": "Global", "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "name": "Visual Studio Premium MSDN", "status": "Active", "_links": {} }]} }, { "id": "ukwest", "name": "UK West", "_embeddedResources": {"subscriptions": [ { "id": "3a9a8330-7bbc-4b03-9c68-15d674fbc809", "environment": "Global", "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "name": "Visual Studio Premium MSDN", "status": "Active", "_links": {} }]} }, { "id": "westeurope", "name": "West Europe", "_embeddedResources": {"subscriptions": [ { "id": "3a9a8330-7bbc-4b03-9c68-15d674fbc809", "environment": "Global", "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "name": "Visual Studio Premium MSDN", "status": "Active", "_links": {} }]} } ], "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/policies/d4ec0e97-8ce4-455c-a699-c1b3635886ae/regions?offset=0&limit=30"}} } |