Microsoft.Network (stable:2022-04-01)

2025/11/12 • 9 updated methods

Profiles_CheckTrafficManagerRelativeDnsNameAvailability (updated)
Description :  Checks the availability of a Traffic Manager Relative DNS name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Profiles_CheckTrafficManagerRelativeDnsNameAvailability",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation."
      }
    }
  ]
}

⚼ Request

POST:  /providers/Microsoft.Network/checkTrafficManagerNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The relative name. ,
Required: False ,
}
string ,
type:
{
Description: Traffic Manager profile resource type. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Describes whether the relative name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available, when applicable. ,
Required: False ,
}
string ,
message:
{
Description: Descriptive message that explains why the name is not available, when applicable. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Profiles_checkTrafficManagerNameAvailabilityV2 (updated)
Description :  Checks the availability of a Traffic Manager Relative DNS name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Profiles_checkTrafficManagerNameAvailabilityV2",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation."
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/checkTrafficManagerNameAvailabilityV2
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The relative name. ,
Required: False ,
}
string ,
type:
{
Description: Traffic Manager profile resource type. ,
Required: False ,
}
string ,
nameAvailable:
{
Description: Describes whether the relative name is available or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available, when applicable. ,
Required: False ,
}
string ,
message:
{
Description: Descriptive message that explains why the name is not available, when applicable. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Profiles_ListBySubscription (updated)
Description :  Lists all Traffic Manager profiles within a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Profiles_ListBySubscription",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Profile list operation.",
        "old": "The list Traffic Manager profiles operation response."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Profile items on this page",
            "old": "Gets the list of Traffic manager profiles."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_acea1478fcf8424b8259275762767fa4": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Profile items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the Traffic Manager profile. ,
Required: False ,
}
{
profileStatus:
{
Description: The status of the Traffic Manager profile. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trafficRoutingMethod:
{
Description: The traffic routing method of the Traffic Manager profile. ,
Enum:
{
Performance: No description available. ,
Priority: No description available. ,
Weighted: No description available. ,
Geographic: No description available. ,
MultiValue: No description available. ,
Subnet: No description available. ,
}
,
Required: False ,
}
enum ,
dnsConfig:
{
Description: The DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: 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. ,
Required: False ,
}
string ,
fqdn:
{
Description: 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. ,
Required: False ,
}
string ,
ttl:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monitorConfig:
{
Description: The endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: The profile-level monitoring status of the Traffic Manager profile. ,
Enum:
{
CheckingEndpoints: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: The path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
intervalInSeconds:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutInSeconds:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
toleratedNumberOfFailures:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
expectedStatusCodeRanges:
{
Description: List of expected status code ranges. ,
Required: False ,
}
[
{
min:
{
Description: Min status code. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max status code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
endpoints:
{
Description: The list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
trafficViewEnrollmentStatus:
{
Description: 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowedEndpointRecordTypes:
{
Description: The list of allowed endpoint record types. ,
Required: False ,
}
[
string ,
]
,
maxReturn:
{
Description: Maximum number of endpoints to be returned for MultiValue routing type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Profiles_ListByResourceGroup (updated)
Description :  Lists all Traffic Manager profiles within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Profiles_ListByResourceGroup",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Profile list operation.",
        "old": "The list Traffic Manager profiles operation response."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Profile items on this page",
            "old": "Gets the list of Traffic manager profiles."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "@added_59d7ef95fbe746cba477883e6b3ab952": {
            "#name": "nextLink",
            "Description": "The link to the next page of items",
            "Format": "uri",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Profile items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the Traffic Manager profile. ,
Required: False ,
}
{
profileStatus:
{
Description: The status of the Traffic Manager profile. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
trafficRoutingMethod:
{
Description: The traffic routing method of the Traffic Manager profile. ,
Enum:
{
Performance: No description available. ,
Priority: No description available. ,
Weighted: No description available. ,
Geographic: No description available. ,
MultiValue: No description available. ,
Subnet: No description available. ,
}
,
Required: False ,
}
enum ,
dnsConfig:
{
Description: The DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: 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. ,
Required: False ,
}
string ,
fqdn:
{
Description: 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. ,
Required: False ,
}
string ,
ttl:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
monitorConfig:
{
Description: The endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: The profile-level monitoring status of the Traffic Manager profile. ,
Enum:
{
CheckingEndpoints: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. ,
Enum:
{
HTTP: No description available. ,
HTTPS: No description available. ,
TCP: No description available. ,
}
,
Required: False ,
}
enum ,
port:
{
Description: The TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: The path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
intervalInSeconds:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
timeoutInSeconds:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
toleratedNumberOfFailures:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
expectedStatusCodeRanges:
{
Description: List of expected status code ranges. ,
Required: False ,
}
[
{
min:
{
Description: Min status code. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: Max status code. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
endpoints:
{
Description: The list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
trafficViewEnrollmentStatus:
{
Description: 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. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowedEndpointRecordTypes:
{
Description: The list of allowed endpoint record types. ,
Required: False ,
}
[
string ,
]
,
maxReturn:
{
Description: Maximum number of endpoints to be returned for MultiValue routing type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Profiles_Delete (updated)
Description :  Deletes a Traffic Manager profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Profiles_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "The name of the Traffic Manager profile.",
        "old": "The name of the Traffic Manager profile to be deleted."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boolean:
{
Description: The result of the operation or request. ,
Required: False ,
}
boolean ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Endpoints_CreateOrUpdate (updated)
Description :  Create or update a Traffic Manager endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "endpointType",
      "Description": {
        "new": "The type of the Traffic Manager endpoint.",
        "old": "The type of the Traffic Manager endpoint to be created or updated."
      }
    },
    {
      "#name": "endpointName",
      "Description": {
        "new": "The name of the Traffic Manager endpoint.",
        "old": "The name of the Traffic Manager endpoint to be created or updated."
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Endpoints_Update (updated)
Description :  Update a Traffic Manager endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_Update",
  "$parameters": [
    {
      "#name": "endpointType",
      "Description": {
        "new": "The type of the Traffic Manager endpoint.",
        "old": "The type of the Traffic Manager endpoint to be updated."
      }
    },
    {
      "#name": "endpointName",
      "Description": {
        "new": "The name of the Traffic Manager endpoint.",
        "old": "The name of the Traffic Manager endpoint to be updated."
      }
    }
  ]
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager endpoint parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Traffic Manager endpoint. ,
Required: False ,
}
{
targetResourceId:
{
Description: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: 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. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
weight:
{
Description: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. ,
Format: int64 ,
Required: False ,
}
integer ,
priority:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
endpointLocation:
{
Description: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. ,
Required: False ,
}
string ,
endpointMonitorStatus:
{
Description: The monitoring status of the endpoint. ,
Enum:
{
CheckingEndpoint: No description available. ,
Online: No description available. ,
Degraded: No description available. ,
Disabled: No description available. ,
Inactive: No description available. ,
Stopped: No description available. ,
Unmonitored: No description available. ,
}
,
Required: False ,
}
enum ,
minChildEndpoints:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv4:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
minChildEndpointsIPv6:
{
Description: 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'. ,
Format: int64 ,
Required: False ,
}
integer ,
geoMapping:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
subnets:
{
Description: 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. ,
Required: False ,
}
[
{
first:
{
Description: First address in the subnet. ,
Required: False ,
}
string ,
last:
{
Description: Last address in the subnet. ,
Required: False ,
}
string ,
scope:
{
Description: Block size (number of leading bits in the subnet mask). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
customHeaders:
{
Description: List of custom headers. ,
Required: False ,
}
[
{
name:
{
Description: Header name. ,
Required: False ,
}
string ,
value:
{
Description: Header value. ,
Required: False ,
}
string ,
}
,
]
,
alwaysServe:
{
Description: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
Endpoints_Delete (updated)
Description :  Deletes a Traffic Manager endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_Delete",
  "$parameters": [
    {
      "#name": "endpointType",
      "Description": {
        "new": "The type of the Traffic Manager endpoint.",
        "old": "The type of the Traffic Manager endpoint to be deleted."
      }
    },
    {
      "#name": "endpointName",
      "Description": {
        "new": "The name of the Traffic Manager endpoint.",
        "old": "The name of the Traffic Manager endpoint to be deleted."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
boolean:
{
Description: The result of the operation or request. ,
Required: False ,
}
boolean ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}
HeatMap_Get (updated)
Description :  Gets latest heatmap for Traffic Manager profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HeatMap_Get",
  "$parameters": [
    {
      "#name": "heatMapType",
      "Description": {
        "new": "The type of the heatmap.",
        "old": "The type of HeatMap for the Traffic Manager profile."
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
heatMapType:
{
Description: The type of the heatmap. ,
Required: True ,
}
string ,
topLeft:
{
Description: The top left latitude,longitude pair of the rectangular viewport to query for. ,
Required: False ,
}
array ,
botRight:
{
Description: The bottom right latitude,longitude pair of the rectangular viewport to query for. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Traffic Manager HeatMap. ,
Required: False ,
}
{
startTime:
{
Description: The beginning of the time window for this HeatMap, inclusive. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The ending of the time window for this HeatMap, exclusive. ,
Format: date-time ,
Required: False ,
}
string ,
endpoints:
{
Description: The endpoints used in this HeatMap calculation. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ARM Resource ID of this Traffic Manager endpoint. ,
Required: False ,
}
string ,
endpointId:
{
Description: A number uniquely identifying this endpoint in query experiences. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
trafficFlows:
{
Description: The traffic flows produced in this HeatMap calculation. ,
Required: False ,
}
[
{
sourceIp:
{
Description: The IP address that this query experience originated from. ,
Required: False ,
}
string ,
latitude:
{
Description: The approximate latitude that these queries originated from. ,
Format: double ,
Required: False ,
}
number ,
longitude:
{
Description: The approximate longitude that these queries originated from. ,
Format: double ,
Required: False ,
}
number ,
queryExperiences:
{
Description: The query experiences produced in this HeatMap calculation. ,
Required: False ,
}
[
{
endpointId:
{
Description: The id of the endpoint from the 'endpoints' array which these queries were routed to. ,
Format: int32 ,
Required: True ,
}
integer ,
queryCount:
{
Description: The number of queries originating from this location. ,
Format: int32 ,
Required: True ,
}
integer ,
latency:
{
Description: The latency experienced by queries originating from this location. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The content of the error. ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message ,
Required: False ,
}
string ,
target:
{
Description: Error target ,
Required: False ,
}
string ,
details:
{
Description: Error details ,
Required: False ,
}
[
string ,
]
,
}
,
}