Endpoints - Update

Service:: Traffic Manager

API Version:: 2022-04-01

Update a Traffic Manager endpoint.

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

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	The name of the Traffic Manager endpoint.
endpointType	path	True	EndpointType	The type of the Traffic Manager endpoint.
profileName	path	True	string	The name of the Traffic Manager profile.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
id	string (arm-id)	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	The name of the resource
properties.alwaysServe	AlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
properties.customHeaders	EndpointPropertiesCustomHeadersItem[]	List of custom headers.
properties.endpointLocation	string	Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
properties.endpointMonitorStatus	EndpointMonitorStatus	The monitoring status of the endpoint.
properties.endpointStatus	EndpointStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
properties.geoMapping	string[]	The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
properties.minChildEndpoints	integer (int64)	The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
properties.minChildEndpointsIPv4	integer (int64)	The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
properties.minChildEndpointsIPv6	integer (int64)	The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
properties.priority	integer (int64)	The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
properties.subnets	EndpointPropertiesSubnetsItem[]	The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.
properties.target	string	The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
properties.targetResourceId	string	The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
properties.weight	integer (int64)	The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

Responses

Name	Type	Description
200 OK	Endpoint	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Endpoint-PATCH-External-Target

Sample request

HTTP

PATCH 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",
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "properties": {
    "target": "another.foobar.contoso.com"
  }
}

Sample response

Status code:: 200

{
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "properties": {
    "endpointLocation": "North Europe",
    "endpointMonitorStatus": "CheckingEndpoint",
    "endpointStatus": "Enabled",
    "priority": 1,
    "target": "another.foobar.contoso.com",
    "weight": 1
  }
}

Definitions

Name	Description
AlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
CloudError	An error returned by the Azure Resource Manager
CloudErrorBody	The content of an error returned by the Azure Resource Manager
Endpoint	Class representing a Traffic Manager endpoint.
EndpointMonitorStatus	The monitoring status of the endpoint.
EndpointPropertiesCustomHeadersItem	Custom header name and value.
EndpointPropertiesSubnetsItem	Subnet first address, scope, and/or last address.
EndpointStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
EndpointType	The type of the Traffic Manager endpoint.

AlwaysServe

Enumeration

If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.

Value	Description
Enabled
Disabled

CloudError

Object

An error returned by the Azure Resource Manager

Name	Type	Description
error	CloudErrorBody	The content of the error.

CloudErrorBody

Object

The content of an error returned by the Azure Resource Manager

Name	Type	Description
code	string	Error code
details	CloudErrorBody[]	Error details
message	string	Error message
target	string	Error target

Endpoint

Object

Class representing a Traffic Manager endpoint.

Name	Type	Description
id	string (arm-id)	Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	The name of the resource
properties.alwaysServe	AlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
properties.customHeaders	EndpointPropertiesCustomHeadersItem[]	List of custom headers.
properties.endpointLocation	string	Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
properties.endpointMonitorStatus	EndpointMonitorStatus	The monitoring status of the endpoint.
properties.endpointStatus	EndpointStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
properties.geoMapping	string[]	The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
properties.minChildEndpoints	integer (int64)	The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
properties.minChildEndpointsIPv4	integer (int64)	The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
properties.minChildEndpointsIPv6	integer (int64)	The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
properties.priority	integer (int64)	The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
properties.subnets	EndpointPropertiesSubnetsItem[]	The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.
properties.target	string	The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
properties.targetResourceId	string	The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
properties.weight	integer (int64)	The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Enumeration

The monitoring status of the endpoint.

Value	Description
CheckingEndpoint
Online
Degraded
Disabled
Inactive
Stopped
Unmonitored

EndpointPropertiesCustomHeadersItem

Object

Custom header name and value.

Name	Type	Description
name	string	Header name.
value	string	Header value.

EndpointPropertiesSubnetsItem

Object

Subnet first address, scope, and/or last address.

Name	Type	Description
first	string	First address in the subnet.
last	string	Last address in the subnet.
scope	integer (int32)	Block size (number of leading bits in the subnet mask).

EndpointStatus

Enumeration

The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.

Value	Description
Enabled
Disabled

EndpointType

Enumeration

The type of the Traffic Manager endpoint.

Value	Description
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Share via

Endpoints - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Endpoint-PATCH-External-Target

Sample request

Sample response

Definitions

AlwaysServe

CloudError

CloudErrorBody

Endpoint

EndpointMonitorStatus

EndpointPropertiesCustomHeadersItem

EndpointPropertiesSubnetsItem

EndpointStatus

EndpointType