Microsoft.Network (stable:2015-11-01)

2025/10/30 • 11 new, 11 deleted methods

Endpoints_Update (new)
Description :  Update a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint to be updated. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint to be updated. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint to be updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager endpoint parameters supplied to the Update operation. ,
Required: True ,
}
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
Endpoints_Get (new)
Description :  Gets a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint. ,
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 ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
Endpoints_CreateOrUpdate (new)
Description :  Create or update a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint to be created or updated. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint to be created or updated. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
Endpoints_Delete (new)
Description :  Deletes a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint to be deleted. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint to be deleted. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

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

⚼ Request

POST:  /providers/Microsoft.Network/checkTrafficManagerNameAvailability
{
parameters:
{
Description: The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
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 ,
}
Profiles_ListAllInResourceGroup (new)
Description :  Lists all Traffic Manager profiles within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profiles to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of Traffic manager profiles. ,
Required: False ,
}
[
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
]
,
}
Profiles_ListAll (new)
Description :  Lists all Traffic Manager profiles within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of Traffic manager profiles. ,
Required: False ,
}
[
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
]
,
}
Profiles_Get (new)
Description :  Gets a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
Profiles_CreateOrUpdate (new)
Description :  Create or update a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager profile parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
Profiles_Delete (new)
Description :  Deletes a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile to be deleted. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Profiles_Update (new)
Description :  Update a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager profile parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
Endpoints_Update (removed)
Description :  Update a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint to be updated. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint to be updated. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint to be updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager endpoint parameters supplied to the Update operation. ,
Required: True ,
}
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
Endpoints_Get (removed)
Description :  Gets a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint. ,
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 ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
Endpoints_CreateOrUpdate (removed)
Description :  Create or update a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint to be created or updated. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint to be created or updated. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint to be created or updated. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
Endpoints_Delete (removed)
Description :  Deletes a Traffic Manager endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager endpoint to be deleted. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
endpointType:
{
Description: The type of the Traffic Manager endpoint to be deleted. ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Traffic Manager endpoint to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

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

⚼ Request

POST:  /providers/Microsoft.Network/checkTrafficManagerNameAvailability
{
parameters:
{
Description: The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
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 ,
}
Profiles_ListAllInResourceGroup (removed)
Description :  Lists all Traffic Manager profiles within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profiles to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of Traffic manager profiles. ,
Required: False ,
}
[
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
]
,
}
Profiles_ListAll (removed)
Description :  Lists all Traffic Manager profiles within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of Traffic manager profiles. ,
Required: False ,
}
[
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
]
,
}
Profiles_Get (removed)
Description :  Gets a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
Profiles_CreateOrUpdate (removed)
Description :  Create or update a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager profile parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
Profiles_Delete (removed)
Description :  Deletes a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile to be deleted. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Profiles_Update (removed)
Description :  Update a Traffic Manager profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}
{
resourceGroupName:
{
Description: The name of the resource group containing the Traffic Manager profile. ,
Required: True ,
}
string ,
profileName:
{
Description: The name of the Traffic Manager profile. ,
Required: True ,
}
string ,
parameters:
{
Description: The Traffic Manager profile parameters supplied to the Update operation. ,
Required: True ,
}
{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class representing the Traffic Manager profile properties. ,
Required: False ,
}
{
profileStatus:
{
Description: Gets or sets the status of the Traffic Manager profile. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
trafficRoutingMethod:
{
Description: Gets or sets the traffic routing method of the Traffic Manager profile. Possible values are 'Performance', 'Weighted', or 'Priority'. ,
Required: False ,
}
string ,
dnsConfig:
{
Description: Gets or sets the DNS settings of the Traffic Manager profile. ,
Required: False ,
}
{
relativeName:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets 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: Gets or sets the endpoint monitoring settings of the Traffic Manager profile. ,
Required: False ,
}
{
profileMonitorStatus:
{
Description: Gets or sets the profile-level monitoring status of the Traffic Manager profile. ,
Required: False ,
}
string ,
protocol:
{
Description: Gets or sets the protocol (HTTP or HTTPS) used to probe for endpoint health. ,
Required: False ,
}
string ,
port:
{
Description: Gets or sets the TCP port used to probe for endpoint health. ,
Format: int64 ,
Required: False ,
}
integer ,
path:
{
Description: Gets or sets the path relative to the endpoint domain name used to probe for endpoint health. ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: Gets or sets the list of endpoints in the Traffic Manager profile. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ID of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the endpoint type of the Traffic Manager endpoint. ,
Required: False ,
}
string ,
properties:
{
Description: Class representing a Traffic Manager endpoint properties. ,
Required: False ,
}
{
targetResourceId:
{
Description: Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. ,
Required: False ,
}
string ,
target:
{
Description: Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. ,
Required: False ,
}
string ,
endpointStatus:
{
Description: Gets or sets the status of the endpoint.. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are 'Enabled' and 'Disabled'. ,
Required: False ,
}
string ,
weight:
{
Description: Gets or sets 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: Gets or sets 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: Gets or sets the monitoring status of the endpoint. ,
Required: False ,
}
string ,
minChildEndpoints:
{
Description: Gets or sets 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 ,
}
,
}
,
]
,
}
,
}