Endpoints - Update

Služba:

Traffic Manager

Verze rozhraní API:

2022-04-01

Aktualizace koncového bodu Traffic Manageru

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointName	path	True	string	Název koncového bodu Traffic Manageru, který se má aktualizovat.
endpointType	path	True	EndpointType	Typ koncového bodu Traffic Manageru, který se má aktualizovat.
profileName	path	True	string	Název profilu služby Traffic Manager.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Název prostředku
properties.alwaysServe	AlwaysServe	Pokud je povolená funkce Always Serve, bude testování stavu koncového bodu zakázáno a koncové body budou zahrnuty do metody směrování provozu.
properties.customHeaders	CustomHeaders[]	Seznam vlastních hlaviček
properties.endpointLocation	string	Určuje umístění externích nebo vnořených koncových bodů při použití metody směrování provozu Performance.
properties.endpointMonitorStatus	EndpointMonitorStatus	Stav monitorování koncového bodu.
properties.endpointStatus	EndpointStatus	Stav koncového bodu. Pokud je koncový bod povolený, dotazuje se na stav koncového bodu a je zahrnutý v metodě směrování provozu.
properties.geoMapping	string[]	Seznam zemí nebo oblastí namapovaných na tento koncový bod při použití metody geografického směrování provozu Úplný seznam přijatých hodnot najdete v geografické dokumentaci traffic manageru.
properties.minChildEndpoints	integer	Minimální počet koncových bodů, které musí být dostupné v podřízeného profilu, aby se nadřazený profil považoval za dostupný. Platí jenom pro koncový bod typu NestedEndpoints.
properties.minChildEndpointsIPv4	integer	Minimální počet koncových bodů IPv4 (záznam DNS typu A), které musí být dostupné v podřízeného profilu, aby se nadřazený profil považoval za dostupný. Platí jenom pro koncový bod typu NestedEndpoints.
properties.minChildEndpointsIPv6	integer	Minimální počet koncových bodů IPv6 (typ záznamu DNS AAAA), které musí být dostupné v podřízeného profilu, aby bylo možné nadřazený profil považovat za dostupný. Platí jenom pro koncový bod typu NestedEndpoints.
properties.priority	integer	Priorita tohoto koncového bodu při použití metody směrování provozu Priority Možné hodnoty jsou od 1 do 1000, nižší hodnoty představují vyšší prioritu. Jedná se o volitelný parametr. Pokud je zadaný, musí být zadaný na všech koncových bodech a žádné dva koncové body nemůžou sdílet stejnou hodnotu priority.
properties.subnets	Subnets[]	Seznam podsítí, IP adres nebo rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Subnet. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrývala.
properties.target	string	Plně kvalifikovaný název DNS nebo IP adresa koncového bodu. Traffic Manager vrátí tuto hodnotu v odpovědích DNS pro směrování provozu do tohoto koncového bodu.
properties.targetResourceId	string	Identifikátor URI prostředku Azure koncového bodu. Nevztahuje se na koncové body typu ExternalEndpoints.
properties.weight	integer	Váha tohoto koncového bodu při použití metody směrování váženého provozu Možné hodnoty jsou od 1 do 1000.
type	string	Typ prostředku. Příklad: Microsoft.Network/trafficManagerProfiles.

Odpovědi

Name	Typ	Description
200 OK	Endpoint	Aktualizovaný koncový bod Traffic Manageru.
Other Status Codes	CloudError	Výchozí odpověď. Bude deserializována podle definice chyby.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Endpoint-PATCH-External-Target

Ukázkový požadavek

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AlwaysServe	Pokud je povolená funkce Always Serve, bude testování stavu koncového bodu zakázáno a koncové body budou zahrnuty do metody směrování provozu.
CloudError	Chyba vrácená službou Azure Resource Manager
CloudErrorBody	Obsah chyby vrácené službou Azure Resource Manager
CustomHeaders	Seznam vlastních hlaviček
Endpoint	Třída představující koncový bod Traffic Manageru.
EndpointMonitorStatus	Stav monitorování koncového bodu.
EndpointStatus	Stav koncového bodu. Pokud je koncový bod povolený, dotazuje se na stav koncového bodu a je zahrnutý v metodě směrování provozu.
EndpointType	Typ koncového bodu Traffic Manageru, který se má aktualizovat.
Subnets	Seznam podsítí, IP adres nebo rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Subnet. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrývala.

