Region - List By Service

  • Reference
Service:
API Management
API Version:
2024-05-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=2024-05-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

RegionListResult

Lists of Regions in which the service is deployed.
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementListRegions

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/regions?api-version=2024-05-01

Sample response

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

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
RegionContract

Region profile.
RegionListResult

Lists Regions operation response details.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

RegionContract

Region profile.

Name Type Description
isDeleted

boolean

whether Region is deleted.
isMasterRegion

boolean

whether Region is the master region.
name

string

Region name.

RegionListResult

Lists Regions operation response details.

Name Type Description
count

integer

Total record count number across all pages.
nextLink

string

Next page link if any.
value

RegionContract[]

Lists of Regions.