trafficmanager

package
v0.19.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package trafficmanager exports types, functions, subpackages for provisioning trafficmanager resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-azurerm) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-azure` repo](https://github.com/pulumi/pulumi-azure/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-azurerm` repo](https://github.com/terraform-providers/terraform-provider-azurerm/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Endpoint 

type Endpoint struct {
	// contains filtered or unexported fields
}

Manages a Traffic Manager Endpoint.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/traffic_manager_endpoint.html.markdown.

func GetEndpoint 

func GetEndpoint(ctx *pulumi.Context,
	name string, id pulumi.ID, state *EndpointState, opts ...pulumi.ResourceOpt) (*Endpoint, error)

GetEndpoint gets an existing Endpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEndpoint 

func NewEndpoint(ctx *pulumi.Context,
	name string, args *EndpointArgs, opts ...pulumi.ResourceOpt) (*Endpoint, error)

NewEndpoint registers a new resource with the given unique name, arguments, and options.

func (*Endpoint) EndpointLocation 

func (r *Endpoint) EndpointLocation() *pulumi.StringOutput

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.

func (*Endpoint) EndpointMonitorStatus 

func (r *Endpoint) EndpointMonitorStatus() *pulumi.StringOutput

func (*Endpoint) EndpointStatus 

func (r *Endpoint) EndpointStatus() *pulumi.StringOutput

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

func (*Endpoint) GeoMappings 

func (r *Endpoint) GeoMappings() *pulumi.ArrayOutput

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](https://docs.microsoft.com/en-us/rest/api/trafficmanager/geographichierarchies/getdefault).

func (*Endpoint) ID 

func (r *Endpoint) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Endpoint) MinChildEndpoints 

func (r *Endpoint) MinChildEndpoints() *pulumi.IntOutput

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`.

func (*Endpoint) Name 

func (r *Endpoint) Name() *pulumi.StringOutput

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

func (*Endpoint) Priority 

func (r *Endpoint) Priority() *pulumi.IntOutput

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.

func (*Endpoint) ProfileName 

func (r *Endpoint) ProfileName() *pulumi.StringOutput

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

func (*Endpoint) ResourceGroupName 

func (r *Endpoint) ResourceGroupName() *pulumi.StringOutput

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

func (*Endpoint) Target 

func (r *Endpoint) Target() *pulumi.StringOutput

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.

func (*Endpoint) TargetResourceId 

func (r *Endpoint) TargetResourceId() *pulumi.StringOutput

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

func (*Endpoint) Type 

func (r *Endpoint) Type() *pulumi.StringOutput

The Endpoint type, must be one of: - `azureEndpoints` - `externalEndpoints` - `nestedEndpoints`

func (*Endpoint) URN 

func (r *Endpoint) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Endpoint) Weight 

func (r *Endpoint) Weight() *pulumi.IntOutput

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.

type EndpointArgs 

type EndpointArgs struct {
	// 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.
	EndpointLocation interface{}
	// The status of the Endpoint, can be set to
	// either `Enabled` or `Disabled`. Defaults to `Enabled`.
	EndpointStatus interface{}
	// 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](https://docs.microsoft.com/en-us/rest/api/trafficmanager/geographichierarchies/getdefault).
	GeoMappings interface{}
	// 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`.
	MinChildEndpoints interface{}
	// The name of the Traffic Manager endpoint. Changing this forces a
	// new resource to be created.
	Name interface{}
	// 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.
	Priority interface{}
	// The name of the Traffic Manager Profile to attach
	// create the Traffic Manager endpoint.
	ProfileName interface{}
	// The name of the resource group in which to
	// create the Traffic Manager endpoint.
	ResourceGroupName interface{}
	// 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 interface{}
	// The resource id of an Azure resource to
	// target. This argument must be provided for an endpoint of type
	// `azureEndpoints` or `nestedEndpoints`.
	TargetResourceId interface{}
	// The Endpoint type, must be one of:
	// - `azureEndpoints`
	// - `externalEndpoints`
	// - `nestedEndpoints`
	Type interface{}
	// 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.
	Weight interface{}
}

The set of arguments for constructing a Endpoint resource.

type EndpointState 

type EndpointState struct {
	// 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.
	EndpointLocation      interface{}
	EndpointMonitorStatus interface{}
	// The status of the Endpoint, can be set to
	// either `Enabled` or `Disabled`. Defaults to `Enabled`.
	EndpointStatus interface{}
	// 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](https://docs.microsoft.com/en-us/rest/api/trafficmanager/geographichierarchies/getdefault).
	GeoMappings interface{}
	// 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`.
	MinChildEndpoints interface{}
	// The name of the Traffic Manager endpoint. Changing this forces a
	// new resource to be created.
	Name interface{}
	// 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.
	Priority interface{}
	// The name of the Traffic Manager Profile to attach
	// create the Traffic Manager endpoint.
	ProfileName interface{}
	// The name of the resource group in which to
	// create the Traffic Manager endpoint.
	ResourceGroupName interface{}
	// 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 interface{}
	// The resource id of an Azure resource to
	// target. This argument must be provided for an endpoint of type
	// `azureEndpoints` or `nestedEndpoints`.
	TargetResourceId interface{}
	// The Endpoint type, must be one of:
	// - `azureEndpoints`
	// - `externalEndpoints`
	// - `nestedEndpoints`
	Type interface{}
	// 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.
	Weight interface{}
}

Input properties used for looking up and filtering Endpoint resources.

type GetGeographicalLocationArgs 

