Endpoints - Update

Tjänst:

Traffic Manager

API-version:

2022-04-01

Uppdatera en Traffic Manager-slutpunkt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpointName	path	True	string	Namnet på traffic manager-slutpunkten som ska uppdateras.
endpointType	path	True	EndpointType	Typen av Traffic Manager-slutpunkt som ska uppdateras.
profileName	path	True	string	Namnet på Traffic Manager-profilen.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	Hämtar autentiseringsuppgifter för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Namnet på resursen
properties.alwaysServe	AlwaysServe	Om Always Serve är aktiverat inaktiveras avsökning för slutpunktshälsa och slutpunkter inkluderas i trafikroutningsmetoden.
properties.customHeaders	CustomHeaders[]	Lista över anpassade rubriker.
properties.endpointLocation	string	Anger platsen för de externa eller kapslade slutpunkterna när du använder trafikroutningsmetoden Prestanda.
properties.endpointMonitorStatus	EndpointMonitorStatus	Slutpunktens övervakningsstatus.
properties.endpointStatus	EndpointStatus	Slutpunktens status. Om slutpunkten är Aktiverad avsöks den för slutpunktshälsa och ingår i trafikroutningsmetoden.
properties.geoMapping	string[]	Listan över länder/regioner som mappas till den här slutpunkten när du använder trafikroutningsmetoden Geografisk. En fullständig lista över godkända värden finns i Traffic Manager Geographic-dokumentationen.
properties.minChildEndpoints	integer	Det minsta antalet slutpunkter som måste vara tillgängliga i den underordnade profilen för att den överordnade profilen ska anses vara tillgänglig. Gäller endast för slutpunkten av typen "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	Det minsta antalet IPv4-slutpunkter (DNS-posttyp A) som måste vara tillgängliga i den underordnade profilen för att den överordnade profilen ska anses vara tillgänglig. Gäller endast för slutpunkten av typen "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	Det minsta antalet IPv6-slutpunkter (DNS-posttyp AAAA) som måste vara tillgängliga i den underordnade profilen för att den överordnade profilen ska anses vara tillgänglig. Gäller endast för slutpunkten av typen "NestedEndpoints".
properties.priority	integer	Prioriteten för den här slutpunkten när du använder trafikroutningsmetoden Prioritet. Möjliga värden är från 1 till 1 000, lägre värden representerar högre prioritet. Det här är en valfri parameter. Om den anges måste den anges på alla slutpunkter och inga två slutpunkter kan dela samma prioritetsvärde.
properties.subnets	Subnets[]	Listan över undernät, IP-adresser och/eller adressintervall som mappas till den här slutpunkten när du använder trafikroutningsmetoden "Undernät". En tom lista matchar alla intervall som inte omfattas av andra slutpunkter.
properties.target	string	Slutpunktens fullständigt kvalificerade DNS-namn eller IP-adress. Traffic Manager returnerar det här värdet i DNS-svar för att dirigera trafik till den här slutpunkten.
properties.targetResourceId	string	Azure-resursens URI för slutpunkten. Gäller inte för slutpunkter av typen ExternalEndpoints.
properties.weight	integer	Vikten för den här slutpunkten när du använder trafikroutningsmetoden Viktad. Möjliga värden är från 1 till 1 000.
type	string	Resurstypen. Ex- Microsoft.Network/trafficManagerProfiles.

Svar

Name	Typ	Description
200 OK	Endpoint	Den uppdaterade Traffic Manager-slutpunkten.
Other Status Codes	CloudError	Standardsvar. Den kommer att deserialiseras enligt feldefinitionen.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Endpoint-PATCH-External-Target

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AlwaysServe	Om Always Serve är aktiverat inaktiveras avsökning för slutpunktshälsa och slutpunkter inkluderas i trafikroutningsmetoden.
CloudError	Ett fel som returneras av Azure Resource Manager
CloudErrorBody	Innehållet i ett fel som returneras av Azure Resource Manager
CustomHeaders	Lista över anpassade rubriker.
Endpoint	Klass som representerar en Traffic Manager-slutpunkt.
EndpointMonitorStatus	Slutpunktens övervakningsstatus.
EndpointStatus	Slutpunktens status. Om slutpunkten är Aktiverad avsöks den för slutpunktshälsa och ingår i trafikroutningsmetoden.
EndpointType	Typen av Traffic Manager-slutpunkt som ska uppdateras.
Subnets	Listan över undernät, IP-adresser och/eller adressintervall som mappas till den här slutpunkten när du använder trafikroutningsmetoden "Undernät". En tom lista matchar alla intervall som inte omfattas av andra slutpunkter.

AlwaysServe