AlwaysServe

Pokud je povolená funkce Always Serve, bude testování stavu koncového bodu zakázáno a koncové body budou zahrnuty do metody směrování provozu.

Name	Typ	Description
Disabled	string
Enabled	string

CloudError

Chyba vrácená službou Azure Resource Manager

Name	Typ	Description
error	CloudErrorBody	Obsah chyby.

CloudErrorBody

Obsah chyby vrácené službou Azure Resource Manager

Name	Typ	Description
code	string	Kód chyby
details	CloudErrorBody[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby

CustomHeaders

Seznam vlastních hlaviček

Name	Typ	Description
name	string	Název hlavičky.
value	string	Hodnota hlavičky.

Endpoint

Třída představující koncový bod Traffic Manageru.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Název prostředku
properties.alwaysServe	AlwaysServe	Pokud je povolená funkce Always Serve, bude testování stavu koncového bodu zakázáno a koncové body budou zahrnuty do metody směrování provozu.
properties.customHeaders	CustomHeaders[]	Seznam vlastních hlaviček
properties.endpointLocation	string	Určuje umístění externích nebo vnořených koncových bodů při použití metody směrování provozu Performance.
properties.endpointMonitorStatus	EndpointMonitorStatus	Stav monitorování koncového bodu.
properties.endpointStatus	EndpointStatus	Stav koncového bodu. Pokud je koncový bod povolený, dotazuje se na stav koncového bodu a je zahrnutý v metodě směrování provozu.
properties.geoMapping	string[]	Seznam zemí nebo oblastí namapovaných na tento koncový bod při použití metody geografického směrování provozu Úplný seznam přijatých hodnot najdete v geografické dokumentaci traffic manageru.
properties.minChildEndpoints	integer	Minimální počet koncových bodů, které musí být dostupné v podřízeného profilu, aby se nadřazený profil považoval za dostupný. Platí jenom pro koncový bod typu NestedEndpoints.
properties.minChildEndpointsIPv4	integer	Minimální počet koncových bodů IPv4 (záznam DNS typu A), které musí být dostupné v podřízeného profilu, aby se nadřazený profil považoval za dostupný. Platí jenom pro koncový bod typu NestedEndpoints.
properties.minChildEndpointsIPv6	integer	Minimální počet koncových bodů IPv6 (typ záznamu DNS AAAA), které musí být dostupné v podřízeného profilu, aby bylo možné nadřazený profil považovat za dostupný. Platí jenom pro koncový bod typu NestedEndpoints.
properties.priority	integer	Priorita tohoto koncového bodu při použití metody směrování provozu Priority Možné hodnoty jsou od 1 do 1000, nižší hodnoty představují vyšší prioritu. Jedná se o volitelný parametr. Pokud je zadaný, musí být zadaný na všech koncových bodech a žádné dva koncové body nemůžou sdílet stejnou hodnotu priority.
properties.subnets	Subnets[]	Seznam podsítí, IP adres nebo rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Subnet. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrývala.
properties.target	string	Plně kvalifikovaný název DNS nebo IP adresa koncového bodu. Traffic Manager vrátí tuto hodnotu v odpovědích DNS pro směrování provozu do tohoto koncového bodu.
properties.targetResourceId	string	Identifikátor URI prostředku Azure koncového bodu. Nevztahuje se na koncové body typu ExternalEndpoints.
properties.weight	integer	Váha tohoto koncového bodu při použití metody směrování váženého provozu Možné hodnoty jsou od 1 do 1000.
type	string	Typ prostředku. Příklad: Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Stav monitorování koncového bodu.

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

EndpointStatus

Stav koncového bodu. Pokud je koncový bod povolený, dotazuje se na stav koncového bodu a je zahrnutý v metodě směrování provozu.

Name	Typ	Description
Disabled	string
Enabled	string

EndpointType

Typ koncového bodu Traffic Manageru, který se má aktualizovat.

Name	Typ	Description
AzureEndpoints	string
ExternalEndpoints	string
NestedEndpoints	string

Subnets

Seznam podsítí, IP adres nebo rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Subnet. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrývala.

Name	Typ	Description
first	string	První adresa v podsíti.
last	string	Poslední adresa v podsíti.
scope	integer	Velikost bloku (počet počátečních bitů v masce podsítě)