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 參數

名稱	位於	必要	類型	Description
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 版本。

要求本文

名稱	類型	Description
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	端點的 Azure 資源 URI。 不適用於 『ExternalEndpoints』 類型的端點。
properties.weight	integer	使用「加權」流量路由方法時，此端點的權數。 可能的值為 1 到 1000。
type	string	資源類型。 Ex- Microsoft.Network/trafficManagerProfiles。

回應

名稱	類型	Description
200 OK	Endpoint	更新的流量管理員端點。
Other Status Codes	CloudError	默認回應。 它會根據錯誤定義還原串行化。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
AlwaysServe	如果已啟用 Always Serve，則會停用端點健全狀況的探查，並將端點包含在流量路由方法中。
CloudError	Azure Resource Manager 傳回的錯誤
CloudErrorBody	Azure Resource Manager 傳回的錯誤內容
CustomHeaders	自定義標頭的清單。
Endpoint	代表流量管理員端點的類別。
EndpointMonitorStatus	端點的監視狀態。
EndpointStatus	端點的狀態。 如果端點已啟用，則會探查其健全狀況，並將其包含在流量路由方式中。
EndpointType	要更新的流量管理員端點類型。
Subnets	使用「子網」流量路由方法時，對應至此端點的子網、IP 位址和/或地址範圍清單。 空白清單會符合其他端點未涵蓋的所有範圍。

AlwaysServe

如果已啟用 Always Serve，則會停用端點健全狀況的探查，並將端點包含在流量路由方法中。

名稱	類型	Description
Disabled	string
Enabled	string

CloudError

Azure Resource Manager 傳回的錯誤

名稱	類型	Description
error	CloudErrorBody	錯誤的內容。

CloudErrorBody

Azure Resource Manager 傳回的錯誤內容

名稱	類型	Description
code	string	錯誤碼
details	CloudErrorBody[]	錯誤詳細資料
message	string	錯誤訊息
target	string	錯誤目標

CustomHeaders

自定義標頭的清單。

名稱	類型	Description
name	string	標頭名稱。
value	string	標頭值。

Endpoint

代表流量管理員端點的類別。

名稱	類型	Description
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	端點的 Azure 資源 URI。 不適用於 『ExternalEndpoints』 類型的端點。
properties.weight	integer	使用「加權」流量路由方法時，此端點的權數。 可能的值為 1 到 1000。
type	string	資源類型。 Ex- Microsoft.Network/trafficManagerProfiles。

EndpointMonitorStatus

端點的監視狀態。

名稱	類型	Description
CheckingEndpoint	string
Degraded	string
Disabled	string
Inactive	string
Online	string
Stopped	string
Unmonitored	string

EndpointStatus

端點的狀態。 如果端點已啟用，則會探查其健全狀況，並將其包含在流量路由方式中。

名稱	類型	Description
Disabled	string
Enabled	string

EndpointType

要更新的流量管理員端點類型。

名稱	類型	Description
AzureEndpoints	string
ExternalEndpoints	string
NestedEndpoints	string

Subnets

使用「子網」流量路由方法時，對應至此端點的子網、IP 位址和/或地址範圍清單。 空白清單會符合其他端點未涵蓋的所有範圍。

名稱	類型	Description
first	string	子網中的第一個位址。
last	string	子網中的最後一個位址。
scope	integer	區塊大小 (子網掩碼中的前置位數目) 。