Profile

Manages a Traffic Manager Profile to which multiple endpoints can be attached.

Deprecated: azure.trafficmanager.Profile has been deprecated in favor of azure.network.TrafficManagerProfile

Create a Profile Resource

new Profile(name: string, args: ProfileArgs, opts?: CustomResourceOptions);

def Profile(resource_name, opts=None, dns_config=None, monitor_config=None, name=None, profile_status=None, resource_group_name=None, tags=None, traffic_routing_method=None, __props__=None);

func NewProfile(ctx *Context, name string, args ProfileArgs, opts ...ResourceOption) (*Profile, error)

public Profile(string name, ProfileArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ProfileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Profile Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Profile resource accepts the following input properties:

DnsConfig ProfileDnsConfigArgs: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
MonitorConfig ProfileMonitorConfigArgs: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
ResourceGroupName string: The name of the resource group in which to create the Traffic Manager profile.
TrafficRoutingMethod string: Specifies the algorithm used to route traffic, possible values are:
Name string: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
ProfileStatus string: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

DnsConfig ProfileDnsConfig: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
MonitorConfig ProfileMonitorConfig: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
ResourceGroupName string: The name of the resource group in which to create the Traffic Manager profile.
TrafficRoutingMethod string: Specifies the algorithm used to route traffic, possible values are:
Name string: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
ProfileStatus string: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
Tags map[string]string: A mapping of tags to assign to the resource.

dnsConfig ProfileDnsConfig: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
monitorConfig ProfileMonitorConfig: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
resourceGroupName string: The name of the resource group in which to create the Traffic Manager profile.
trafficRoutingMethod string: Specifies the algorithm used to route traffic, possible values are:
name string: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
profileStatus string: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

dns_config Dict[ProfileDnsConfig]: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
monitor_config Dict[ProfileMonitorConfig]: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
resource_group_name str: The name of the resource group in which to create the Traffic Manager profile.
traffic_routing_method str: Specifies the algorithm used to route traffic, possible values are:
name str: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
profile_status str: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Profile resource produces the following output properties:

Fqdn string: The FQDN of the created Profile.
Id string: The provider-assigned unique ID for this managed resource.

Fqdn string: The FQDN of the created Profile.
Id string: The provider-assigned unique ID for this managed resource.

fqdn string: The FQDN of the created Profile.
id string: The provider-assigned unique ID for this managed resource.

fqdn str: The FQDN of the created Profile.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Profile Resource

Get an existing Profile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProfileState, opts?: CustomResourceOptions): Profile

static get(resource_name, id, opts=None, dns_config=None, fqdn=None, monitor_config=None, name=None, profile_status=None, resource_group_name=None, tags=None, traffic_routing_method=None, __props__=None);

func GetProfile(ctx *Context, name string, id IDInput, state *ProfileState, opts ...ResourceOption) (*Profile, error)

public static Profile Get(string name, Input<string> id, ProfileState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DnsConfig ProfileDnsConfigArgs: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
Fqdn string: The FQDN of the created Profile.
MonitorConfig ProfileMonitorConfigArgs: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
Name string: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
ProfileStatus string: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
ResourceGroupName string: The name of the resource group in which to create the Traffic Manager profile.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
TrafficRoutingMethod string: Specifies the algorithm used to route traffic, possible values are:

DnsConfig ProfileDnsConfig: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
Fqdn string: The FQDN of the created Profile.
MonitorConfig ProfileMonitorConfig: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
Name string: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
ProfileStatus string: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
ResourceGroupName string: The name of the resource group in which to create the Traffic Manager profile.
Tags map[string]string: A mapping of tags to assign to the resource.
TrafficRoutingMethod string: Specifies the algorithm used to route traffic, possible values are:

dnsConfig ProfileDnsConfig: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
fqdn string: The FQDN of the created Profile.
monitorConfig ProfileMonitorConfig: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
name string: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
profileStatus string: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
resourceGroupName string: The name of the resource group in which to create the Traffic Manager profile.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
trafficRoutingMethod string: Specifies the algorithm used to route traffic, possible values are:

dns_config Dict[ProfileDnsConfig]: This block specifies the DNS configuration of the Profile, it supports the fields documented below.
fqdn str: The FQDN of the created Profile.
monitor_config Dict[ProfileMonitorConfig]: This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
name str: The name of the Traffic Manager profile. Changing this forces a new resource to be created.
profile_status str: The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
resource_group_name str: The name of the resource group in which to create the Traffic Manager profile.
tags Dict[str, str]: A mapping of tags to assign to the resource.
traffic_routing_method str: Specifies the algorithm used to route traffic, possible values are:

Supporting Types

ProfileDnsConfig

See the input and output API doc for this type.

RelativeName string: The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
Ttl int: The TTL value of the Profile used by Local DNS resolvers and clients.

RelativeName string: The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
Ttl int: The TTL value of the Profile used by Local DNS resolvers and clients.

relativeName string: The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
ttl number: The TTL value of the Profile used by Local DNS resolvers and clients.

relativeName str: The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.
ttl float: The TTL value of the Profile used by Local DNS resolvers and clients.

ProfileMonitorConfig

See the input and output API doc for this type.

Port int: The port number used by the monitoring checks.
Protocol string: The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
CustomHeaders List<ProfileMonitorConfigCustomHeaderArgs>: One or more custom_header blocks as defined below.
ExpectedStatusCodeRanges List<string>: A list of status code ranges in the format of 100-101.
IntervalInSeconds int: The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
Path string: The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
TimeoutInSeconds int: The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
ToleratedNumberOfFailures int: The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

Port int: The port number used by the monitoring checks.
Protocol string: The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
CustomHeaders []ProfileMonitorConfigCustomHeader: One or more custom_header blocks as defined below.
ExpectedStatusCodeRanges []string: A list of status code ranges in the format of 100-101.
IntervalInSeconds int: The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
Path string: The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
TimeoutInSeconds int: The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
ToleratedNumberOfFailures int: The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

port number: The port number used by the monitoring checks.
protocol string: The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
customHeaders ProfileMonitorConfigCustomHeader[]: One or more custom_header blocks as defined below.
expectedStatusCodeRanges string[]: A list of status code ranges in the format of 100-101.
intervalInSeconds number: The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
path string: The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
timeoutInSeconds number: The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
toleratedNumberOfFailures number: The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

port float: The port number used by the monitoring checks.
protocol str: The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.
custom_headers List[ProfileMonitorConfigCustomHeader]: One or more custom_header blocks as defined below.
expectedStatusCodeRanges List[str]: A list of status code ranges in the format of 100-101.
interval_in_seconds float: The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.
path str: The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.
timeoutInSeconds float: The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If interval_in_seconds is set to 30, then timeout_in_seconds can be between 5 and 10. The default value is 10. If interval_in_seconds is set to 10, then valid values are between 5 and 9 and timeout_in_seconds is required.
toleratedNumberOfFailures float: The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

ProfileMonitorConfigCustomHeader

See the input and output API doc for this type.

Name string: The name of the custom header.
Value string: The value of custom header. Applicable for Http and Https protocol.

Name string: The name of the custom header.
Value string: The value of custom header. Applicable for Http and Https protocol.

name string: The name of the custom header.
value string: The value of custom header. Applicable for Http and Https protocol.

name str: The name of the custom header.
value str: The value of custom header. Applicable for Http and Https protocol.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Profile

Create a Profile Resource

Profile Resource Properties

Inputs

Outputs

Look up an Existing Profile Resource

Supporting Types

ProfileDnsConfig

ProfileMonitorConfig

ProfileMonitorConfigCustomHeader

Package Details

On This Page