Regions

Service:
API Management
API Version:
2017-03-01

Lists all azure regions in which the service exists.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions&api-version={api-version}
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions?$skip={$skip}&$top={$top}&api-version={api-version}

URI Parameters

Name In Required Type Description
policyId
 path True
  • string
The identifier of the Policy.
subscriptionId
 path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
resourceGroupName
 path True
  • string

The name of the resource group.
serviceName
 path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
$skip
 query
  • integer
    int32
Number of records to skip.
$top
 query
  • integer
    int32
Number of records to return.
api-version
 query True
  • string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

Lists of Regions in which the service is deployed.

Examples

ApiManagementListRegions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/regions&api-version=2017-03-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "name": "West US",
      "isMasterRegion": true,
      "isDeleted": false
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

RegionContract

Region profile.
RegionListResult

Region profile.

Name Type Description
isDeleted
  • boolean

whether Region is deleted.
isMasterRegion
  • boolean

whether Region is the master region.
name
  • string

Region name.
Name Type Description
count
  • integer
    int64

Total record count number across all pages.
nextLink
  • string

Next page link if any.
value

Lists of Regions.