Endpoints - Update

Service:

Traffic Manager

API-versie:

2022-04-01

Een Traffic Manager-eindpunt bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
endpointName	path	True	string	De naam van het Traffic Manager-eindpunt dat moet worden bijgewerkt.
endpointType	path	True	EndpointType	Het type Traffic Manager-eindpunt dat moet worden bijgewerkt.
profileName	path	True	string	De naam van het Traffic Manager-profiel.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	Hiermee haalt u abonnementsreferenties op die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	De naam van de resource
properties.alwaysServe	AlwaysServe	Als Always Serve is ingeschakeld, wordt testen op eindpuntstatus uitgeschakeld en worden eindpunten opgenomen in de verkeersrouteringsmethode.
properties.customHeaders	CustomHeaders[]	Lijst met aangepaste headers.
properties.endpointLocation	string	Hiermee geeft u de locatie van de externe of geneste eindpunten bij het gebruik van de verkeersrouteringsmethode 'Prestaties'.
properties.endpointMonitorStatus	EndpointMonitorStatus	De bewakingsstatus van het eindpunt.
properties.endpointStatus	EndpointStatus	De status van het eindpunt. Als het eindpunt is ingeschakeld, wordt het gecontroleerd op de eindpuntstatus en wordt het opgenomen in de verkeersrouteringsmethode.
properties.geoMapping	string[]	De lijst met landen/regio's die zijn toegewezen aan dit eindpunt bij gebruik van de routeringsmethode 'Geografisch'. Raadpleeg de geografische documentatie van Traffic Manager voor een volledige lijst met geaccepteerde waarden.
properties.minChildEndpoints	integer (int64)	Het minimale aantal eindpunten dat beschikbaar moet zijn in het onderliggende profiel om ervoor te zorgen dat het bovenliggende profiel als beschikbaar wordt beschouwd. Alleen van toepassing op eindpunt van het type NestedEndpoints.
properties.minChildEndpointsIPv4	integer (int64)	Het minimale aantal IPv4-eindpunten (DNS-recordtype A) dat beschikbaar moet zijn in het onderliggende profiel om ervoor te zorgen dat het bovenliggende profiel als beschikbaar wordt beschouwd. Alleen van toepassing op eindpunt van het type NestedEndpoints.
properties.minChildEndpointsIPv6	integer (int64)	Het minimale aantal IPv6-eindpunten (DNS-recordtype AAAA) dat beschikbaar moet zijn in het onderliggende profiel, zodat het bovenliggende profiel als beschikbaar kan worden beschouwd. Alleen van toepassing op eindpunt van het type NestedEndpoints.
properties.priority	integer (int64)	De prioriteit van dit eindpunt bij het gebruik van de verkeersrouteringsmethode Prioriteit. Mogelijke waarden zijn van 1 tot 1000, lagere waarden vertegenwoordigen een hogere prioriteit. Dit is een optionele parameter. Indien opgegeven, moet deze worden opgegeven op alle eindpunten en kunnen er geen twee eindpunten dezelfde prioriteitswaarde delen.
properties.subnets	Subnets[]	De lijst met subnetten, IP-adressen en/of adresbereiken die aan dit eindpunt zijn toegewezen bij gebruik van de verkeersrouteringsmethode 'Subnet'. Een lege lijst komt overeen met alle bereiken die niet worden gedekt door andere eindpunten.
properties.target	string	De volledig gekwalificeerde DNS-naam of het IP-adres van het eindpunt. Traffic Manager retourneert deze waarde in DNS-antwoorden om verkeer naar dit eindpunt te leiden.
properties.targetResourceId	string	De Azure Resource-URI van het eindpunt. Niet van toepassing op eindpunten van het type ExternalEndpoints.
properties.weight	integer (int64)	Het gewicht van dit eindpunt bij het gebruik van de verkeersrouteringsmethode Gewogen. Mogelijke waarden zijn van 1 tot 1000.
type	string	Het type resource. Bijvoorbeeld Microsoft.Network/trafficManagerProfiles.

Antwoorden

Name	Type	Description
200 OK	Endpoint	Het bijgewerkte Traffic Manager-eindpunt.
Other Status Codes	CloudError	Standaardantwoord. Deze wordt gedeserialiseerd volgens de foutdefinitie.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Endpoint-PATCH-External-Target

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AlwaysServe	Als Always Serve is ingeschakeld, wordt testen op eindpuntstatus uitgeschakeld en worden eindpunten opgenomen in de verkeersrouteringsmethode.
CloudError	Een fout geretourneerd door Azure Resource Manager
CloudErrorBody	De inhoud van een fout die wordt geretourneerd door Azure Resource Manager
CustomHeaders	Lijst met aangepaste headers.
Endpoint	Klasse die een Traffic Manager-eindpunt vertegenwoordigt.
EndpointMonitorStatus	De bewakingsstatus van het eindpunt.
EndpointStatus	De status van het eindpunt. Als het eindpunt is ingeschakeld, wordt het gecontroleerd op de eindpuntstatus en wordt het opgenomen in de verkeersrouteringsmethode.
EndpointType	Het type Traffic Manager-eindpunt dat moet worden bijgewerkt.
Subnets	De lijst met subnetten, IP-adressen en/of adresbereiken die aan dit eindpunt zijn toegewezen bij gebruik van de verkeersrouteringsmethode 'Subnet'. Een lege lijst komt overeen met alle bereiken die niet worden gedekt door andere eindpunten.

