你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
id	string	资源的完全限定资源 ID。 例如 - /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	终结点 的 Azure 资源 URI。 不适用于类型为“ExternalEndpoints”的终结点。
properties.weight	integer	使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。
type	string	资源类型。 Ex- Microsoft.Network/trafficManagerProfiles。

响应

名称	类型	说明
200 OK	Endpoint	已更新的流量管理器终结点。
Other Status Codes	CloudError	默认响应。 它将根据错误定义进行反序列化。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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	Azure 资源管理器返回的错误
CloudErrorBody	Azure 资源管理器返回的错误内容
CustomHeaders	自定义标头列表。
Endpoint	表示流量管理器终结点的类。
EndpointMonitorStatus	终结点的监视状态。
EndpointStatus	终结点的状态。 如果终结点已启用，则会探测它的运行状况，并将它包含在流量路由方法中。
EndpointType	要更新的流量管理器终结点的类型。
Subnets	使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。

AlwaysServe

Enumeration

如果启用了 Always Serve，则将禁用终结点运行状况探测，终结点将包含在流量路由方法中。

值	说明
Disabled
Enabled

CloudError

Object

Azure 资源管理器返回的错误

名称	类型	说明
error	CloudErrorBody	错误的内容。

CloudErrorBody

Object

Azure 资源管理器返回的错误内容

名称	类型	说明
code	string	错误代码
details	CloudErrorBody[]	错误详细信息
message	string	错误消息
target	string	错误目标

CustomHeaders

Object

自定义标头列表。

名称	类型	说明
name	string	标头名称。
value	string	标头值。

Endpoint

Object

表示流量管理器终结点的类。

名称	类型	说明
id	string	资源的完全限定资源 ID。 例如 - /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	终结点 的 Azure 资源 URI。 不适用于类型为“ExternalEndpoints”的终结点。
properties.weight	integer	使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。
type	string	资源类型。 Ex- 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	块大小 (子网掩码) 中的前导位数。