Endpoints - Update

Service:

Traffic Manager

Version d'API:

2022-04-01

Mettez à jour un point de terminaison Traffic Manager.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}?api-version=2022-04-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpointName	path	True	string	Nom du point de terminaison Traffic Manager à mettre à jour.
endpointType	path	True	EndpointType	Type du point de terminaison Traffic Manager à mettre à jour.
profileName	path	True	string	Nom du profil Traffic Manager.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	Obtient les informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

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.alwaysServe	AlwaysServe	Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.
properties.customHeaders	CustomHeaders[]	Liste des en-têtes personnalisés.
properties.endpointLocation	string	Spécifie l’emplacement des points de terminaison externes ou imbriqués lors de l’utilisation de la méthode de routage du trafic « Performance ».
properties.endpointMonitorStatus	EndpointMonitorStatus	État de surveillance du point de terminaison.
properties.endpointStatus	EndpointStatus	État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.
properties.geoMapping	string[]	Liste des pays/régions mappés à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Géographique ». Consultez la documentation géographique de Traffic Manager pour obtenir la liste complète des valeurs acceptées.
properties.minChildEndpoints	integer (int64)	Nombre minimal de points de terminaison qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.minChildEndpointsIPv4	integer (int64)	Nombre minimal de points de terminaison IPv4 (type d’enregistrement DNS A) qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.minChildEndpointsIPv6	integer (int64)	Nombre minimal de points de terminaison IPv6 (type d’enregistrement DNS AAAA) qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.priority	integer (int64)	Priorité de ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Priorité ». Les valeurs possibles sont comprises entre 1 et 1 000, les valeurs inférieures représentent une priorité plus élevée. Il s’agit d’un paramètre facultatif. S’il est spécifié, il doit être spécifié sur tous les points de terminaison et aucun point de terminaison ne peut partager la même valeur de priorité.
properties.subnets	Subnets[]	Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.
properties.target	string	Nom DNS complet ou adresse IP du point de terminaison. Traffic Manager retourne cette valeur dans les réponses DNS pour diriger le trafic vers ce point de terminaison.
properties.targetResourceId	string	URI de ressource Azure du point de terminaison. Non applicable aux points de terminaison de type « ExternalEndpoints ».
properties.weight	integer (int64)	Poids de ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Weighted ». Les valeurs possibles sont comprises entre 1 et 1 000.
type	string	Type de la ressource. Ex- Microsoft.Network/trafficManagerProfiles.

Réponses

Nom	Type	Description
200 OK	Endpoint	Point de terminaison Traffic Manager mis à jour.
Other Status Codes	CloudError	Réponse par défaut. Elle sera désérialisée 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

Endpoint-PATCH-External-Target

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "target": "another.foobar.contoso.com"
  }
}

Java

import com.azure.resourcemanager.trafficmanager.fluent.models.EndpointInner;
import com.azure.resourcemanager.trafficmanager.models.EndpointTypes;

/**
 * Samples for Endpoints Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PATCH-
     * External-Target.json
     */
    /**
     * Sample code: Endpoint-PATCH-External-Target.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void endpointPATCHExternalTarget(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.trafficManagerProfiles().manager().serviceClient().getEndpoints().updateWithResponse(
            "azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", EndpointTypes.EXTERNAL_ENDPOINTS, "azsmnet7187",
            new EndpointInner().withId(
                "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187")
                .withName("azsmnet7187").withType("Microsoft.Network/trafficManagerProfiles/externalEndpoints")
                .withTarget("another.foobar.contoso.com"),
            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 endpoint_patch_external_target.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.endpoints.update(
        resource_group_name="azuresdkfornetautoresttrafficmanager1421",
        profile_name="azsmnet6386",
        endpoint_type="ExternalEndpoints",
        endpoint_name="azsmnet7187",
        parameters={
            "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
            "name": "azsmnet7187",
            "properties": {"target": "another.foobar.contoso.com"},
            "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
        },
    )
    print(response)


# x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PATCH-External-Target.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/azcore/to"
	"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/Endpoint-PATCH-External-Target.json
func ExampleEndpointsClient_Update() {
	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.NewEndpointsClient().Update(ctx, "azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", armtrafficmanager.EndpointTypeExternalEndpoints, "azsmnet7187", armtrafficmanager.Endpoint{
		Name: to.Ptr("azsmnet7187"),
		Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/externalEndpoints"),
		ID:   to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187"),
		Properties: &armtrafficmanager.EndpointProperties{
			Target: to.Ptr("another.foobar.contoso.com"),
		},
	}, 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.Endpoint = armtrafficmanager.Endpoint{
	// 	Name: to.Ptr("azsmnet7187"),
	// 	Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/externalEndpoints"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187"),
	// 	Properties: &armtrafficmanager.EndpointProperties{
	// 		EndpointLocation: to.Ptr("North Europe"),
	// 		EndpointMonitorStatus: to.Ptr(armtrafficmanager.EndpointMonitorStatusCheckingEndpoint),
	// 		EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
	// 		Priority: to.Ptr[int64](1),
	// 		Target: to.Ptr("another.foobar.contoso.com"),
	// 		Weight: to.Ptr[int64](1),
	// 	},
	// }
}

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 Update a Traffic Manager endpoint.
 *
 * @summary Update a Traffic Manager endpoint.
 * x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PATCH-External-Target.json
 */
