Endpoints - Update

Serviço:

Traffic Manager

Versão da API:

2022-04-01

Atualizar um ponto final do Gestor de Tráfego.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpointName	path	True	string	O nome do ponto final do Gestor de Tráfego a atualizar.
endpointType	path	True	EndpointType	O tipo de ponto final do Gestor de Tráfego a ser atualizado.
profileName	path	True	string	O nome do perfil do Gestor de Tráfego.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	Obtém credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Corpo do Pedido

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	O nome do recurso
properties.alwaysServe	AlwaysServe	Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.
properties.customHeaders	CustomHeaders[]	Lista de cabeçalhos personalizados.
properties.endpointLocation	string	Especifica a localização dos pontos finais externos ou aninhados ao utilizar o método de encaminhamento de tráfego "Desempenho".
properties.endpointMonitorStatus	EndpointMonitorStatus	O estado de monitorização do ponto final.
properties.endpointStatus	EndpointStatus	O estado do ponto final. Se o ponto final estiver Ativado, será sondado para o estado de funcionamento do ponto final e incluído no método de encaminhamento de tráfego.
properties.geoMapping	string[]	A lista de países/regiões mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Geográfico". Consulte a documentação geográfica do Gestor de Tráfego para obter uma lista completa dos valores aceites.
properties.minChildEndpoints	integer	O número mínimo de pontos finais que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	O número mínimo de pontos finais IPv4 (tipo de registo DNS A) que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	O número mínimo de pontos finais IPv6 (tipo de registo DNS AAAA) que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.priority	integer	A prioridade deste ponto final ao utilizar o método de encaminhamento de tráfego "Priority". Os valores possíveis são de 1 a 1000, os valores mais baixos representam uma prioridade mais alta. Este é um parâmetro opcional. Se especificado, tem de ser especificado em todos os pontos finais e nenhum dos dois pontos finais pode partilhar o mesmo valor de prioridade.
properties.subnets	Subnets[]	A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.
properties.target	string	O nome DNS completamente qualificado ou o endereço IP do ponto final. O Gestor de Tráfego devolve este valor em respostas DNS para direcionar o tráfego para este ponto final.
properties.targetResourceId	string	O URI do Recurso do Azure do ponto final. Não aplicável aos pontos finais do tipo "ExternalEndpoints".
properties.weight	integer	A ponderação deste ponto final ao utilizar o método de encaminhamento de tráfego "Ponderado". Os valores possíveis são de 1 a 1000.
type	string	O tipo do recurso. Ex- Microsoft.Network/trafficManagerProfiles.

Respostas

Name	Tipo	Description
200 OK	Endpoint	O ponto final atualizado do Gestor de Tráfego.
Other Status Codes	CloudError	Resposta predefinida. Será desserializada de acordo com a Definição de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Endpoint-PATCH-External-Target

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
AlwaysServe	Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.
CloudError	Um erro devolvido pela Resource Manager do Azure
CloudErrorBody	O conteúdo de um erro devolvido pela Resource Manager do Azure
CustomHeaders	Lista de cabeçalhos personalizados.
Endpoint	Classe que representa um ponto final do Gestor de Tráfego.
EndpointMonitorStatus	O estado de monitorização do ponto final.
EndpointStatus	O estado do ponto final. Se o ponto final estiver Ativado, será sondado para o estado de funcionamento do ponto final e incluído no método de encaminhamento de tráfego.
EndpointType	O tipo de ponto final do Gestor de Tráfego a ser atualizado.
Subnets	A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.

AlwaysServe

Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.

Name	Tipo	Description
Disabled	string
Enabled	string

CloudError

Um erro devolvido pela Resource Manager do Azure

Name	Tipo	Description
error	CloudErrorBody	O conteúdo do erro.

CloudErrorBody

O conteúdo de um erro devolvido pela Resource Manager do Azure

Name	Tipo	Description
code	string	Código de erro
details	CloudErrorBody[]	Detalhes do erro
message	string	Mensagem de erro
target	string	Destino do erro

CustomHeaders

Lista de cabeçalhos personalizados.

Name	Tipo	Description
name	string	Nome do cabeçalho.
value	string	Valor do cabeçalho.

Endpoint

Classe que representa um ponto final do Gestor de Tráfego.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	O nome do recurso
properties.alwaysServe	AlwaysServe	Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.
properties.customHeaders	CustomHeaders[]	Lista de cabeçalhos personalizados.
properties.endpointLocation	string	Especifica a localização dos pontos finais externos ou aninhados ao utilizar o método de encaminhamento de tráfego "Desempenho".
properties.endpointMonitorStatus	EndpointMonitorStatus	O estado de monitorização do ponto final.
properties.endpointStatus	EndpointStatus	O estado do ponto final. Se o ponto final estiver Ativado, será sondado para o estado de funcionamento do ponto final e incluído no método de encaminhamento de tráfego.
properties.geoMapping	string[]	A lista de países/regiões mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Geográfico". Consulte a documentação geográfica do Gestor de Tráfego para obter uma lista completa dos valores aceites.
properties.minChildEndpoints	integer	O número mínimo de pontos finais que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	O número mínimo de pontos finais IPv4 (tipo de registo DNS A) que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	O número mínimo de pontos finais IPv6 (tipo de registo DNS AAAA) que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.priority	integer	A prioridade deste ponto final ao utilizar o método de encaminhamento de tráfego "Priority". Os valores possíveis são de 1 a 1000, os valores mais baixos representam uma prioridade mais alta. Este é um parâmetro opcional. Se especificado, tem de ser especificado em todos os pontos finais e nenhum dos dois pontos finais pode partilhar o mesmo valor de prioridade.
properties.subnets	Subnets[]	A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.
properties.target	string	O nome DNS completamente qualificado ou o endereço IP do ponto final. O Gestor de Tráfego devolve este valor em respostas DNS para direcionar o tráfego para este ponto final.
properties.targetResourceId	string	O URI do Recurso do Azure do ponto final. Não aplicável aos pontos finais do tipo "ExternalEndpoints".
properties.weight	integer	A ponderação deste ponto final ao utilizar o método de encaminhamento de tráfego "Ponderado". Os valores possíveis são de 1 a 1000.
type	string	O tipo do recurso. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

O estado de monitorização do ponto final.

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

EndpointStatus

O estado do ponto final. Se o ponto final estiver Ativado, será sondado para o estado de funcionamento do ponto final e incluído no método de encaminhamento de tráfego.

Name	Tipo	Description
Disabled	string
Enabled	string

EndpointType

O tipo de ponto final do Gestor de Tráfego a ser atualizado.

Name	Tipo	Description
AzureEndpoints	string
ExternalEndpoints	string
NestedEndpoints	string

Subnets

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.

Name	Tipo	Description
first	string	Primeiro endereço na sub-rede.
last	string	Último endereço na sub-rede.
scope	integer	Tamanho do bloco (número de bits à esquerda na máscara de sub-rede).