Geographic Hierarchies - Get Default

Serviço:

Traffic Manager

Versão da API:

2022-04-01

Obtém a Hierarquia Geográfica padrão usada pelo método de roteamento de tráfego geográfico.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	TrafficManagerGeographicHierarchy	A hierarquia geográfica padrão.
Other Status Codes	CloudError	Resposta padrão. Ele será desserializado de acordo com a definição de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GeographicHierarchy-GET-default

Solicitação de exemplo

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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

Resposta de exemplo

Código de status:

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": []
            }
          ]
        }
      ]
    }
  }
}

Definições

Nome	Description
CloudError	Um erro retornado pelo Azure Resource Manager
CloudErrorBody	O conteúdo de um erro retornado pelo Azure Resource Manager
Region	Classe que representa uma região na hierarquia geográfica usada com o método de roteamento de tráfego geográfico.
TrafficManagerGeographicHierarchy	Classe que representa a hierarquia geográfica usada com o método de roteamento de tráfego geográfico.

CloudError

Objeto

Um erro retornado pelo Azure Resource Manager

Nome	Tipo	Description
error	CloudErrorBody	O conteúdo do erro.

CloudErrorBody

Objeto

O conteúdo de um erro retornado pelo Azure Resource Manager

Nome	Tipo	Description
code	string	Código de erro
details	CloudErrorBody[]	Detalhes do erro
message	string	Mensagem de erro
target	string	Destino de erro

Region

Objeto

Classe que representa uma região na hierarquia geográfica usada com o método de roteamento de tráfego geográfico.

Nome	Tipo	Description
code	string	O código da região
name	string	O nome da região
regions	Region[]	A lista de regiões agrupadas nessa região na Hierarquia Geográfica.

TrafficManagerGeographicHierarchy

Objeto

Classe que representa a hierarquia geográfica usada com o método de roteamento de tráfego geográfico.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	O nome do recurso
properties.geographicHierarchy	Region	A região na raiz da hierarquia de todas as regiões da hierarquia pode ser recuperada.
type	string	O tipo do recurso. Ex- Microsoft.Network/trafficManagerProfiles.