Endpoints - Update

Usługa:

Traffic Manager

Wersja interfejsu API:

2022-04-01

Aktualizowanie punktu końcowego usługi Traffic Manager.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpointName	path	True	string	Nazwa punktu końcowego usługi Traffic Manager do zaktualizowania.
endpointType	path	True	EndpointType	Typ punktu końcowego usługi Traffic Manager do zaktualizowania.
profileName	path	True	string	Nazwa profilu usługi Traffic Manager.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Pobiera poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Nazwa zasobu
properties.alwaysServe	AlwaysServe	Jeśli funkcja Always Serve jest włączona, sondowanie kondycji punktu końcowego zostanie wyłączone, a punkty końcowe zostaną uwzględnione w metodzie routingu ruchu.
properties.customHeaders	CustomHeaders[]	Lista nagłówków niestandardowych.
properties.endpointLocation	string	Określa lokalizację zewnętrznych lub zagnieżdżonych punktów końcowych podczas korzystania z metody routingu ruchu "Wydajność".
properties.endpointMonitorStatus	EndpointMonitorStatus	Stan monitorowania punktu końcowego.
properties.endpointStatus	EndpointStatus	Stan punktu końcowego. Jeśli punkt końcowy jest włączony, jest sondowany pod kątem kondycji punktu końcowego i jest uwzględniony w metodzie routingu ruchu.
properties.geoMapping	string[]	Lista krajów/regionów zamapowanych na ten punkt końcowy podczas korzystania z metody routingu ruchu geograficznego. Aby uzyskać pełną listę akceptowanych wartości, zapoznaj się z dokumentacją geograficzną usługi Traffic Manager.
properties.minChildEndpoints	integer	Minimalna liczba punktów końcowych, które muszą być dostępne w profilu podrzędnym, aby profil nadrzędny był uznawany za dostępny. Dotyczy tylko punktu końcowego typu "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	Minimalna liczba punktów końcowych IPv4 (typ rekordu DNS A), które muszą być dostępne w profilu podrzędnym, aby profil nadrzędny był uznawany za dostępny. Dotyczy tylko punktu końcowego typu "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	Minimalna liczba punktów końcowych IPv6 (typu rekordu DNS AAAA), które muszą być dostępne w profilu podrzędnym, aby profil nadrzędny był uznawany za dostępny. Dotyczy tylko punktu końcowego typu "NestedEndpoints".
properties.priority	integer	Priorytet tego punktu końcowego podczas korzystania z metody routingu ruchu "Priorytet". Możliwe wartości to od 1 do 1000, niższe wartości reprezentują wyższy priorytet. Jest to opcjonalny parametr. Jeśli zostanie określony, należy go określić we wszystkich punktach końcowych, a żadne dwa punkty końcowe nie mogą współdzielić tej samej wartości priorytetu.
properties.subnets	Subnets[]	Lista podsieci, adresów IP i/lub zakresów adresów mapowanych na ten punkt końcowy podczas korzystania z metody routingu ruchu "Podsieć". Pusta lista będzie zgodna ze wszystkimi zakresami, które nie są objęte innymi punktami końcowymi.
properties.target	string	W pełni kwalifikowana nazwa DNS lub adres IP punktu końcowego. Usługa Traffic Manager zwraca tę wartość w odpowiedziach DNS, aby skierować ruch do tego punktu końcowego.
properties.targetResourceId	string	Identyfikator URI zasobu platformy Azure punktu końcowego. Nie dotyczy punktów końcowych typu "ExternalEndpoints".
properties.weight	integer	Waga tego punktu końcowego podczas korzystania z metody routingu ruchu "Ważona". Możliwe wartości to od 1 do 1000.
type	string	Typ zasobu. Ex- Microsoft.Network/trafficManagerProfiles.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Endpoint	Zaktualizowany punkt końcowy usługi Traffic Manager.
Other Status Codes	CloudError	Odpowiedź domyślna. Zostanie ona zdeserializowana zgodnie z definicją błędu.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Endpoint-PATCH-External-Target

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
AlwaysServe	Jeśli funkcja Always Serve jest włączona, sondowanie kondycji punktu końcowego zostanie wyłączone, a punkty końcowe zostaną uwzględnione w metodzie routingu ruchu.
CloudError	Błąd zwrócony przez usługę Azure Resource Manager
CloudErrorBody	Zawartość błędu zwróconego przez usługę Azure Resource Manager
CustomHeaders	Lista nagłówków niestandardowych.
Endpoint	Klasa reprezentująca punkt końcowy usługi Traffic Manager.
EndpointMonitorStatus	Stan monitorowania punktu końcowego.
EndpointStatus	Stan punktu końcowego. Jeśli punkt końcowy jest włączony, jest sondowany pod kątem kondycji punktu końcowego i jest uwzględniony w metodzie routingu ruchu.
EndpointType	Typ punktu końcowego usługi Traffic Manager do zaktualizowania.
Subnets	Lista podsieci, adresów IP i/lub zakresów adresów mapowanych na ten punkt końcowy podczas korzystania z metody routingu ruchu "Podsieć". Pusta lista będzie zgodna ze wszystkimi zakresami, które nie są objęte innymi punktami końcowymi.

AlwaysServe

