Endpoints - Update

Servizio:

Traffic Manager

Versione API:

2022-04-01

Aggiornare un endpoint di Gestione traffico.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpointName	path	True	string	Nome dell'endpoint di Gestione traffico da aggiornare.
endpointType	path	True	EndpointType	Tipo dell'endpoint di Gestione traffico da aggiornare.
profileName	path	True	string	Nome del profilo di Gestione traffico.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	Ottiene le credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Nome della risorsa
properties.alwaysServe	AlwaysServe	Se Always Serve è abilitato, il probe per l'integrità degli endpoint verrà disabilitato e gli endpoint verranno inclusi nel metodo di routing del traffico.
properties.customHeaders	CustomHeaders[]	Elenco di intestazioni personalizzate.
properties.endpointLocation	string	Specifica il percorso degli endpoint esterni o annidati quando si usa il metodo di routing del traffico "Prestazioni".
properties.endpointMonitorStatus	EndpointMonitorStatus	Stato di monitoraggio dell'endpoint.
properties.endpointStatus	EndpointStatus	Stato dell'endpoint. Se l'endpoint è Abilitato, viene eseguito il probe per l'integrità dell'endpoint e viene incluso nel metodo di routing del traffico.
properties.geoMapping	string[]	Elenco di paesi/aree mappate a questo endpoint quando si usa il metodo di routing del traffico 'Geografico'. Consultare la documentazione geografica di Gestione traffico per un elenco completo dei valori accettati.
properties.minChildEndpoints	integer (int64)	Numero minimo di endpoint che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.
properties.minChildEndpointsIPv4	integer (int64)	Numero minimo di endpoint IPv4 (tipo di record DNS A) che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.
properties.minChildEndpointsIPv6	integer (int64)	Numero minimo di endpoint IPv6 (tipo di record DNS AAAA) che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.
properties.priority	integer (int64)	Priorità di questo endpoint quando si usa il metodo di routing del traffico "Priority". I valori possibili sono compresi tra 1 e 1000, i valori inferiori rappresentano una priorità più alta. Questo è un parametro opzionale. Se specificato, deve essere specificato in tutti gli endpoint e nessun endpoint può condividere lo stesso valore di priorità.
properties.subnets	Subnets[]	Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponderà a tutti gli intervalli non coperti da altri endpoint.
properties.target	string	Nome DNS completo o indirizzo IP dell'endpoint. Gestione traffico restituisce questo valore nelle risposte DNS per indirizzare il traffico a questo endpoint.
properties.targetResourceId	string	URI della risorsa di Azure dell'endpoint. Non applicabile agli endpoint di tipo 'ExternalEndpoints'.
properties.weight	integer (int64)	Peso di questo endpoint quando si usa il metodo di routing del traffico "Ponderato". I valori possibili sono compresi tra 1 e 1000.
type	string	Tipo della risorsa. Ad esempio Microsoft.Network/trafficManagerProfiles.

Risposte

Nome	Tipo	Descrizione
200 OK	Endpoint	Endpoint di Gestione traffico aggiornato.
Other Status Codes	CloudError	Risposta predefinita. Verrà deserializzato in base alla definizione di errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Endpoint-PATCH-External-Target

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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"
  }
}

Definizioni

Nome	Descrizione
AlwaysServe	Se Always Serve è abilitato, il probe per l'integrità degli endpoint verrà disabilitato e gli endpoint verranno inclusi nel metodo di routing del traffico.
CloudError	Errore restituito da Azure Resource Manager
CloudErrorBody	Contenuto di un errore restituito da Azure Resource Manager
CustomHeaders	Elenco di intestazioni personalizzate.
Endpoint	Classe che rappresenta un endpoint di Gestione traffico.
EndpointMonitorStatus	Stato di monitoraggio dell'endpoint.
EndpointStatus	Stato dell'endpoint. Se l'endpoint è Abilitato, viene eseguito il probe per l'integrità dell'endpoint e viene incluso nel metodo di routing del traffico.
EndpointType	Tipo dell'endpoint di Gestione traffico da aggiornare.
Subnets	Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponderà a tutti gli intervalli non coperti da altri endpoint.

