Traffic Manager User Metrics Keys - Get

Ссылка

Service:: Traffic Manager

API Version:: 2022-04-01

Получите ключ уровня подписки, используемый для сбора метрик реального пользователя.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Ответы

Имя	Тип	Описание
200 OK	UserMetricsModel	Ключ реальных пользовательских метрик диспетчера трафика на уровне подписки.
Other Status Codes	CloudError	Ответ по умолчанию. Он будет десериализоваться согласно определению Error.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

TrafficManagerUserMetricsKeys-GET

Sample Request

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 System;
using System.Threading.Tasks;
using Azure;
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/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

Sample Response

Status code:: 200

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

Определения

Имя	Описание
CloudError	Ошибка, возвращенная Resource Manager Azure
CloudErrorBody	Содержимое ошибки, возвращаемой Resource Manager Azure
UserMetricsModel	Класс, представляющий метрики пользователя диспетчера трафика.

CloudError

Ошибка, возвращенная Resource Manager Azure

Имя	Тип	Описание
error	CloudErrorBody	Содержимое ошибки.

CloudErrorBody

Содержимое ошибки, возвращаемой Resource Manager Azure

Имя	Тип	Описание
code	string	Код ошибки
details	CloudErrorBody[]	Сведения об ошибке
message	string	Сообщение об ошибке
target	string	Целевой объект ошибки

UserMetricsModel

Класс, представляющий метрики пользователя диспетчера трафика.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Имя ресурса.
properties.key	string	Ключ, возвращенный операцией Пользовательские метрики.
type	string	Тип ресурса. Например, Microsoft.Network/trafficManagerProfiles.