Jeśli funkcja Always Serve jest włączona, sondowanie kondycji punktu końcowego zostanie wyłączone, a punkty końcowe zostaną uwzględnione w metodzie routingu ruchu.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

CloudError

Błąd zwrócony przez usługę Azure Resource Manager

Nazwa	Typ	Opis
error	CloudErrorBody	Zawartość błędu.

CloudErrorBody

Zawartość błędu zwróconego przez usługę Azure Resource Manager

Nazwa	Typ	Opis
code	string	Kod błędu
details	CloudErrorBody[]	Szczegóły błędu
message	string	Komunikat o błędzie
target	string	Błąd docelowy

CustomHeaders

Lista nagłówków niestandardowych.

Nazwa	Typ	Opis
name	string	Nazwa nagłówka.
value	string	Wartość nagłówka.

Endpoint

Klasa reprezentująca punkt końcowy usługi Traffic Manager.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Nazwa zasobu
properties.alwaysServe	AlwaysServe	Jeśli funkcja Always Serve jest włączona, sondowanie kondycji punktu końcowego zostanie wyłączone, a punkty końcowe zostaną uwzględnione w metodzie routingu ruchu.
properties.customHeaders	CustomHeaders[]	Lista nagłówków niestandardowych.
properties.endpointLocation	string	Określa lokalizację zewnętrznych lub zagnieżdżonych punktów końcowych podczas korzystania z metody routingu ruchu "Wydajność".
properties.endpointMonitorStatus	EndpointMonitorStatus	Stan monitorowania punktu końcowego.
properties.endpointStatus	EndpointStatus	Stan punktu końcowego. Jeśli punkt końcowy jest włączony, jest sondowany pod kątem kondycji punktu końcowego i jest uwzględniony w metodzie routingu ruchu.
properties.geoMapping	string[]	Lista krajów/regionów zamapowanych na ten punkt końcowy podczas korzystania z metody routingu ruchu geograficznego. Aby uzyskać pełną listę akceptowanych wartości, zapoznaj się z dokumentacją geograficzną usługi Traffic Manager.
properties.minChildEndpoints	integer	Minimalna liczba punktów końcowych, które muszą być dostępne w profilu podrzędnym, aby profil nadrzędny był uznawany za dostępny. Dotyczy tylko punktu końcowego typu "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	Minimalna liczba punktów końcowych IPv4 (typ rekordu DNS A), które muszą być dostępne w profilu podrzędnym, aby profil nadrzędny był uznawany za dostępny. Dotyczy tylko punktu końcowego typu "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	Minimalna liczba punktów końcowych IPv6 (typu rekordu DNS AAAA), które muszą być dostępne w profilu podrzędnym, aby profil nadrzędny był uznawany za dostępny. Dotyczy tylko punktu końcowego typu "NestedEndpoints".
properties.priority	integer	Priorytet tego punktu końcowego podczas korzystania z metody routingu ruchu "Priorytet". Możliwe wartości to od 1 do 1000, niższe wartości reprezentują wyższy priorytet. Jest to opcjonalny parametr. Jeśli zostanie określony, należy go określić we wszystkich punktach końcowych, a żadne dwa punkty końcowe nie mogą współdzielić tej samej wartości priorytetu.
properties.subnets	Subnets[]	Lista podsieci, adresów IP i/lub zakresów adresów mapowanych na ten punkt końcowy podczas korzystania z metody routingu ruchu "Podsieć". Pusta lista będzie zgodna ze wszystkimi zakresami, które nie są objęte innymi punktami końcowymi.
properties.target	string	W pełni kwalifikowana nazwa DNS lub adres IP punktu końcowego. Usługa Traffic Manager zwraca tę wartość w odpowiedziach DNS, aby skierować ruch do tego punktu końcowego.
properties.targetResourceId	string	Identyfikator URI zasobu platformy Azure punktu końcowego. Nie dotyczy punktów końcowych typu "ExternalEndpoints".
properties.weight	integer	Waga tego punktu końcowego podczas korzystania z metody routingu ruchu "Ważona". Możliwe wartości to od 1 do 1000.
type	string	Typ zasobu. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Stan monitorowania punktu końcowego.

Nazwa	Typ	Opis
CheckingEndpoint	string
Degraded	string
Disabled	string
Inactive	string
Online	string
Stopped	string
Unmonitored	string

EndpointStatus

Stan punktu końcowego. Jeśli punkt końcowy jest włączony, jest sondowany pod kątem kondycji punktu końcowego i jest uwzględniony w metodzie routingu ruchu.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

EndpointType

Typ punktu końcowego usługi Traffic Manager do zaktualizowania.

Nazwa	Typ	Opis
AzureEndpoints	string
ExternalEndpoints	string
NestedEndpoints	string

Subnets

Lista podsieci, adresów IP i/lub zakresów adresów mapowanych na ten punkt końcowy podczas korzystania z metody routingu ruchu "Podsieć". Pusta lista będzie zgodna ze wszystkimi zakresami, które nie są objęte innymi punktami końcowymi.

Nazwa	Typ	Opis
first	string	Pierwszy adres w podsieci.
last	string	Ostatni adres w podsieci.
scope	integer	Rozmiar bloku (liczba bitów wiodących w masce podsieci).