Traffic Manager User Metrics Keys - Create Or Update

Reference

Služba:: Traffic Manager

Verze rozhraní API:: 2022-04-01

Vytvořte nebo aktualizujte klíč na úrovni předplatného, který se používá pro shromažďování metrik reálných uživatelů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
201 Created	UserMetricsModel	Byl vytvořen nový klíč na úrovni předplatného pro shromažďování metrik reálných uživatelů.
Other Status Codes	CloudError	Výchozí odpověď. Bude deserializována podle definice chyby.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

TrafficManagerUserMetricsKeys-PUT

Sample request

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


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


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/TrafficManagerUserMetricsKeys-PUT.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-PUT.json
func ExampleUserMetricsKeysClient_CreateOrUpdate() {
	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)
	}
	_, err = clientFactory.NewUserMetricsKeysClient().CreateOrUpdate(ctx, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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 Create or update a subscription-level key used for Real User Metrics collection.
 *
 * @summary Create or update a 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-PUT.json
 */
async function trafficManagerUserMetricsKeysPut() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.trafficManagerUserMetricsKeys.createOrUpdate();
  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-PUT.json
// this example is just showing the usage of "TrafficManagerUserMetricsKeys_CreateOrUpdate" 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
ArmOperation<TrafficManagerUserMetricsResource> lro = await trafficManagerUserMetrics.CreateOrUpdateAsync(WaitUntil.Completed);
TrafficManagerUserMetricsResource result = lro.Value;

// 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:: 201

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

Definice

Name	Description
CloudError	Chyba vrácená službou Azure Resource Manager
CloudErrorBody	Obsah chyby vrácené službou Azure Resource Manager
UserMetricsModel	Třída představující metriky uživatelů Traffic Manageru

CloudError

Chyba vrácená službou Azure Resource Manager

Name	Typ	Description
error	CloudErrorBody	Obsah chyby.

CloudErrorBody

Obsah chyby vrácené službou Azure Resource Manager

Name	Typ	Description
code	string	Kód chyby
details	CloudErrorBody[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby

UserMetricsModel

Třída představující metriky uživatelů Traffic Manageru

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Název prostředku
properties.key	string	Klíč vrácený operací Metriky uživatele.
type	string	Typ prostředku. Příklad: Microsoft.Network/trafficManagerProfiles.