Profiles - Update

Update a Traffic Manager profile.

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

URI Parameters

Name In Required Type Description
profileName
path True

string

The name of the Traffic Manager profile.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client Api Version.

Request Body

Name Type Description
id

string

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

location

string

The Azure Region where the resource lives

name

string

The name of the resource

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

The list of allowed endpoint record types.

properties.dnsConfig

DnsConfig

The DNS settings of the Traffic Manager profile.

properties.endpoints

Endpoint[]

The list of endpoints in the Traffic Manager profile.

properties.maxReturn

integer

Maximum number of endpoints to be returned for MultiValue routing type.

properties.monitorConfig

MonitorConfig

The endpoint monitoring settings of the Traffic Manager profile.

properties.profileStatus

ProfileStatus

The status of the Traffic Manager profile.

properties.trafficRoutingMethod

TrafficRoutingMethod

The traffic routing method of the Traffic Manager profile.

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.

tags

object

Resource tags.

type

string

The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

Responses

Name Type Description
200 OK

Profile

The updated Traffic Manager profile.

Other Status Codes

CloudError

Default response. It will be deserialized as per the Error definition.

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

Profile-PATCH-MonitorConfig

Sample request

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager6192?api-version=2022-04-01

{
  "properties": {
    "monitorConfig": {
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "timeoutInSeconds": 6,
      "toleratedNumberOfFailures": 4,
      "customHeaders": [
        {
          "name": "header-1",
          "value": "value-1"
        },
        {
          "name": "header-2",
          "value": "value-2"
        }
      ]
    }
  }
}

Sample response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192",
  "name": "azuresdkfornetautoresttrafficmanager6192",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager6192",
      "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 4,
      "timeoutInSeconds": 6,
      "customHeaders": [
        {
          "name": "header-1",
          "value": "value-1"
        },
        {
          "name": "header-2",
          "value": "value-2"
        }
      ]
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/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,
          "endpointLocation": "North Europe"
        }
      }
    ]
  }
}

Definitions

Name Description
AllowedEndpointRecordType

The allowed type DNS record types for this profile.

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

CustomHeaders

List of custom headers.

DnsConfig

Class containing DNS settings in a Traffic Manager profile.

Endpoint

Class representing a Traffic Manager endpoint.

EndpointMonitorStatus

The monitoring status of the endpoint.

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.

ExpectedStatusCodeRanges

List of expected status code ranges.

MonitorConfig

Class containing endpoint monitoring settings in a Traffic Manager profile.

MonitorProtocol

The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.

Profile

Class representing a Traffic Manager profile.

ProfileMonitorStatus

The profile-level monitoring status of the Traffic Manager profile.

ProfileStatus

The status of the Traffic Manager profile.

Subnets

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.

TrafficRoutingMethod

The traffic routing method of the Traffic Manager profile.

TrafficViewEnrollmentStatus

Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.

AllowedEndpointRecordType

The allowed type DNS record types for this profile.

Name Type Description
Any

string

DomainName

string

IPv4Address

string

IPv6Address

string

AlwaysServe

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

Name Type Description
Disabled

string

Enabled

string

CloudError

An error returned by the Azure Resource Manager

Name Type Description
error

CloudErrorBody

The content of the error.

CloudErrorBody

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

CustomHeaders

List of custom headers.

Name Type Description
name

string

Header name.

value

string

Header value.

DnsConfig

Class containing DNS settings in a Traffic Manager profile.

Name Type Description
fqdn

string

The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.

relativeName

string

The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.

ttl

integer

The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.

Endpoint

Class representing a Traffic Manager endpoint.

Name Type Description
id

string

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

CustomHeaders[]

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

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

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

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

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

Subnets[]

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

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

The monitoring status of the endpoint.

Name Type Description
CheckingEndpoint

string

Degraded

string

Disabled

string

Inactive

string

Online

string

Stopped

string

Unmonitored

string

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.

Name Type Description
Disabled

string

Enabled

string

ExpectedStatusCodeRanges

List of expected status code ranges.

Name Type Description
max

integer

Max status code.

min

integer

Min status code.

MonitorConfig

Class containing endpoint monitoring settings in a Traffic Manager profile.

Name Type Description
customHeaders

CustomHeaders[]

List of custom headers.

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

List of expected status code ranges.

intervalInSeconds

integer

The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.

path

string

The path relative to the endpoint domain name used to probe for endpoint health.

port

integer

The TCP port used to probe for endpoint health.

profileMonitorStatus

ProfileMonitorStatus

The profile-level monitoring status of the Traffic Manager profile.

protocol

MonitorProtocol

The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.

timeoutInSeconds

integer

The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.

toleratedNumberOfFailures

integer

The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

MonitorProtocol

The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.

Name Type Description
HTTP

string

HTTPS

string

TCP

string

Profile

Class representing a Traffic Manager profile.

Name Type Description
id

string

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

location

string

The Azure Region where the resource lives

name

string

The name of the resource

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

The list of allowed endpoint record types.

properties.dnsConfig

DnsConfig

The DNS settings of the Traffic Manager profile.

properties.endpoints

Endpoint[]

The list of endpoints in the Traffic Manager profile.

properties.maxReturn

integer

Maximum number of endpoints to be returned for MultiValue routing type.

properties.monitorConfig

MonitorConfig

The endpoint monitoring settings of the Traffic Manager profile.

properties.profileStatus

ProfileStatus

The status of the Traffic Manager profile.

properties.trafficRoutingMethod

TrafficRoutingMethod

The traffic routing method of the Traffic Manager profile.

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.

tags

object

Resource tags.

type

string

The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileMonitorStatus

The profile-level monitoring status of the Traffic Manager profile.

Name Type Description
CheckingEndpoints

string

Degraded

string

Disabled

string

Inactive

string

Online

string

ProfileStatus

The status of the Traffic Manager profile.

Name Type Description
Disabled

string

Enabled

string

Subnets

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.

Name Type Description
first

string

First address in the subnet.

last

string

Last address in the subnet.

scope

integer

Block size (number of leading bits in the subnet mask).

TrafficRoutingMethod

The traffic routing method of the Traffic Manager profile.

Name Type Description
Geographic

string

MultiValue

string

Performance

string

Priority

string

Subnet

string

Weighted

string

TrafficViewEnrollmentStatus

Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.

Name Type Description
Disabled

string

Enabled

string