Om Always Serve är aktiverat inaktiveras avsökning för slutpunktshälsa och slutpunkter inkluderas i trafikroutningsmetoden.

Name	Typ	Description
Disabled	string
Enabled	string

CloudError

Ett fel som returneras av Azure Resource Manager

Name	Typ	Description
error	CloudErrorBody	Innehållet i felet.

CloudErrorBody

Innehållet i ett fel som returneras av Azure Resource Manager

Name	Typ	Description
code	string	Felkod
details	CloudErrorBody[]	Felinformation
message	string	Felmeddelande
target	string	Felmål

CustomHeaders

Lista över anpassade rubriker.

Name	Typ	Description
name	string	Rubriknamn.
value	string	Rubrikvärde.

Endpoint

Klass som representerar en Traffic Manager-slutpunkt.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Namnet på resursen
properties.alwaysServe	AlwaysServe	Om Always Serve är aktiverat inaktiveras avsökning för slutpunktshälsa och slutpunkter inkluderas i trafikroutningsmetoden.
properties.customHeaders	CustomHeaders[]	Lista över anpassade rubriker.
properties.endpointLocation	string	Anger platsen för de externa eller kapslade slutpunkterna när du använder trafikroutningsmetoden Prestanda.
properties.endpointMonitorStatus	EndpointMonitorStatus	Slutpunktens övervakningsstatus.
properties.endpointStatus	EndpointStatus	Slutpunktens status. Om slutpunkten är Aktiverad avsöks den för slutpunktshälsa och ingår i trafikroutningsmetoden.
properties.geoMapping	string[]	Listan över länder/regioner som mappas till den här slutpunkten när du använder trafikroutningsmetoden Geografisk. En fullständig lista över godkända värden finns i Traffic Manager Geographic-dokumentationen.
properties.minChildEndpoints	integer	Det minsta antalet slutpunkter som måste vara tillgängliga i den underordnade profilen för att den överordnade profilen ska anses vara tillgänglig. Gäller endast för slutpunkten av typen "NestedEndpoints".
properties.minChildEndpointsIPv4	integer	Det minsta antalet IPv4-slutpunkter (DNS-posttyp A) som måste vara tillgängliga i den underordnade profilen för att den överordnade profilen ska anses vara tillgänglig. Gäller endast för slutpunkten av typen "NestedEndpoints".
properties.minChildEndpointsIPv6	integer	Det minsta antalet IPv6-slutpunkter (DNS-posttyp AAAA) som måste vara tillgängliga i den underordnade profilen för att den överordnade profilen ska anses vara tillgänglig. Gäller endast för slutpunkten av typen "NestedEndpoints".
properties.priority	integer	Prioriteten för den här slutpunkten när du använder trafikroutningsmetoden Prioritet. Möjliga värden är från 1 till 1 000, lägre värden representerar högre prioritet. Det här är en valfri parameter. Om den anges måste den anges på alla slutpunkter och inga två slutpunkter kan dela samma prioritetsvärde.
properties.subnets	Subnets[]	Listan över undernät, IP-adresser och/eller adressintervall som mappas till den här slutpunkten när du använder trafikroutningsmetoden "Undernät". En tom lista matchar alla intervall som inte omfattas av andra slutpunkter.
properties.target	string	Slutpunktens fullständigt kvalificerade DNS-namn eller IP-adress. Traffic Manager returnerar det här värdet i DNS-svar för att dirigera trafik till den här slutpunkten.
properties.targetResourceId	string	Azure-resursens URI för slutpunkten. Gäller inte för slutpunkter av typen ExternalEndpoints.
properties.weight	integer	Vikten för den här slutpunkten när du använder trafikroutningsmetoden Viktad. Möjliga värden är från 1 till 1 000.
type	string	Resurstypen. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Slutpunktens övervakningsstatus.

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

EndpointStatus

Slutpunktens status. Om slutpunkten är Aktiverad avsöks den för slutpunktshälsa och ingår i trafikroutningsmetoden.

Name	Typ	Description
Disabled	string
Enabled	string

EndpointType

Typen av Traffic Manager-slutpunkt som ska uppdateras.

Name	Typ	Description
AzureEndpoints	string
ExternalEndpoints	string
NestedEndpoints	string

Subnets

Listan över undernät, IP-adresser och/eller adressintervall som mappas till den här slutpunkten när du använder trafikroutningsmetoden "Undernät". En tom lista matchar alla intervall som inte omfattas av andra slutpunkter.

Name	Typ	Description
first	string	Första adressen i undernätet.
last	string	Sista adressen i undernätet.
scope	integer	Blockstorlek (antal inledande bitar i nätmasken).