AlwaysServe

Enumerazione

Se Always Serve è abilitato, il probe per l'integrità degli endpoint verrà disabilitato e gli endpoint verranno inclusi nel metodo di routing del traffico.

Valore	Descrizione
Disabled
Enabled

CloudError

Object

Errore restituito da Azure Resource Manager

Nome	Tipo	Descrizione
error	CloudErrorBody	Contenuto dell'errore.

CloudErrorBody

Object

Contenuto di un errore restituito da Azure Resource Manager

Nome	Tipo	Descrizione
code	string	Codice di errore
details	CloudErrorBody[]	Dettagli errore
message	string	Messaggio di errore
target	string	Destinazione errore

CustomHeaders

Object

Elenco di intestazioni personalizzate.

Nome	Tipo	Descrizione
name	string	Nome intestazione.
value	string	Valore dell'intestazione.

Endpoint

Object

Classe che rappresenta un endpoint di Gestione traffico.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Nome della risorsa
properties.alwaysServe	AlwaysServe	Se Always Serve è abilitato, il probe per l'integrità degli endpoint verrà disabilitato e gli endpoint verranno inclusi nel metodo di routing del traffico.
properties.customHeaders	CustomHeaders[]	Elenco di intestazioni personalizzate.
properties.endpointLocation	string	Specifica il percorso degli endpoint esterni o annidati quando si usa il metodo di routing del traffico "Prestazioni".
properties.endpointMonitorStatus	EndpointMonitorStatus	Stato di monitoraggio dell'endpoint.
properties.endpointStatus	EndpointStatus	Stato dell'endpoint. Se l'endpoint è Abilitato, viene eseguito il probe per l'integrità dell'endpoint e viene incluso nel metodo di routing del traffico.
properties.geoMapping	string[]	Elenco di paesi/aree mappate a questo endpoint quando si usa il metodo di routing del traffico 'Geografico'. Consultare la documentazione geografica di Gestione traffico per un elenco completo dei valori accettati.
properties.minChildEndpoints	integer (int64)	Numero minimo di endpoint che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.
properties.minChildEndpointsIPv4	integer (int64)	Numero minimo di endpoint IPv4 (tipo di record DNS A) che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.
properties.minChildEndpointsIPv6	integer (int64)	Numero minimo di endpoint IPv6 (tipo di record DNS AAAA) che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.
properties.priority	integer (int64)	Priorità di questo endpoint quando si usa il metodo di routing del traffico "Priority". I valori possibili sono compresi tra 1 e 1000, i valori inferiori rappresentano una priorità più alta. Questo è un parametro opzionale. Se specificato, deve essere specificato in tutti gli endpoint e nessun endpoint può condividere lo stesso valore di priorità.
properties.subnets	Subnets[]	Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponderà a tutti gli intervalli non coperti da altri endpoint.
properties.target	string	Nome DNS completo o indirizzo IP dell'endpoint. Gestione traffico restituisce questo valore nelle risposte DNS per indirizzare il traffico a questo endpoint.
properties.targetResourceId	string	URI della risorsa di Azure dell'endpoint. Non applicabile agli endpoint di tipo 'ExternalEndpoints'.
properties.weight	integer (int64)	Peso di questo endpoint quando si usa il metodo di routing del traffico "Ponderato". I valori possibili sono compresi tra 1 e 1000.
type	string	Tipo della risorsa. Ad esempio Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Enumerazione

Stato di monitoraggio dell'endpoint.

Valore	Descrizione
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Enumerazione

Stato dell'endpoint. Se l'endpoint è Abilitato, viene eseguito il probe per l'integrità dell'endpoint e viene incluso nel metodo di routing del traffico.

Valore	Descrizione
Disabled
Enabled

EndpointType

Enumerazione

Tipo dell'endpoint di Gestione traffico da aggiornare.

Valore	Descrizione
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Subnets

Object

Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponderà a tutti gli intervalli non coperti da altri endpoint.

Nome	Tipo	Descrizione
first	string	Primo indirizzo nella subnet.
last	string	Ultimo indirizzo nella subnet.
scope	integer	Dimensioni del blocco (numero di bit iniziali nella subnet mask).