Fork me on GitHub

Module trafficmanager

@pulumi/azure > trafficmanager

Index

trafficmanager/endpoint.ts trafficmanager/getGeographicalLocation.ts trafficmanager/profile.ts

class Endpoint

Manages a Traffic Manager Endpoint.

constructor

new Endpoint(name: string, args: EndpointArgs, opts?: pulumi.CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EndpointState): Endpoint

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endpointLocation

public endpointLocation: pulumi.Output<string>;

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.

property endpointMonitorStatus

public endpointMonitorStatus: pulumi.Output<string>;

property endpointStatus

public endpointStatus: pulumi.Output<string>;

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

property geoMappings

public geoMappings: pulumi.Output<string[] | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property minChildEndpoints

public minChildEndpoints: pulumi.Output<number | undefined>;

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.

property name

public name: pulumi.Output<string>;

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

property priority

public priority: pulumi.Output<number>;

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.

property profileName

public profileName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property target

public target: pulumi.Output<string>;

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.

property targetResourceId

public targetResourceId: pulumi.Output<string | undefined>;

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

property type

public type: pulumi.Output<string>;

The Endpoint type, must be one of:

  • azureEndpoints
  • externalEndpoints
  • nestedEndpoints

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property weight

public weight: pulumi.Output<number>;

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.

class Profile

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

constructor

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

Create a Profile resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dnsConfigs

public dnsConfigs: pulumi.Output<{ ... }[]>;

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

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the created Profile.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property monitorConfigs

public monitorConfigs: pulumi.Output<{ ... }[]>;

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

property name

public name: pulumi.Output<string>;

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

property profileStatus

public profileStatus: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property trafficRoutingMethod

public trafficRoutingMethod: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getGeographicalLocation

getGeographicalLocation(args: GetGeographicalLocationArgs, opts?: pulumi.InvokeOptions): Promise<GetGeographicalLocationResult>

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

interface EndpointArgs

The set of arguments for constructing a Endpoint resource.

property endpointLocation

endpointLocation?: pulumi.Input<string>;

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.

property endpointStatus

endpointStatus?: pulumi.Input<string>;

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

property geoMappings

geoMappings?: pulumi.Input<pulumi.Input<string>[]>;

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.

property minChildEndpoints

minChildEndpoints?: pulumi.Input<number>;

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.

property name

name?: pulumi.Input<string>;

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

property priority

priority?: pulumi.Input<number>;

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.

property profileName

profileName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property target

target?: pulumi.Input<string>;

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.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

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

property type

type: pulumi.Input<string>;

The Endpoint type, must be one of:

  • azureEndpoints
  • externalEndpoints
  • nestedEndpoints

property weight

weight?: pulumi.Input<number>;

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.

interface EndpointState

Input properties used for looking up and filtering Endpoint resources.

property endpointLocation

endpointLocation?: pulumi.Input<string>;

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.

property endpointMonitorStatus

endpointMonitorStatus?: pulumi.Input<string>;

property endpointStatus

endpointStatus?: pulumi.Input<string>;

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

property geoMappings

geoMappings?: pulumi.Input<pulumi.Input<string>[]>;

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.

property minChildEndpoints

minChildEndpoints?: pulumi.Input<number>;

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.

property name

name?: pulumi.Input<string>;

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

property priority

priority?: pulumi.Input<number>;

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.

property profileName

profileName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property target

target?: pulumi.Input<string>;

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.

property targetResourceId

targetResourceId?: pulumi.Input<string>;

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

property type

type?: pulumi.Input<string>;

The Endpoint type, must be one of:

  • azureEndpoints
  • externalEndpoints
  • nestedEndpoints

property weight

weight?: pulumi.Input<number>;

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.

interface GetGeographicalLocationArgs

A collection of arguments for invoking getGeographicalLocation.

property name

name: string;

Specifies the name of the Location, for example World, Europe or Germany.

interface GetGeographicalLocationResult

A collection of values returned by getGeographicalLocation.

property id

id: string;

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

interface ProfileArgs

The set of arguments for constructing a Profile resource.

property dnsConfigs

dnsConfigs: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property monitorConfigs

monitorConfigs: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property name

name?: pulumi.Input<string>;

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

property profileStatus

profileStatus?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property trafficRoutingMethod

trafficRoutingMethod: pulumi.Input<string>;

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.

interface ProfileState

Input properties used for looking up and filtering Profile resources.

property dnsConfigs

dnsConfigs?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the created Profile.

property monitorConfigs

monitorConfigs?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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

property name

name?: pulumi.Input<string>;

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

property profileStatus

profileStatus?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property trafficRoutingMethod

trafficRoutingMethod?: pulumi.Input<string>;

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.