Endpoints - Update

서비스:

Traffic Manager

API 버전:

2022-04-01

Traffic Manager 엔드포인트를 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpointName	path	True	string	업데이트할 Traffic Manager 엔드포인트의 이름입니다.
endpointType	path	True	EndpointType	업데이트할 Traffic Manager 엔드포인트의 유형입니다.
profileName	path	True	string	Traffic Manager 프로필의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명을 가져옵니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

Name	형식	Description
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	엔드포인트의 상태. 엔드포인트 상태가 Enabled이면 엔드포인트 상태가 검색된 것이며 엔드포인트가 트래픽 라우팅 방법에 포함됩니다.
properties.geoMapping	string[]	'지리적' 트래픽 라우팅 방법을 사용할 때 이 엔드포인트에 매핑된 국가/지역 목록입니다. 허용되는 값의 전체 목록은 Traffic Manager 지리적 설명서를 참조하세요.
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	리소스 형식입니다. 예- Microsoft.Network/trafficManagerProfiles.

응답

Name	형식	Description
200 OK	Endpoint	업데이트된 Traffic Manager 엔드포인트입니다.
Other Status Codes	CloudError	기본 응답입니다. 오류 정의에 따라 역직렬화됩니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

정의

Name	Description
AlwaysServe	Always Serve를 사용하도록 설정하면 엔드포인트 상태에 대한 검색이 비활성화되고 엔드포인트가 트래픽 라우팅 메서드에 포함됩니다.
CloudError	Azure Resource Manager 반환된 오류
CloudErrorBody	Azure Resource Manager 반환된 오류의 내용
CustomHeaders	사용자 지정 헤더 목록입니다.
Endpoint	Traffic Manager 엔드포인트를 나타내는 클래스입니다.
EndpointMonitorStatus	엔드포인트의 모니터링 상태.
EndpointStatus	엔드포인트의 상태. 엔드포인트 상태가 Enabled이면 엔드포인트 상태가 검색된 것이며 엔드포인트가 트래픽 라우팅 방법에 포함됩니다.
EndpointType	업데이트할 Traffic Manager 엔드포인트의 유형입니다.
Subnets	'서브넷' 트래픽 라우팅 방법을 사용할 때 이 엔드포인트에 매핑된 서브넷, IP 주소 및/또는 주소 범위 목록입니다. 빈 목록은 다른 엔드포인트에서 다루지 않는 모든 범위와 일치합니다.

AlwaysServe

Enumeration

Always Serve를 사용하도록 설정하면 엔드포인트 상태에 대한 검색이 비활성화되고 엔드포인트가 트래픽 라우팅 메서드에 포함됩니다.

값	Description
Disabled
Enabled

CloudError

Object

Azure Resource Manager 반환된 오류

Name	형식	Description
error	CloudErrorBody	오류의 내용입니다.

CloudErrorBody

Object

Azure Resource Manager 반환된 오류의 내용

Name	형식	Description
code	string	오류 코드
details	CloudErrorBody[]	오류 세부 정보
message	string	오류 메시지
target	string	오류 대상

CustomHeaders

Object

사용자 지정 헤더 목록입니다.

Name	형식	Description
name	string	헤더 이름입니다.
value	string	헤더 값입니다.

Endpoint

Object

Traffic Manager 엔드포인트를 나타내는 클래스입니다.

Name	형식	Description
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	엔드포인트의 상태. 엔드포인트 상태가 Enabled이면 엔드포인트 상태가 검색된 것이며 엔드포인트가 트래픽 라우팅 방법에 포함됩니다.
properties.geoMapping	string[]	'지리적' 트래픽 라우팅 방법을 사용할 때 이 엔드포인트에 매핑된 국가/지역 목록입니다. 허용되는 값의 전체 목록은 Traffic Manager 지리적 설명서를 참조하세요.
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	리소스 형식입니다. 예- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Enumeration

엔드포인트의 모니터링 상태.

값	Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Enumeration

엔드포인트의 상태. 엔드포인트 상태가 Enabled이면 엔드포인트 상태가 검색된 것이며 엔드포인트가 트래픽 라우팅 방법에 포함됩니다.

값	Description
Disabled
Enabled

EndpointType

Enumeration

업데이트할 Traffic Manager 엔드포인트의 유형입니다.

값	Description
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Subnets

Object

'서브넷' 트래픽 라우팅 방법을 사용할 때 이 엔드포인트에 매핑된 서브넷, IP 주소 및/또는 주소 범위 목록입니다. 빈 목록은 다른 엔드포인트에서 다루지 않는 모든 범위와 일치합니다.

Name	형식	Description
first	string	서브넷의 첫 번째 주소입니다.
last	string	서브넷의 마지막 주소입니다.
scope	integer	블록 크기(서브넷 마스크의 선행 비트 수).