Edit This Page

trafficmanager

class pulumi_azure.trafficmanager.Endpoint(resource_name, opts=None, endpoint_location=None, endpoint_status=None, geo_mappings=None, min_child_endpoints=None, name=None, priority=None, profile_name=None, resource_group_name=None, target=None, target_resource_id=None, type=None, weight=None, __name__=None, __opts__=None)

Manages a Traffic Manager Endpoint.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • endpoint_location (pulumi.Input[str]) – Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method if the Endpoint is of either type nestedEndpoints or externalEndpoints. For Endpoints of type azureEndpoints the value will be taken from the location of the Azure target resource.
  • endpoint_status (pulumi.Input[str]) – The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
  • geo_mappings (pulumi.Input[list]) – A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can’t be specified in two endpoints. See the Geographic Hierarchies documentation for more information.
  • min_child_endpoints (pulumi.Input[int]) – This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
  • name (pulumi.Input[str]) – The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.
  • priority (pulumi.Input[int]) – Specifies the priority of this Endpoint, this must be specified for Profiles using the Priority traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.
  • profile_name (pulumi.Input[str]) – The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Traffic Manager endpoint.
  • target (pulumi.Input[str]) – The FQDN DNS name of the target. This argument must be provided for an endpoint of type externalEndpoints, for other types it will be computed.
  • target_resource_id (pulumi.Input[str]) – The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
  • type (pulumi.Input[str]) – The Endpoint type, must be one of:
Parameters:weight (pulumi.Input[int]) – Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Supports values between 1 and 1000.
endpoint_location = None

Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method if the Endpoint is of either type nestedEndpoints or externalEndpoints. For Endpoints of type azureEndpoints the value will be taken from the location of the Azure target resource.

endpoint_status = None

The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.

geo_mappings = None

A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can’t be specified in two endpoints. See the Geographic Hierarchies documentation for more information.

min_child_endpoints = None

This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and defaults to 1.

name = None

The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.

priority = None

Specifies the priority of this Endpoint, this must be specified for Profiles using the Priority traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.

profile_name = None

The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.

resource_group_name = None

The name of the resource group in which to create the Traffic Manager endpoint.

target = None

The FQDN DNS name of the target. This argument must be provided for an endpoint of type externalEndpoints, for other types it will be computed.

target_resource_id = None

The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.

type = None

The Endpoint type, must be one of:

  • azureEndpoints
  • externalEndpoints
  • nestedEndpoints
weight = None

Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Supports values between 1 and 1000.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_azure.trafficmanager.GetGeographicalLocationResult(id=None)

A collection of values returned by getGeographicalLocation.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.trafficmanager.Profile(resource_name, opts=None, dns_configs=None, monitor_configs=None, name=None, profile_status=None, resource_group_name=None, tags=None, traffic_routing_method=None, __name__=None, __opts__=None)

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

The Traffic Manager is created with the location global.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • dns_configs (pulumi.Input[list]) – This block specifies the DNS configuration of the Profile, it supports the fields documented below.
  • monitor_configs (pulumi.Input[list]) – This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.
  • name (pulumi.Input[str]) – The name of the virtual network. Changing this forces a new resource to be created.
  • profile_status (pulumi.Input[str]) – The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.
  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the virtual network.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • traffic_routing_method (pulumi.Input[str]) – Specifies the algorithm used to route traffic, possible values are:
dns_configs = None

This block specifies the DNS configuration of the Profile, it supports the fields documented below.

fqdn = None

The FQDN of the created Profile.

monitor_configs = None

This block specifies the Endpoint monitoring configuration for the Profile, it supports the fields documented below.

name = None

The name of the virtual network. Changing this forces a new resource to be created.

profile_status = None

The status of the profile, can be set to either Enabled or Disabled. Defaults to Enabled.

resource_group_name = None

The name of the resource group in which to create the virtual network.

tags = None

A mapping of tags to assign to the resource.

traffic_routing_method = None

Specifies the algorithm used to route traffic, possible values are:

  • Geographic - Traffic is routed based on Geographic regions specified in the Endpoint.
  • Performance - Traffic is routed via the User’s closest Endpoint
  • Weighted - Traffic is spread across Endpoints proportional to their weight value.
  • Priority - Traffic is routed to the Endpoint with the lowest priority value.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_azure.trafficmanager.get_geographical_location(name=None)

Use this data source to access the ID of a specified Traffic Manager Geographical Location within the Geographical Hierarchy.