建立或更新流量管理員端點。
PUT 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。
|
回應
安全性
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| 名稱 |
Description |
|
user_impersonation
|
模擬您的用戶帳戶
|
範例
Endpoint-PUT-External-WithAlwaysServe
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01
{
"name": "azsmnet7187",
"type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
"properties": {
"target": "foobar.contoso.com",
"endpointStatus": "Enabled",
"endpointLocation": "North Europe",
"alwaysServe": "Enabled"
}
}
import com.azure.resourcemanager.trafficmanager.fluent.models.EndpointInner;
import com.azure.resourcemanager.trafficmanager.models.AlwaysServe;
import com.azure.resourcemanager.trafficmanager.models.EndpointStatus;
import com.azure.resourcemanager.trafficmanager.models.EndpointTypes;
/** Samples for Endpoints CreateOrUpdate. */
public final class Main {
/*
* x-ms-original-file:
* specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-
* WithAlwaysServe.json
*/
/**
* Sample code: Endpoint-PUT-External-WithAlwaysServe.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void endpointPUTExternalWithAlwaysServe(com.azure.resourcemanager.AzureResourceManager azure) {
azure.trafficManagerProfiles().manager().serviceClient().getEndpoints().createOrUpdateWithResponse(
"azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", EndpointTypes.EXTERNAL_ENDPOINTS, "azsmnet7187",
new EndpointInner().withName("azsmnet7187")
.withType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints").withTarget("foobar.contoso.com")
.withEndpointStatus(EndpointStatus.ENABLED).withEndpointLocation("North Europe")
.withAlwaysServe(AlwaysServe.ENABLED),
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-trafficmanager
# USAGE
python endpoint_put_external_with_always_serve.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.create_or_update(
resource_group_name="azuresdkfornetautoresttrafficmanager1421",
profile_name="azsmnet6386",
endpoint_type="ExternalEndpoints",
endpoint_name="azsmnet7187",
parameters={
"name": "azsmnet7187",
"properties": {
"alwaysServe": "Enabled",
"endpointLocation": "North Europe",
"endpointStatus": "Enabled",
"target": "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-PUT-External-WithAlwaysServe.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
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-PUT-External-WithAlwaysServe.json
func ExampleEndpointsClient_CreateOrUpdate_endpointPutExternalWithAlwaysServe() {
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().CreateOrUpdate(ctx, "azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", armtrafficmanager.EndpointTypeExternalEndpoints, "azsmnet7187", armtrafficmanager.Endpoint{
Name: to.Ptr("azsmnet7187"),
Type: to.Ptr("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
Properties: &armtrafficmanager.EndpointProperties{
AlwaysServe: to.Ptr(armtrafficmanager.AlwaysServeEnabled),
EndpointLocation: to.Ptr("North Europe"),
EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
Target: to.Ptr("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{
// AlwaysServe: to.Ptr(armtrafficmanager.AlwaysServeEnabled),
// EndpointLocation: to.Ptr("North Europe"),
// EndpointMonitorStatus: to.Ptr(armtrafficmanager.EndpointMonitorStatusCheckingEndpoint),
// EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
// Priority: to.Ptr[int64](1),
// Target: to.Ptr("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
const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Create or update a Traffic Manager endpoint.
*
* @summary Create or update a Traffic Manager endpoint.
* x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithAlwaysServe.json
*/
async function endpointPutExternalWithAlwaysServe() {
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",
alwaysServe: "Enabled",
endpointLocation: "North Europe",
endpointStatus: "Enabled",
target: "foobar.contoso.com",
};
const credential = new DefaultAzureCredential();
const client = new TrafficManagerManagementClient(credential, subscriptionId);
const result = await client.endpoints.createOrUpdate(
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
using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.TrafficManager;
using Azure.ResourceManager.TrafficManager.Models;
// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithAlwaysServe.json
// this example is just showing the usage of "Endpoints_CreateOrUpdate" 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 TrafficManagerProfileResource created on azure
// for more information of creating TrafficManagerProfileResource, please refer to the document of TrafficManagerProfileResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1421";
string profileName = "azsmnet6386";
ResourceIdentifier trafficManagerProfileResourceId = TrafficManagerProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
TrafficManagerProfileResource trafficManagerProfile = client.GetTrafficManagerProfileResource(trafficManagerProfileResourceId);
// get the collection of this TrafficManagerEndpointResource
TrafficManagerEndpointCollection collection = trafficManagerProfile.GetTrafficManagerEndpoints();
// invoke the operation
string endpointType = "ExternalEndpoints";
string endpointName = "azsmnet7187";
TrafficManagerEndpointData data = new TrafficManagerEndpointData()
{
Target = "foobar.contoso.com",
EndpointStatus = TrafficManagerEndpointStatus.Enabled,
EndpointLocation = "North Europe",
AlwaysServe = TrafficManagerEndpointAlwaysServeStatus.Enabled,
Name = "azsmnet7187",
ResourceType = new ResourceType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
};
ArmOperation<TrafficManagerEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, endpointType, endpointName, data);
TrafficManagerEndpointResource result = lro.Value;
// 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
Sample Response
{
"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": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe",
"alwaysServe": "Enabled"
}
}
{
"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": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe",
"alwaysServe": "Enabled"
}
}
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01
{
"name": "azsmnet7187",
"type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
"properties": {
"target": "foobar.contoso.com",
"endpointStatus": "Enabled",
"endpointLocation": "North Europe",
"customHeaders": [
{
"name": "header-1",
"value": "value-1"
},
{
"name": "header-2",
"value": "value-2"
}
]
}
}
import com.azure.resourcemanager.trafficmanager.fluent.models.EndpointInner;
import com.azure.resourcemanager.trafficmanager.models.EndpointPropertiesCustomHeadersItem;
import com.azure.resourcemanager.trafficmanager.models.EndpointStatus;
import com.azure.resourcemanager.trafficmanager.models.EndpointTypes;
import java.util.Arrays;
/** Samples for Endpoints CreateOrUpdate. */
public final class Main {
/*
* x-ms-original-file:
* specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-
* WithCustomHeaders.json
*/
/**
* Sample code: Endpoint-PUT-External-WithCustomHeaders.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void endpointPUTExternalWithCustomHeaders(com.azure.resourcemanager.AzureResourceManager azure) {
azure.trafficManagerProfiles().manager().serviceClient().getEndpoints().createOrUpdateWithResponse(
"azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", EndpointTypes.EXTERNAL_ENDPOINTS, "azsmnet7187",
new EndpointInner().withName("azsmnet7187")
.withType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints").withTarget("foobar.contoso.com")
.withEndpointStatus(EndpointStatus.ENABLED).withEndpointLocation("North Europe").withCustomHeaders(
Arrays.asList(new EndpointPropertiesCustomHeadersItem().withName("header-1").withValue("value-1"),
new EndpointPropertiesCustomHeadersItem().withName("header-2").withValue("value-2"))),
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-trafficmanager
# USAGE
python endpoint_put_external_with_custom_headers.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.create_or_update(
resource_group_name="azuresdkfornetautoresttrafficmanager1421",
profile_name="azsmnet6386",
endpoint_type="ExternalEndpoints",
endpoint_name="azsmnet7187",
parameters={
"name": "azsmnet7187",
"properties": {
"customHeaders": [{"name": "header-1", "value": "value-1"}, {"name": "header-2", "value": "value-2"}],
"endpointLocation": "North Europe",
"endpointStatus": "Enabled",
"target": "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-PUT-External-WithCustomHeaders.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
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-PUT-External-WithCustomHeaders.json
func ExampleEndpointsClient_CreateOrUpdate_endpointPutExternalWithCustomHeaders() {
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().CreateOrUpdate(ctx, "azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", armtrafficmanager.EndpointTypeExternalEndpoints, "azsmnet7187", armtrafficmanager.Endpoint{
Name: to.Ptr("azsmnet7187"),
Type: to.Ptr("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
Properties: &armtrafficmanager.EndpointProperties{
CustomHeaders: []*armtrafficmanager.EndpointPropertiesCustomHeadersItem{
{
Name: to.Ptr("header-1"),
Value: to.Ptr("value-1"),
},
{
Name: to.Ptr("header-2"),
Value: to.Ptr("value-2"),
}},
EndpointLocation: to.Ptr("North Europe"),
EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
Target: to.Ptr("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{
// CustomHeaders: []*armtrafficmanager.EndpointPropertiesCustomHeadersItem{
// {
// Name: to.Ptr("header-1"),
// Value: to.Ptr("value-1"),
// },
// {
// Name: to.Ptr("header-2"),
// Value: to.Ptr("value-2"),
// }},
// EndpointLocation: to.Ptr("North Europe"),
// EndpointMonitorStatus: to.Ptr(armtrafficmanager.EndpointMonitorStatusCheckingEndpoint),
// EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
// Priority: to.Ptr[int64](1),
// Target: to.Ptr("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
const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Create or update a Traffic Manager endpoint.
*
* @summary Create or update a Traffic Manager endpoint.
* x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithCustomHeaders.json
*/
async function endpointPutExternalWithCustomHeaders() {
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",
customHeaders: [
{ name: "header-1", value: "value-1" },
{ name: "header-2", value: "value-2" },
],
endpointLocation: "North Europe",
endpointStatus: "Enabled",
target: "foobar.contoso.com",
};
const credential = new DefaultAzureCredential();
const client = new TrafficManagerManagementClient(credential, subscriptionId);
const result = await client.endpoints.createOrUpdate(
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
using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.TrafficManager;
using Azure.ResourceManager.TrafficManager.Models;
// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithCustomHeaders.json
// this example is just showing the usage of "Endpoints_CreateOrUpdate" 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 TrafficManagerProfileResource created on azure
// for more information of creating TrafficManagerProfileResource, please refer to the document of TrafficManagerProfileResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1421";
string profileName = "azsmnet6386";
ResourceIdentifier trafficManagerProfileResourceId = TrafficManagerProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
TrafficManagerProfileResource trafficManagerProfile = client.GetTrafficManagerProfileResource(trafficManagerProfileResourceId);
// get the collection of this TrafficManagerEndpointResource
TrafficManagerEndpointCollection collection = trafficManagerProfile.GetTrafficManagerEndpoints();
// invoke the operation
string endpointType = "ExternalEndpoints";
string endpointName = "azsmnet7187";
TrafficManagerEndpointData data = new TrafficManagerEndpointData()
{
Target = "foobar.contoso.com",
EndpointStatus = TrafficManagerEndpointStatus.Enabled,
EndpointLocation = "North Europe",
CustomHeaders =
{
new TrafficManagerEndpointCustomHeaderInfo()
{
Name = "header-1",
Value = "value-1",
},new TrafficManagerEndpointCustomHeaderInfo()
{
Name = "header-2",
Value = "value-2",
}
},
Name = "azsmnet7187",
ResourceType = new ResourceType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
};
ArmOperation<TrafficManagerEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, endpointType, endpointName, data);
TrafficManagerEndpointResource result = lro.Value;
// 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
Sample Response
{
"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": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe",
"customHeaders": [
{
"name": "header-1",
"value": "value-1"
},
{
"name": "header-2",
"value": "value-2"
}
]
}
}
{
"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": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe",
"customHeaders": [
{
"name": "header-1",
"value": "value-1"
},
{
"name": "header-2",
"value": "value-2"
}
]
}
}
Endpoint-PUT-External-WithGeoMapping
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager8224/ExternalEndpoints/My%20external%20endpoint?api-version=2022-04-01
{
"name": "My external endpoint",
"type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
"properties": {
"target": "foobar.contoso.com",
"endpointStatus": "Enabled",
"geoMapping": [
"GEO-AS",
"GEO-AF"
]
}
}
import com.azure.resourcemanager.trafficmanager.fluent.models.EndpointInner;
import com.azure.resourcemanager.trafficmanager.models.EndpointStatus;
import com.azure.resourcemanager.trafficmanager.models.EndpointTypes;
import java.util.Arrays;
/** Samples for Endpoints CreateOrUpdate. */
public final class Main {
/*
* x-ms-original-file:
* specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-
* WithGeoMapping.json
*/
/**
* Sample code: Endpoint-PUT-External-WithGeoMapping.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void endpointPUTExternalWithGeoMapping(com.azure.resourcemanager.AzureResourceManager azure) {
azure.trafficManagerProfiles().manager().serviceClient().getEndpoints().createOrUpdateWithResponse(
"azuresdkfornetautoresttrafficmanager2191", "azuresdkfornetautoresttrafficmanager8224",
EndpointTypes.EXTERNAL_ENDPOINTS, "My%20external%20endpoint",
new EndpointInner().withName("My external endpoint")
.withType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints").withTarget("foobar.contoso.com")
.withEndpointStatus(EndpointStatus.ENABLED).withGeoMapping(Arrays.asList("GEO-AS", "GEO-AF")),
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-trafficmanager
# USAGE
python endpoint_put_external_with_geo_mapping.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.create_or_update(
resource_group_name="azuresdkfornetautoresttrafficmanager2191",
profile_name="azuresdkfornetautoresttrafficmanager8224",
endpoint_type="ExternalEndpoints",
endpoint_name="My%20external%20endpoint",
parameters={
"name": "My external endpoint",
"properties": {
"endpointStatus": "Enabled",
"geoMapping": ["GEO-AS", "GEO-AF"],
"target": "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-PUT-External-WithGeoMapping.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
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-PUT-External-WithGeoMapping.json
func ExampleEndpointsClient_CreateOrUpdate_endpointPutExternalWithGeoMapping() {
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().CreateOrUpdate(ctx, "azuresdkfornetautoresttrafficmanager2191", "azuresdkfornetautoresttrafficmanager8224", armtrafficmanager.EndpointTypeExternalEndpoints, "My%20external%20endpoint", armtrafficmanager.Endpoint{
Name: to.Ptr("My external endpoint"),
Type: to.Ptr("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
Properties: &armtrafficmanager.EndpointProperties{
EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
GeoMapping: []*string{
to.Ptr("GEO-AS"),
to.Ptr("GEO-AF")},
Target: to.Ptr("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("My external endpoint"),
// Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/externalEndpoints"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint"),
// Properties: &armtrafficmanager.EndpointProperties{
// EndpointMonitorStatus: to.Ptr(armtrafficmanager.EndpointMonitorStatusCheckingEndpoint),
// EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
// GeoMapping: []*string{
// to.Ptr("GEO-AS"),
// to.Ptr("GEO-AF")},
// Priority: to.Ptr[int64](1),
// Target: to.Ptr("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
const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Create or update a Traffic Manager endpoint.
*
* @summary Create or update a Traffic Manager endpoint.
* x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithGeoMapping.json
*/
async function endpointPutExternalWithGeoMapping() {
const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName =
process.env["TRAFFICMANAGER_RESOURCE_GROUP"] || "azuresdkfornetautoresttrafficmanager2191";
const profileName = "azuresdkfornetautoresttrafficmanager8224";
const endpointType = "ExternalEndpoints";
const endpointName = "My%20external%20endpoint";
const parameters = {
name: "My external endpoint",
type: "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
endpointStatus: "Enabled",
geoMapping: ["GEO-AS", "GEO-AF"],
target: "foobar.contoso.com",
};
const credential = new DefaultAzureCredential();
const client = new TrafficManagerManagementClient(credential, subscriptionId);
const result = await client.endpoints.createOrUpdate(
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
using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.TrafficManager;
using Azure.ResourceManager.TrafficManager.Models;
// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithGeoMapping.json
// this example is just showing the usage of "Endpoints_CreateOrUpdate" 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 TrafficManagerProfileResource created on azure
// for more information of creating TrafficManagerProfileResource, please refer to the document of TrafficManagerProfileResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager2191";
string profileName = "azuresdkfornetautoresttrafficmanager8224";
ResourceIdentifier trafficManagerProfileResourceId = TrafficManagerProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
TrafficManagerProfileResource trafficManagerProfile = client.GetTrafficManagerProfileResource(trafficManagerProfileResourceId);
// get the collection of this TrafficManagerEndpointResource
TrafficManagerEndpointCollection collection = trafficManagerProfile.GetTrafficManagerEndpoints();
// invoke the operation
string endpointType = "ExternalEndpoints";
string endpointName = "My%20external%20endpoint";
TrafficManagerEndpointData data = new TrafficManagerEndpointData()
{
Target = "foobar.contoso.com",
EndpointStatus = TrafficManagerEndpointStatus.Enabled,
GeoMapping =
{
"GEO-AS","GEO-AF"
},
Name = "My external endpoint",
ResourceType = new ResourceType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
};
ArmOperation<TrafficManagerEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, endpointType, endpointName, data);
TrafficManagerEndpointResource result = lro.Value;
// 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
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint",
"name": "My external endpoint",
"type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
"properties": {
"endpointStatus": "Enabled",
"endpointMonitorStatus": "CheckingEndpoint",
"target": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"geoMapping": [
"GEO-AS",
"GEO-AF"
]
}
}
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint",
"name": "My external endpoint",
"type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
"properties": {
"endpointStatus": "Enabled",
"endpointMonitorStatus": "CheckingEndpoint",
"target": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"geoMapping": [
"GEO-AS",
"GEO-AF"
]
}
}
Endpoint-PUT-External-WithLocation
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01
{
"name": "azsmnet7187",
"type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
"properties": {
"target": "foobar.contoso.com",
"endpointStatus": "Enabled",
"endpointLocation": "North Europe"
}
}
import com.azure.resourcemanager.trafficmanager.fluent.models.EndpointInner;
import com.azure.resourcemanager.trafficmanager.models.EndpointStatus;
import com.azure.resourcemanager.trafficmanager.models.EndpointTypes;
/** Samples for Endpoints CreateOrUpdate. */
public final class Main {
/*
* x-ms-original-file:
* specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-
* WithLocation.json
*/
/**
* Sample code: Endpoint-PUT-External-WithLocation.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void endpointPUTExternalWithLocation(com.azure.resourcemanager.AzureResourceManager azure) {
azure.trafficManagerProfiles().manager().serviceClient().getEndpoints().createOrUpdateWithResponse(
"azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", EndpointTypes.EXTERNAL_ENDPOINTS, "azsmnet7187",
new EndpointInner().withName("azsmnet7187")
.withType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints").withTarget("foobar.contoso.com")
.withEndpointStatus(EndpointStatus.ENABLED).withEndpointLocation("North Europe"),
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-trafficmanager
# USAGE
python endpoint_put_external_with_location.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.create_or_update(
resource_group_name="azuresdkfornetautoresttrafficmanager1421",
profile_name="azsmnet6386",
endpoint_type="ExternalEndpoints",
endpoint_name="azsmnet7187",
parameters={
"name": "azsmnet7187",
"properties": {
"endpointLocation": "North Europe",
"endpointStatus": "Enabled",
"target": "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-PUT-External-WithLocation.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
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-PUT-External-WithLocation.json
func ExampleEndpointsClient_CreateOrUpdate_endpointPutExternalWithLocation() {
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().CreateOrUpdate(ctx, "azuresdkfornetautoresttrafficmanager1421", "azsmnet6386", armtrafficmanager.EndpointTypeExternalEndpoints, "azsmnet7187", armtrafficmanager.Endpoint{
Name: to.Ptr("azsmnet7187"),
Type: to.Ptr("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
Properties: &armtrafficmanager.EndpointProperties{
EndpointLocation: to.Ptr("North Europe"),
EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
Target: to.Ptr("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("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
const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Create or update a Traffic Manager endpoint.
*
* @summary Create or update a Traffic Manager endpoint.
* x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithLocation.json
*/
async function endpointPutExternalWithLocation() {
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",
endpointLocation: "North Europe",
endpointStatus: "Enabled",
target: "foobar.contoso.com",
};
const credential = new DefaultAzureCredential();
const client = new TrafficManagerManagementClient(credential, subscriptionId);
const result = await client.endpoints.createOrUpdate(
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
using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.TrafficManager;
using Azure.ResourceManager.TrafficManager.Models;
// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithLocation.json
// this example is just showing the usage of "Endpoints_CreateOrUpdate" 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 TrafficManagerProfileResource created on azure
// for more information of creating TrafficManagerProfileResource, please refer to the document of TrafficManagerProfileResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager1421";
string profileName = "azsmnet6386";
ResourceIdentifier trafficManagerProfileResourceId = TrafficManagerProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
TrafficManagerProfileResource trafficManagerProfile = client.GetTrafficManagerProfileResource(trafficManagerProfileResourceId);
// get the collection of this TrafficManagerEndpointResource
TrafficManagerEndpointCollection collection = trafficManagerProfile.GetTrafficManagerEndpoints();
// invoke the operation
string endpointType = "ExternalEndpoints";
string endpointName = "azsmnet7187";
TrafficManagerEndpointData data = new TrafficManagerEndpointData()
{
Target = "foobar.contoso.com",
EndpointStatus = TrafficManagerEndpointStatus.Enabled,
EndpointLocation = "North Europe",
Name = "azsmnet7187",
ResourceType = new ResourceType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
};
ArmOperation<TrafficManagerEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, endpointType, endpointName, data);
TrafficManagerEndpointResource result = lro.Value;
// 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
Sample Response
{
"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": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe"
}
}
{
"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": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"endpointLocation": "North Europe"
}
}
Endpoint-PUT-External-WithSubnetMapping
Sample Request
PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager8224/ExternalEndpoints/My%20external%20endpoint?api-version=2022-04-01
{
"name": "My external endpoint",
"type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
"properties": {
"target": "foobar.contoso.com",
"endpointStatus": "Enabled",
"subnets": [
{
"first": "1.2.3.0",
"scope": 24
},
{
"first": "25.26.27.28",
"last": "29.30.31.32"
}
]
}
}
import com.azure.resourcemanager.trafficmanager.fluent.models.EndpointInner;
import com.azure.resourcemanager.trafficmanager.models.EndpointPropertiesSubnetsItem;
import com.azure.resourcemanager.trafficmanager.models.EndpointStatus;
import com.azure.resourcemanager.trafficmanager.models.EndpointTypes;
import java.util.Arrays;
/** Samples for Endpoints CreateOrUpdate. */
public final class Main {
/*
* x-ms-original-file:
* specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-
* WithSubnetMapping.json
*/
/**
* Sample code: Endpoint-PUT-External-WithSubnetMapping.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void endpointPUTExternalWithSubnetMapping(com.azure.resourcemanager.AzureResourceManager azure) {
azure.trafficManagerProfiles().manager().serviceClient().getEndpoints().createOrUpdateWithResponse(
"azuresdkfornetautoresttrafficmanager2191", "azuresdkfornetautoresttrafficmanager8224",
EndpointTypes.EXTERNAL_ENDPOINTS, "My%20external%20endpoint",
new EndpointInner().withName("My external endpoint")
.withType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints").withTarget("foobar.contoso.com")
.withEndpointStatus(EndpointStatus.ENABLED)
.withSubnets(Arrays.asList(new EndpointPropertiesSubnetsItem().withFirst("1.2.3.0").withScope(24),
new EndpointPropertiesSubnetsItem().withFirst("25.26.27.28").withLast("29.30.31.32"))),
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
from azure.identity import DefaultAzureCredential
from azure.mgmt.trafficmanager import TrafficManagerManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-trafficmanager
# USAGE
python endpoint_put_external_with_subnet_mapping.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.create_or_update(
resource_group_name="azuresdkfornetautoresttrafficmanager2191",
profile_name="azuresdkfornetautoresttrafficmanager8224",
endpoint_type="ExternalEndpoints",
endpoint_name="My%20external%20endpoint",
parameters={
"name": "My external endpoint",
"properties": {
"endpointStatus": "Enabled",
"subnets": [{"first": "1.2.3.0", "scope": 24}, {"first": "25.26.27.28", "last": "29.30.31.32"}],
"target": "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-PUT-External-WithSubnetMapping.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
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-PUT-External-WithSubnetMapping.json
func ExampleEndpointsClient_CreateOrUpdate_endpointPutExternalWithSubnetMapping() {
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().CreateOrUpdate(ctx, "azuresdkfornetautoresttrafficmanager2191", "azuresdkfornetautoresttrafficmanager8224", armtrafficmanager.EndpointTypeExternalEndpoints, "My%20external%20endpoint", armtrafficmanager.Endpoint{
Name: to.Ptr("My external endpoint"),
Type: to.Ptr("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
Properties: &armtrafficmanager.EndpointProperties{
EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
Subnets: []*armtrafficmanager.EndpointPropertiesSubnetsItem{
{
First: to.Ptr("1.2.3.0"),
Scope: to.Ptr[int32](24),
},
{
First: to.Ptr("25.26.27.28"),
Last: to.Ptr("29.30.31.32"),
}},
Target: to.Ptr("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("My external endpoint"),
// Type: to.Ptr("Microsoft.Network/trafficManagerProfiles/externalEndpoints"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint"),
// Properties: &armtrafficmanager.EndpointProperties{
// EndpointMonitorStatus: to.Ptr(armtrafficmanager.EndpointMonitorStatusCheckingEndpoint),
// EndpointStatus: to.Ptr(armtrafficmanager.EndpointStatusEnabled),
// Priority: to.Ptr[int64](1),
// Subnets: []*armtrafficmanager.EndpointPropertiesSubnetsItem{
// {
// First: to.Ptr("1.2.3.0"),
// Scope: to.Ptr[int32](24),
// },
// {
// First: to.Ptr("25.26.27.28"),
// Last: to.Ptr("29.30.31.32"),
// }},
// Target: to.Ptr("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
const { TrafficManagerManagementClient } = require("@azure/arm-trafficmanager");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Create or update a Traffic Manager endpoint.
*
* @summary Create or update a Traffic Manager endpoint.
* x-ms-original-file: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithSubnetMapping.json
*/
async function endpointPutExternalWithSubnetMapping() {
const subscriptionId = process.env["TRAFFICMANAGER_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName =
process.env["TRAFFICMANAGER_RESOURCE_GROUP"] || "azuresdkfornetautoresttrafficmanager2191";
const profileName = "azuresdkfornetautoresttrafficmanager8224";
const endpointType = "ExternalEndpoints";
const endpointName = "My%20external%20endpoint";
const parameters = {
name: "My external endpoint",
type: "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
endpointStatus: "Enabled",
subnets: [
{ first: "1.2.3.0", scope: 24 },
{ first: "25.26.27.28", last: "29.30.31.32" },
],
target: "foobar.contoso.com",
};
const credential = new DefaultAzureCredential();
const client = new TrafficManagerManagementClient(credential, subscriptionId);
const result = await client.endpoints.createOrUpdate(
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
using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.TrafficManager;
using Azure.ResourceManager.TrafficManager.Models;
// Generated from example definition: specification/trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/examples/Endpoint-PUT-External-WithSubnetMapping.json
// this example is just showing the usage of "Endpoints_CreateOrUpdate" 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 TrafficManagerProfileResource created on azure
// for more information of creating TrafficManagerProfileResource, please refer to the document of TrafficManagerProfileResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "azuresdkfornetautoresttrafficmanager2191";
string profileName = "azuresdkfornetautoresttrafficmanager8224";
ResourceIdentifier trafficManagerProfileResourceId = TrafficManagerProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
TrafficManagerProfileResource trafficManagerProfile = client.GetTrafficManagerProfileResource(trafficManagerProfileResourceId);
// get the collection of this TrafficManagerEndpointResource
TrafficManagerEndpointCollection collection = trafficManagerProfile.GetTrafficManagerEndpoints();
// invoke the operation
string endpointType = "ExternalEndpoints";
string endpointName = "My%20external%20endpoint";
TrafficManagerEndpointData data = new TrafficManagerEndpointData()
{
Target = "foobar.contoso.com",
EndpointStatus = TrafficManagerEndpointStatus.Enabled,
Subnets =
{
new TrafficManagerEndpointSubnetInfo()
{
First = IPAddress.Parse("1.2.3.0"),
Scope = 24,
},new TrafficManagerEndpointSubnetInfo()
{
First = IPAddress.Parse("25.26.27.28"),
Last = IPAddress.Parse("29.30.31.32"),
}
},
Name = "My external endpoint",
ResourceType = new ResourceType("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
};
ArmOperation<TrafficManagerEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, endpointType, endpointName, data);
TrafficManagerEndpointResource result = lro.Value;
// 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
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint",
"name": "My external endpoint",
"type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
"properties": {
"endpointStatus": "Enabled",
"endpointMonitorStatus": "CheckingEndpoint",
"target": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"subnets": [
{
"first": "1.2.3.0",
"scope": 24
},
{
"first": "25.26.27.28",
"last": "29.30.31.32"
}
]
}
}
{
"id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint",
"name": "My external endpoint",
"type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
"properties": {
"endpointStatus": "Enabled",
"endpointMonitorStatus": "CheckingEndpoint",
"target": "foobar.contoso.com",
"weight": 1,
"priority": 1,
"subnets": [
{
"first": "1.2.3.0",
"scope": 24
},
{
"first": "25.26.27.28",
"last": "29.30.31.32"
}
]
}
}
定義
AlwaysServe
如果已啟用 Always Serve，則會停用端點健全狀況的探查，並將端點包含在流量路由方法中。
| 名稱 |
類型 |
Description |
|
Disabled
|
string
|
|
|
Enabled
|
string
|
|
CloudError
Azure Resource Manager 傳回的錯誤
CloudErrorBody
Azure Resource Manager 傳回的錯誤內容
| 名稱 |
類型 |
Description |
|
code
|
string
|
錯誤碼
|
|
details
|
CloudErrorBody[]
|
錯誤詳細資料
|
|
message
|
string
|
錯誤訊息
|
|
target
|
string
|
錯誤目標
|
自定義標頭的清單。
| 名稱 |
類型 |
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
|
區塊大小 (子網掩碼中的前置位數目) 。
|