Traffic Manager User Metrics Keys - Get

Référence

Service:: Traffic Manager

Version d'API:: 2022-04-01

Obtenez la clé au niveau de l’abonnement utilisée pour la collection de métriques utilisateur réels.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default?api-version=2022-04-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Obtient les informations d'identification d'abonnement qui identifient l'abonnement Microsoft Azure de manière unique. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	UserMetricsModel	Clé de métriques d’utilisateur réel Traffic Manager au niveau de l’abonnement.
Other Status Codes	CloudError	Réponse par défaut. Il sera désérialisé conformément à la définition d’erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

TrafficManagerUserMetricsKeys-GET

Exemple de requête

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default?api-version=2022-04-01


/**
 * Samples for TrafficManagerUserMetricsKeys Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/
     * TrafficManagerUserMetricsKeys-GET.json
     */
    /**
     * Sample code: TrafficManagerUserMetricsKeys-GET.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void trafficManagerUserMetricsKeysGET(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getTrafficManagerUserMetricsKeys()
            .getWithResponse(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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-trafficmanager
# USAGE
    python traffic_manager_user_metrics_keys_get.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.traffic_manager_user_metrics_keys.get()
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/TrafficManagerUserMetricsKeys-GET.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

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/TrafficManagerUserMetricsKeys-GET.json
func ExampleUserMetricsKeysClient_Get() {
	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.NewUserMetricsKeysClient().Get(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.UserMetricsModel = armtrafficmanager.UserMetricsModel{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerUserMetricsKeys"),
	// 	ID: to.Ptr("/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default"),
	// 	Properties: &armtrafficmanager.UserMetricsProperties{
	// 		Key: to.Ptr("9ea056eb38f145a0891b5d5dc15e9aa2"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Get the subscription-level key used for Real User Metrics collection.
 *
 * @summary Get the subscription-level key used for Real User Metrics collection.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/TrafficManagerUserMetricsKeys-GET.json
 */
async function trafficManagerUserMetricsKeysGet() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.trafficManagerUserMetricsKeys.get();
  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

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/TrafficManagerUserMetricsKeys-GET.json
// this example is just showing the usage of "TrafficManagerUserMetricsKeys_Get" 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 TrafficManagerUserMetricsResource created on azure
// for more information of creating TrafficManagerUserMetricsResource, please refer to the document of TrafficManagerUserMetricsResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier trafficManagerUserMetricsResourceId = TrafficManagerUserMetricsResource.CreateResourceIdentifier(subscriptionId);
TrafficManagerUserMetricsResource trafficManagerUserMetrics = client.GetTrafficManagerUserMetricsResource(trafficManagerUserMetricsResourceId);

// invoke the operation
TrafficManagerUserMetricsResource result = await trafficManagerUserMetrics.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
TrafficManagerUserMetricData 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

Exemple de réponse

Code d’état:: 200

{
  "id": "/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default",
  "name": "default",
  "type": "Microsoft.Network/trafficManagerUserMetricsKeys",
  "properties": {
    "key": "9ea056eb38f145a0891b5d5dc15e9aa2"
  }
}

Définitions

Nom	Description
CloudError	Erreur retournée par le Resource Manager Azure
CloudErrorBody	Contenu d’une erreur retournée par azure Resource Manager
UserMetricsModel	Classe représentant les métriques utilisateur Traffic Manager.

CloudError

Erreur retournée par le Resource Manager Azure

Nom	Type	Description
error	CloudErrorBody	Contenu de l’erreur.

CloudErrorBody

Contenu d’une erreur retournée par azure Resource Manager

Nom	Type	Description
code	string	Code d'erreur
details	CloudErrorBody[]	Détails de l’erreur
message	string	Message d’erreur
target	string	Cible d’erreur

UserMetricsModel

Classe représentant les métriques utilisateur Traffic Manager.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	nom de la ressource.
properties.key	string	Clé retournée par l’opération User Metrics.
type	string	Type de la ressource. Ex- Microsoft.Network/trafficManagerProfiles.