AlwaysServe

Inventarisatie

Als Always Serve is ingeschakeld, wordt testen op eindpuntstatus uitgeschakeld en worden eindpunten opgenomen in de verkeersrouteringsmethode.

Waarde	Description
Disabled
Enabled

CloudError

Object

Een fout geretourneerd door Azure Resource Manager

Name	Type	Description
error	CloudErrorBody	De inhoud van de fout.

CloudErrorBody

Object

De inhoud van een fout die wordt geretourneerd door Azure Resource Manager

Name	Type	Description
code	string	Foutcode
details	CloudErrorBody[]	Foutdetails
message	string	Foutmelding
target	string	Foutdoel

CustomHeaders

Object

Lijst met aangepaste headers.

Name	Type	Description
name	string	Koptekstnaam.
value	string	Kopwaarde.

Endpoint

Object

Klasse die een Traffic Manager-eindpunt vertegenwoordigt.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	De naam van de resource
properties.alwaysServe	AlwaysServe	Als Always Serve is ingeschakeld, wordt testen op eindpuntstatus uitgeschakeld en worden eindpunten opgenomen in de verkeersrouteringsmethode.
properties.customHeaders	CustomHeaders[]	Lijst met aangepaste headers.
properties.endpointLocation	string	Hiermee geeft u de locatie van de externe of geneste eindpunten bij het gebruik van de verkeersrouteringsmethode 'Prestaties'.
properties.endpointMonitorStatus	EndpointMonitorStatus	De bewakingsstatus van het eindpunt.
properties.endpointStatus	EndpointStatus	De status van het eindpunt. Als het eindpunt is ingeschakeld, wordt het gecontroleerd op de eindpuntstatus en wordt het opgenomen in de verkeersrouteringsmethode.
properties.geoMapping	string[]	De lijst met landen/regio's die zijn toegewezen aan dit eindpunt bij gebruik van de routeringsmethode 'Geografisch'. Raadpleeg de geografische documentatie van Traffic Manager voor een volledige lijst met geaccepteerde waarden.
properties.minChildEndpoints	integer (int64)	Het minimale aantal eindpunten dat beschikbaar moet zijn in het onderliggende profiel om ervoor te zorgen dat het bovenliggende profiel als beschikbaar wordt beschouwd. Alleen van toepassing op eindpunt van het type NestedEndpoints.
properties.minChildEndpointsIPv4	integer (int64)	Het minimale aantal IPv4-eindpunten (DNS-recordtype A) dat beschikbaar moet zijn in het onderliggende profiel om ervoor te zorgen dat het bovenliggende profiel als beschikbaar wordt beschouwd. Alleen van toepassing op eindpunt van het type NestedEndpoints.
properties.minChildEndpointsIPv6	integer (int64)	Het minimale aantal IPv6-eindpunten (DNS-recordtype AAAA) dat beschikbaar moet zijn in het onderliggende profiel, zodat het bovenliggende profiel als beschikbaar kan worden beschouwd. Alleen van toepassing op eindpunt van het type NestedEndpoints.
properties.priority	integer (int64)	De prioriteit van dit eindpunt bij het gebruik van de verkeersrouteringsmethode Prioriteit. Mogelijke waarden zijn van 1 tot 1000, lagere waarden vertegenwoordigen een hogere prioriteit. Dit is een optionele parameter. Indien opgegeven, moet deze worden opgegeven op alle eindpunten en kunnen er geen twee eindpunten dezelfde prioriteitswaarde delen.
properties.subnets	Subnets[]	De lijst met subnetten, IP-adressen en/of adresbereiken die aan dit eindpunt zijn toegewezen bij gebruik van de verkeersrouteringsmethode 'Subnet'. Een lege lijst komt overeen met alle bereiken die niet worden gedekt door andere eindpunten.
properties.target	string	De volledig gekwalificeerde DNS-naam of het IP-adres van het eindpunt. Traffic Manager retourneert deze waarde in DNS-antwoorden om verkeer naar dit eindpunt te leiden.
properties.targetResourceId	string	De Azure Resource-URI van het eindpunt. Niet van toepassing op eindpunten van het type ExternalEndpoints.
properties.weight	integer (int64)	Het gewicht van dit eindpunt bij het gebruik van de verkeersrouteringsmethode Gewogen. Mogelijke waarden zijn van 1 tot 1000.
type	string	Het type resource. Bijvoorbeeld Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Inventarisatie

De bewakingsstatus van het eindpunt.

Waarde	Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Inventarisatie

De status van het eindpunt. Als het eindpunt is ingeschakeld, wordt het gecontroleerd op de eindpuntstatus en wordt het opgenomen in de verkeersrouteringsmethode.

Waarde	Description
Disabled
Enabled

EndpointType

Inventarisatie

Het type Traffic Manager-eindpunt dat moet worden bijgewerkt.

Waarde	Description
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Subnets

Object

De lijst met subnetten, IP-adressen en/of adresbereiken die aan dit eindpunt zijn toegewezen bij gebruik van de verkeersrouteringsmethode 'Subnet'. Een lege lijst komt overeen met alle bereiken die niet worden gedekt door andere eindpunten.

Name	Type	Description
first	string	Eerste adres in het subnet.
last	string	Laatste adres in het subnet.
scope	integer	Blokgrootte (aantal voorloopbits in het subnetmasker).