Endpoints - Update

Служба:

Traffic Manager

Версия API:

2022-04-01

Обновление конечной точки диспетчера трафика.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpointName	path	True	string	Имя обновляемой конечной точки диспетчера трафика.
endpointType	path	True	EndpointType	Тип обновляемой конечной точки диспетчера трафика.
profileName	path	True	string	Имя профиля диспетчера трафика.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Имя ресурса.
properties.alwaysServe	AlwaysServe	Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
properties.customHeaders	CustomHeaders[]	Список настраиваемых заголовков.
properties.endpointLocation	string	Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика "Производительность".
properties.endpointMonitorStatus	EndpointMonitorStatus	Состояние мониторинга конечной точки.
properties.endpointStatus	EndpointStatus	Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.
properties.geoMapping	string[]	Список стран или регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Географический". Полный список допустимых значений см. в географической документации по диспетчеру трафика.
properties.minChildEndpoints	integer	Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv4	integer	Минимальное количество конечных точек IPv4 (запись DNS типа A), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv6	integer	Минимальное количество конечных точек IPv6 (тип записи DNS AAAA), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.priority	integer	Приоритет этой конечной точки при использовании метода маршрутизации трафика "Приоритет". Возможные значения — от 1 до 1000, а более низкие — более высокий приоритет. Этот параметр является необязательным. Если он указывается, то должен указываться во всех конечных точках, и никакие две конечные точки не могут иметь одинаковый приоритет.
properties.subnets	Subnets[]	Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.
properties.target	string	Полное DNS-имя или IP-адрес конечной точки. Диспетчер трафика возвращает это значение в DNS-ответы для направления трафика в эту конечную точку.
properties.targetResourceId	string	URI ресурса Azure конечной точки. Неприменимо к конечным точкам типа ExternalEndpoints.
properties.weight	integer	Вес этой конечной точки при использовании метода маршрутизации трафика с взвешанным значением. Возможные значения : от 1 до 1000.
type	string	Тип ресурса. Например, Microsoft.Network/trafficManagerProfiles.

Ответы

Имя	Тип	Описание
200 OK	Endpoint	Обновленная конечная точка диспетчера трафика.
Other Status Codes	CloudError	Ответ по умолчанию. Он будет десериализоваться согласно определению Error.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Endpoint-PATCH-External-Target

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AlwaysServe	Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
CloudError	Ошибка, возвращенная Resource Manager Azure
CloudErrorBody	Содержимое ошибки, возвращаемой Resource Manager Azure
CustomHeaders	Список настраиваемых заголовков.
Endpoint	Класс, представляющий конечную точку диспетчера трафика.
EndpointMonitorStatus	Состояние мониторинга конечной точки.
EndpointStatus	Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.
EndpointType	Тип обновляемой конечной точки диспетчера трафика.
Subnets	Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.

AlwaysServe

Enumeration

Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.

Значение	Описание
Disabled
Enabled

CloudError

Object

Ошибка, возвращенная Resource Manager Azure

Имя	Тип	Описание
error	CloudErrorBody	Содержимое ошибки.

CloudErrorBody

Object

Содержимое ошибки, возвращаемой Resource Manager Azure

Имя	Тип	Описание
code	string	Код ошибки
details	CloudErrorBody[]	Сведения об ошибке
message	string	Сообщение об ошибке
target	string	Целевой объект ошибки

CustomHeaders

Object

Список настраиваемых заголовков.

Имя	Тип	Описание
name	string	Имя заголовка.
value	string	Значение заголовка.

Endpoint

Object

Класс, представляющий конечную точку диспетчера трафика.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Имя ресурса.
properties.alwaysServe	AlwaysServe	Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
properties.customHeaders	CustomHeaders[]	Список настраиваемых заголовков.
properties.endpointLocation	string	Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика "Производительность".
properties.endpointMonitorStatus	EndpointMonitorStatus	Состояние мониторинга конечной точки.
properties.endpointStatus	EndpointStatus	Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.
properties.geoMapping	string[]	Список стран или регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Географический". Полный список допустимых значений см. в географической документации по диспетчеру трафика.
properties.minChildEndpoints	integer	Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv4	integer	Минимальное количество конечных точек IPv4 (запись DNS типа A), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv6	integer	Минимальное количество конечных точек IPv6 (тип записи DNS AAAA), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.priority	integer	Приоритет этой конечной точки при использовании метода маршрутизации трафика "Приоритет". Возможные значения — от 1 до 1000, а более низкие — более высокий приоритет. Этот параметр является необязательным. Если он указывается, то должен указываться во всех конечных точках, и никакие две конечные точки не могут иметь одинаковый приоритет.
properties.subnets	Subnets[]	Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.
properties.target	string	Полное DNS-имя или IP-адрес конечной точки. Диспетчер трафика возвращает это значение в DNS-ответы для направления трафика в эту конечную точку.
properties.targetResourceId	string	URI ресурса Azure конечной точки. Неприменимо к конечным точкам типа ExternalEndpoints.
properties.weight	integer	Вес этой конечной точки при использовании метода маршрутизации трафика с взвешанным значением. Возможные значения : от 1 до 1000.
type	string	Тип ресурса. Например, Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Enumeration

Состояние мониторинга конечной точки.

Значение	Описание
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Enumeration

Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.

Значение	Описание
Disabled
Enabled

EndpointType

Enumeration

Тип обновляемой конечной точки диспетчера трафика.

Значение	Описание
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Subnets

Object

Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.

Имя	Тип	Описание
first	string	Первый адрес в подсети.
last	string	Последний адрес в подсети.
scope	integer	Размер блока (количество битов в начале в маске подсети).