type GetGeographicalLocationArgs struct {
	// Specifies the name of the Location, for example `World`, `Europe` or `Germany`.
	Name interface{}
}

A collection of arguments for invoking getGeographicalLocation.

type GetGeographicalLocationResult added in v0.14.1 

type GetGeographicalLocationResult struct {
	Name interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getGeographicalLocation.

func LookupGeographicalLocation 

func LookupGeographicalLocation(ctx *pulumi.Context, args *GetGeographicalLocationArgs) (*GetGeographicalLocationResult, error)

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

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/traffic_manager_geographical_location.html.markdown.

type Profile 

type Profile struct {
	// contains filtered or unexported fields
}

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

## Notes

The Traffic Manager is created with the location `global`.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/traffic_manager_profile.html.markdown.

func GetProfile 

func GetProfile(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ProfileState, opts ...pulumi.ResourceOpt) (*Profile, error)

GetProfile gets an existing Profile resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewProfile 

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

NewProfile registers a new resource with the given unique name, arguments, and options.

func (*Profile) DnsConfigs 

func (r *Profile) DnsConfigs() *pulumi.ArrayOutput

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

func (*Profile) Fqdn 

func (r *Profile) Fqdn() *pulumi.StringOutput

The FQDN of the created Profile.

func (*Profile) ID 

func (r *Profile) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Profile) MonitorConfigs 

func (r *Profile) MonitorConfigs() *pulumi.ArrayOutput

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

func (*Profile) Name 

func (r *Profile) Name() *pulumi.StringOutput

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

func (*Profile) ProfileStatus 

func (r *Profile) ProfileStatus() *pulumi.StringOutput

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

func (*Profile) ResourceGroupName 

func (r *Profile) ResourceGroupName() *pulumi.StringOutput

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

func (*Profile) Tags 

func (r *Profile) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Profile) TrafficRoutingMethod 

func (r *Profile) TrafficRoutingMethod() *pulumi.StringOutput

Specifies the algorithm used to route traffic, possible values are: - `Geographic` - Traffic is routed based on Geographic regions specified in the Endpoint. - `MultiValue`- All healthy Endpoints are returned. MultiValue routing method works only if all the endpoints of type ‘External’ and are specified as IPv4 or IPv6 addresses. - `Performance` - Traffic is routed via the User's closest Endpoint - `Priority` - Traffic is routed to the Endpoint with the lowest `priority` value. - `Subnet` - Traffic is routed based on a mapping of sets of end-user IP address ranges to a specific Endpoint within a Traffic Manager profile. - `Weighted` - Traffic is spread across Endpoints proportional to their `weight` value.

func (*Profile) URN 

func (r *Profile) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ProfileArgs 

type ProfileArgs struct {
	// This block specifies the DNS configuration of the
	// Profile, it supports the fields documented below.
	DnsConfigs interface{}
	// This block specifies the Endpoint monitoring
	// configuration for the Profile, it supports the fields documented below.
	MonitorConfigs interface{}
	// The name of the virtual network. Changing this forces a
	// new resource to be created.
	Name interface{}
	// The status of the profile, can be set to either
	// `Enabled` or `Disabled`. Defaults to `Enabled`.
	ProfileStatus interface{}
	// The name of the resource group in which to
	// create the virtual network.
	ResourceGroupName interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// Specifies the algorithm used to route traffic, possible values are:
	// - `Geographic` - Traffic is routed based on Geographic regions specified in the Endpoint.
	// - `MultiValue`- All healthy Endpoints are returned.  MultiValue routing method works only if all the endpoints of type ‘External’ and are specified as IPv4 or IPv6 addresses.
	// - `Performance` - Traffic is routed via the User's closest Endpoint
	// - `Priority` - Traffic is routed to the Endpoint with the lowest `priority` value.
	// - `Subnet` - Traffic is routed based on a mapping of sets of end-user IP address ranges to a specific Endpoint within a Traffic Manager profile.
	// - `Weighted` - Traffic is spread across Endpoints proportional to their `weight` value.
	TrafficRoutingMethod interface{}
}

The set of arguments for constructing a Profile resource.

type ProfileState 

type ProfileState struct {
	// This block specifies the DNS configuration of the
	// Profile, it supports the fields documented below.
	DnsConfigs interface{}
	// The FQDN of the created Profile.
	Fqdn interface{}
	// This block specifies the Endpoint monitoring
	// configuration for the Profile, it supports the fields documented below.
	MonitorConfigs interface{}
	// The name of the virtual network. Changing this forces a
	// new resource to be created.
	Name interface{}
	// The status of the profile, can be set to either
	// `Enabled` or `Disabled`. Defaults to `Enabled`.
	ProfileStatus interface{}
	// The name of the resource group in which to
	// create the virtual network.
	ResourceGroupName interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// Specifies the algorithm used to route traffic, possible values are:
	// - `Geographic` - Traffic is routed based on Geographic regions specified in the Endpoint.
	// - `MultiValue`- All healthy Endpoints are returned.  MultiValue routing method works only if all the endpoints of type ‘External’ and are specified as IPv4 or IPv6 addresses.
	// - `Performance` - Traffic is routed via the User's closest Endpoint
	// - `Priority` - Traffic is routed to the Endpoint with the lowest `priority` value.
	// - `Subnet` - Traffic is routed based on a mapping of sets of end-user IP address ranges to a specific Endpoint within a Traffic Manager profile.
	// - `Weighted` - Traffic is spread across Endpoints proportional to their `weight` value.
	TrafficRoutingMethod interface{}
}

Input properties used for looking up and filtering Profile resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.