Geographic Hierarchies - Get Default

Gets the default Geographic Hierarchy used by the Geographic traffic routing method.

GET https://management.azure.com/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default?api-version=2018-04-01

URI Parameters

Name In Required Type Description
api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

The default Geographic Hierarchy.

Other Status Codes

Default response. It will be deserialized as per the Error definition.

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

GeographicHierarchy-GET-default

Sample Request

GET https://management.azure.com/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default?api-version=2018-04-01

Sample Response

{
  "id": "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerGeographicHierarchies",
  "properties": {
    "geographicHierarchy": {
      "code": "WORLD",
      "name": "World",
      "regions": [
        {
          "code": "GEO-ME",
          "name": "Middle East",
          "regions": [
            {
              "code": "AE",
              "name": "United Arab Emirates",
              "regions": []
            }
          ]
        },
        {
          "code": "GEO-AP",
          "name": "Australia / Pacific",
          "regions": [
            {
              "code": "AU",
              "name": "Australia",
              "regions": [
                {
                  "code": "AU-ACT",
                  "name": "Australian Capital Territory",
                  "regions": []
                },
                {
                  "code": "AU-NSW",
                  "name": "New South Wales",
                  "regions": []
                }
              ]
            },
            {
              "code": "CK",
              "name": "Cook Islands",
              "regions": []
            }
          ]
        }
      ]
    }
  }
}

Definitions

CloudError

An error returned by the Azure Resource Manager

CloudErrorBody

The content of an error returned by the Azure Resource Manager

Region

Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method.

TrafficManagerGeographicHierarchy

Class representing the Geographic hierarchy used with the Geographic traffic routing method.

CloudError

An error returned by the Azure Resource Manager

Name Type Description
error

The content of the error.

CloudErrorBody

The content of an error returned by the Azure Resource Manager

Name Type Description
code
  • string

Error code

details

Error details

message
  • string

Error message

target
  • string

Error target

Region

Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method.

Name Type Description
code
  • string

The code of the region

name
  • string

The name of the region

regions

The list of Regions grouped under this Region in the Geographic Hierarchy.

TrafficManagerGeographicHierarchy

Class representing the Geographic hierarchy used with the Geographic traffic routing method.

Name Type Description
id
  • string

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name
  • string

The name of the resource

properties.geographicHierarchy

The region at the root of the hierarchy from all the regions in the hierarchy can be retrieved.

type
  • string

The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.