async function endpointPatchExternalTarget() {
  const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName =
    process.env["TRAFFICMANAGER_RESOURCE_GROUP"] || "azuresdkfornetautoresttrafficmanager1421";
  const profileName = "azsmnet6386";
  const endpointType = "ExternalEndpoints";
  const endpointName = "azsmnet7187";
  const parameters = {
    name: "azsmnet7187",
    type: "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
    id: "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
    target: "another.foobar.contoso.com",
  };
  const credential = new DefaultAzureCredential();
  const client = new TrafficManagerManagementClient(credential, subscriptionId);
  const result = await client.endpoints.update(
    resourceGroupName,
    profileName,
    endpointType,
    endpointName,
    parameters
  );
  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/Endpoint-PATCH-External-Target.json
// this example is just showing the usage of "Endpoints_Update" 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 TrafficManagerEndpointResource created on azure
// for more information of creating TrafficManagerEndpointResource, please refer to the document of TrafficManagerEndpointResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1421";
string profileName = "azsmnet6386";
string endpointType = "ExternalEndpoints";
string endpointName = "azsmnet7187";
ResourceIdentifier trafficManagerEndpointResourceId = TrafficManagerEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointType, endpointName);
TrafficManagerEndpointResource trafficManagerEndpoint = client.GetTrafficManagerEndpointResource(trafficManagerEndpointResourceId);

// invoke the operation
TrafficManagerEndpointData data = new TrafficManagerEndpointData
{
    Target = "another.foobar.contoso.com",
    Id = new ResourceIdentifier("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187"),
    Name = "azsmnet7187",
    ResourceType = new ResourceType("Microsoft.Network/trafficManagerProfiles/externalEndpoints"),
};
TrafficManagerEndpointResource result = await trafficManagerEndpoint.UpdateAsync(data);

// 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
TrafficManagerEndpointData 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": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "another.foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe"
  }
}

Définitions

Nom	Description
AlwaysServe	Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.
CloudError	Erreur retournée par Azure Resource Manager
CloudErrorBody	Contenu d’une erreur retournée par Azure Resource Manager
CustomHeaders	Liste des en-têtes personnalisés.
Endpoint	Classe représentant un point de terminaison Traffic Manager.
EndpointMonitorStatus	État de surveillance du point de terminaison.
EndpointStatus	État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.
EndpointType	Type du point de terminaison Traffic Manager à mettre à jour.
Subnets	Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.

AlwaysServe

Énumération

Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.

Valeur	Description
Disabled
Enabled

CloudError

Object

Erreur retournée par Azure Resource Manager

Nom	Type	Description
error	CloudErrorBody	Contenu de l’erreur.

CloudErrorBody

Object

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

CustomHeaders

Object

Liste des en-têtes personnalisés.

Nom	Type	Description
name	string	Nom de l’en-tête.
value	string	Valeur d’en-tête.

Endpoint

Object

Classe représentant un point de terminaison 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.alwaysServe	AlwaysServe	Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.
properties.customHeaders	CustomHeaders[]	Liste des en-têtes personnalisés.
properties.endpointLocation	string	Spécifie l’emplacement des points de terminaison externes ou imbriqués lors de l’utilisation de la méthode de routage du trafic « Performance ».
properties.endpointMonitorStatus	EndpointMonitorStatus	État de surveillance du point de terminaison.
properties.endpointStatus	EndpointStatus	État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.
properties.geoMapping	string[]	Liste des pays/régions mappés à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Géographique ». Consultez la documentation géographique de Traffic Manager pour obtenir la liste complète des valeurs acceptées.
properties.minChildEndpoints	integer (int64)	Nombre minimal de points de terminaison qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.minChildEndpointsIPv4	integer (int64)	Nombre minimal de points de terminaison IPv4 (type d’enregistrement DNS A) qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.minChildEndpointsIPv6	integer (int64)	Nombre minimal de points de terminaison IPv6 (type d’enregistrement DNS AAAA) qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.priority	integer (int64)	Priorité de ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Priorité ». Les valeurs possibles sont comprises entre 1 et 1 000, les valeurs inférieures représentent une priorité plus élevée. Il s’agit d’un paramètre facultatif. S’il est spécifié, il doit être spécifié sur tous les points de terminaison et aucun point de terminaison ne peut partager la même valeur de priorité.
properties.subnets	Subnets[]	Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.
properties.target	string	Nom DNS complet ou adresse IP du point de terminaison. Traffic Manager retourne cette valeur dans les réponses DNS pour diriger le trafic vers ce point de terminaison.
properties.targetResourceId	string	URI de ressource Azure du point de terminaison. Non applicable aux points de terminaison de type « ExternalEndpoints ».
properties.weight	integer (int64)	Poids de ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Weighted ». Les valeurs possibles sont comprises entre 1 et 1 000.
type	string	Type de la ressource. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Énumération

État de surveillance du point de terminaison.

Valeur	Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Énumération

État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.

Valeur	Description
Disabled
Enabled

EndpointType

Énumération

Type du point de terminaison Traffic Manager à mettre à jour.

Valeur	Description
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Subnets

Object

Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.

Nom	Type	Description
first	string	Première adresse dans le sous-réseau.
last	string	Dernière adresse dans le sous-réseau.
scope	integer	Taille de bloc (nombre de bits de début dans le masque de sous-réseau).