Geographic Hierarchies - Get Default

Service:

Traffic Manager

API Version:

2022-04-01

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

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

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	TrafficManagerGeographicHierarchy	The default Geographic Hierarchy.
Other Status Codes	CloudError	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

HTTP

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

Java

/** Samples for GeographicHierarchies GetDefault. */
public final class Main {
    /*
     * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/GeographicHierarchy-GET-default.json
     */
    /**
     * Sample code: GeographicHierarchy-GET-default.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void geographicHierarchyGETDefault(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .trafficManagerProfiles()
            .manager()
            .serviceClient()
            .getGeographicHierarchies()
            .getDefaultWithResponse(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python geographic_hierarchy_getdefault.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = TrafficManagerManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.geographic_hierarchies.get_default()
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/GeographicHierarchy-GET-default.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armtrafficmanager_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/trafficmanager/armtrafficmanager"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0d41e635294dce73dfa99b07f3da4b68a9c9e29c/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/GeographicHierarchy-GET-default.json
func ExampleGeographicHierarchiesClient_GetDefault() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtrafficmanager.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGeographicHierarchiesClient().GetDefault(ctx, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GeographicHierarchy = armtrafficmanager.GeographicHierarchy{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerGeographicHierarchies"),
	// 	ID: to.Ptr("/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default"),
	// 	Properties: &armtrafficmanager.GeographicHierarchyProperties{
	// 		GeographicHierarchy: &armtrafficmanager.Region{
	// 			Name: to.Ptr("World"),
	// 			Code: to.Ptr("WORLD"),
	// 			Regions: []*armtrafficmanager.Region{
	// 				{
	// 					Name: to.Ptr("Middle East"),
	// 					Code: to.Ptr("GEO-ME"),
	// 					Regions: []*armtrafficmanager.Region{
	// 						{
	// 							Name: to.Ptr("United Arab Emirates"),
	// 							Code: to.Ptr("AE"),
	// 							Regions: []*armtrafficmanager.Region{
	// 							},
	// 					}},
	// 				},
	// 				{
	// 					Name: to.Ptr("Australia / Pacific"),
	// 					Code: to.Ptr("GEO-AP"),
	// 					Regions: []*armtrafficmanager.Region{
	// 						{
	// 							Name: to.Ptr("Australia"),
	// 							Code: to.Ptr("AU"),
	// 							Regions: []*armtrafficmanager.Region{
	// 								{
	// 									Name: to.Ptr("Australian Capital Territory"),
	// 									Code: to.Ptr("AU-ACT"),
	// 									Regions: []*armtrafficmanager.Region{
	// 									},
	// 								},
	// 								{
	// 									Name: to.Ptr("New South Wales"),
	// 									Code: to.Ptr("AU-NSW"),
	// 									Regions: []*armtrafficmanager.Region{
	// 									},
	// 							}},
	// 						},
	// 						{
	// 							Name: to.Ptr("Cook Islands"),
	// 							Code: to.Ptr("CK"),
	// 							Regions: []*armtrafficmanager.Region{
	// 							},
	// 					}},
	// 			}},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the default Geographic Hierarchy used by the Geographic traffic routing method.
 *
 * @summary Gets the default Geographic Hierarchy used by the Geographic traffic routing method.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/GeographicHierarchy-GET-default.json
 */
async function geographicHierarchyGetDefault() {
  const subscriptionId =
    process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.geographicHierarchies.getDefault();
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.TrafficManager;

// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/GeographicHierarchy-GET-default.json
// this example is just showing the usage of "GeographicHierarchies_GetDefault" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TrafficManagerGeographicHierarchyResource created on azure
// for more information of creating TrafficManagerGeographicHierarchyResource, please refer to the document of TrafficManagerGeographicHierarchyResource
ResourceIdentifier trafficManagerGeographicHierarchyResourceId = TrafficManagerGeographicHierarchyResource.CreateResourceIdentifier();
TrafficManagerGeographicHierarchyResource trafficManagerGeographicHierarchy = client.GetTrafficManagerGeographicHierarchyResource(trafficManagerGeographicHierarchyResourceId);

// invoke the operation
TrafficManagerGeographicHierarchyResource result = await trafficManagerGeographicHierarchy.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
TrafficManagerGeographicHierarchyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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

Name	Description
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	CloudErrorBody	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	CloudErrorBody[]	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	Region[]	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	Region	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.