Endpoints - Update

Servicio:

Traffic Manager

Versión de la API:

2022-04-01

Actualice un punto de conexión de Traffic Manager.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpointName	path	True	string	Nombre del punto de conexión de Traffic Manager que se va a actualizar.
endpointType	path	True	EndpointType	Tipo del punto de conexión de Traffic Manager que se va a actualizar.
profileName	path	True	string	Nombre del perfil de Traffic Manager.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican a la suscripción de Microsoft Azure de forma única. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Nombre del recurso.
properties.alwaysServe	AlwaysServe	Si Always Serve está habilitado, se deshabilitará el sondeo del estado del punto de conexión y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.
properties.customHeaders	CustomHeaders[]	Lista de encabezados personalizados.
properties.endpointLocation	string	Especifica la ubicación de los puntos de conexión externos o anidados cuando se usa el método de enrutamiento de tráfico "Rendimiento".
properties.endpointMonitorStatus	EndpointMonitorStatus	Estado de supervisión del punto de conexión.
properties.endpointStatus	EndpointStatus	Estado del punto de conexión. Si el valor del extremo es Enabled, se sondea el mantenimiento del extremo y se incluye en el método de enrutamiento de tráfico.
properties.geoMapping	string[]	La lista de países o regiones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Geográfico". Consulte la documentación geográfica de Traffic Manager para obtener una lista completa de los valores aceptados.
properties.minChildEndpoints	integer	Número mínimo de puntos de conexión que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión de tipo "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	Número mínimo de puntos de conexión IPv4 (tipo de registro DNS A) que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión de tipo "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	Número mínimo de puntos de conexión IPv6 (AAAA de tipo de registro DNS) que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión de tipo "NestedEndpoints".
properties.priority	integer	Prioridad de este punto de conexión al usar el método de enrutamiento de tráfico "Prioridad". Los valores posibles son de 1 a 1000, los valores inferiores representan una prioridad más alta. Se trata de un parámetro opcional. Si se especifica, se debe especificar en todos los extremos y no puede haber dos extremos que compartan el mismo valor de prioridad.
properties.subnets	Subnets[]	La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.
properties.target	string	Nombre DNS completo o dirección IP del punto de conexión. El Administrador de tráfico devuelve este valor en las respuestas de DNS para dirigir el tráfico a este extremo.
properties.targetResourceId	string	URI del recurso de Azure del punto de conexión. No es aplicable a los puntos de conexión de tipo "ExternalEndpoints".
properties.weight	integer	Peso de este punto de conexión al usar el método de enrutamiento de tráfico "Ponderado". Los valores posibles son de 1 a 1000.
type	string	Tipo de recurso. Por ejemplo, Microsoft.Network/trafficManagerProfiles.

Respuestas

Nombre	Tipo	Description
200 OK	Endpoint	Punto de conexión actualizado de Traffic Manager.
Other Status Codes	CloudError	Respuesta predeterminada. Se deserializará según la definición de error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Endpoint-PATCH-External-Target

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
AlwaysServe	Si Always Serve está habilitado, se deshabilitará el sondeo del estado del punto de conexión y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.
CloudError	Error devuelto por azure Resource Manager
CloudErrorBody	El contenido de un error devuelto por azure Resource Manager
CustomHeaders	Lista de encabezados personalizados.
Endpoint	Clase que representa un punto de conexión de Traffic Manager.
EndpointMonitorStatus	Estado de supervisión del punto de conexión.
EndpointStatus	Estado del punto de conexión. Si el valor del extremo es Enabled, se sondea el mantenimiento del extremo y se incluye en el método de enrutamiento de tráfico.
EndpointType	Tipo del punto de conexión de Traffic Manager que se va a actualizar.
Subnets	La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.

AlwaysServe

Si Always Serve está habilitado, se deshabilitará el sondeo del estado del punto de conexión y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.

Nombre	Tipo	Description
Disabled	string
Enabled	string

CloudError

Error devuelto por azure Resource Manager

Nombre	Tipo	Description
error	CloudErrorBody	Contenido del error.

CloudErrorBody

El contenido de un error devuelto por azure Resource Manager

Nombre	Tipo	Description
code	string	Código de error
details	CloudErrorBody[]	Detalles del error
message	string	Mensaje de error
target	string	Destino de error

CustomHeaders

Lista de encabezados personalizados.

Nombre	Tipo	Description
name	string	Nombre del encabezado.
value	string	Valor del encabezado.

Endpoint

Clase que representa un punto de conexión de Traffic Manager.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Nombre del recurso.
properties.alwaysServe	AlwaysServe	Si Always Serve está habilitado, se deshabilitará el sondeo del estado del punto de conexión y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.
properties.customHeaders	CustomHeaders[]	Lista de encabezados personalizados.
properties.endpointLocation	string	Especifica la ubicación de los puntos de conexión externos o anidados cuando se usa el método de enrutamiento de tráfico "Rendimiento".
properties.endpointMonitorStatus	EndpointMonitorStatus	Estado de supervisión del punto de conexión.
properties.endpointStatus	EndpointStatus	Estado del punto de conexión. Si el valor del extremo es Enabled, se sondea el mantenimiento del extremo y se incluye en el método de enrutamiento de tráfico.
properties.geoMapping	string[]	La lista de países o regiones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Geográfico". Consulte la documentación geográfica de Traffic Manager para obtener una lista completa de los valores aceptados.
properties.minChildEndpoints	integer	Número mínimo de puntos de conexión que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión de tipo "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	Número mínimo de puntos de conexión IPv4 (tipo de registro DNS A) que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión de tipo "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	Número mínimo de puntos de conexión IPv6 (AAAA de tipo de registro DNS) que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión de tipo "NestedEndpoints".
properties.priority	integer	Prioridad de este punto de conexión al usar el método de enrutamiento de tráfico "Prioridad". Los valores posibles son de 1 a 1000, los valores inferiores representan una prioridad más alta. Se trata de un parámetro opcional. Si se especifica, se debe especificar en todos los extremos y no puede haber dos extremos que compartan el mismo valor de prioridad.
properties.subnets	Subnets[]	La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.
properties.target	string	Nombre DNS completo o dirección IP del punto de conexión. El Administrador de tráfico devuelve este valor en las respuestas de DNS para dirigir el tráfico a este extremo.
properties.targetResourceId	string	URI del recurso de Azure del punto de conexión. No es aplicable a los puntos de conexión de tipo "ExternalEndpoints".
properties.weight	integer	Peso de este punto de conexión al usar el método de enrutamiento de tráfico "Ponderado". Los valores posibles son de 1 a 1000.
type	string	Tipo de recurso. Por ejemplo, Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Estado de supervisión del punto de conexión.

Nombre	Tipo	Description
CheckingEndpoint	string
Degraded	string
Disabled	string
Inactive	string
Online	string
Stopped	string
Unmonitored	string

EndpointStatus

Estado del punto de conexión. Si el valor del extremo es Enabled, se sondea el mantenimiento del extremo y se incluye en el método de enrutamiento de tráfico.

Nombre	Tipo	Description
Disabled	string
Enabled	string

EndpointType

Tipo del punto de conexión de Traffic Manager que se va a actualizar.

Nombre	Tipo	Description
AzureEndpoints	string
ExternalEndpoints	string
NestedEndpoints	string

Subnets

La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.

Nombre	Tipo	Description
first	string	Primera dirección de la subred.
last	string	Última dirección de la subred.
scope	integer	Tamaño de bloque (número de bits iniciales en la máscara de subred).