azure_rm_trafficmanagerprofile - Manage Azure Traffic Manager profile.¶

New in version 2.7.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Create, update and delete a Traffic Manager profile.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
azure >= 2.0.0

Parameters ¶

Parameter		Choices/Defaults	Comments
ad_user			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url (added in 2.6)		Default: None	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile (added in 2.5)		Default: latest	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags bool		Choices: no yes ←	Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source (added in 2.5)		Choices: auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6.
cert_validation_mode (added in 2.5)		Choices: validate ignore	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id			Azure client ID. Use when authenticating with a Service Principal.
cloud_environment (added in 2.4)		Default: AzureCloud	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
dns_config			The DNS settings of the Traffic Manager profile.
	relative_name		The relative DNS name provided by this Traffic Manager profile. If not provided, name of the Traffic Manager will be used
	ttl	Default: 60	The DNS Time-To-Live (TTL), in seconds.
location		Default: global	Valid azure location. Defaults to 'global' because in default public Azure cloud, Traffic Manager profile can only be deployed globally. Reference https://docs.microsoft.com/en-us/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile
monitor_config		Default: {u'path': u'/', u'protocol': u'HTTP', u'port': 80}	The endpoint monitoring settings of the Traffic Manager profile.
	tolerated_failures		The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check.
	protocol	Choices: HTTP HTTPS TCP	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
	timeout		The monitor timeout for endpoints in this profile in seconds.
	path		The path relative to the endpoint domain name used to probe for endpoint health.
	interval		The monitor interval for endpoints in this profile in seconds.
	port		The TCP port used to probe for endpoint health.
name required			Name of the Traffic Manager profile.
password			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile			Security profile found in ~/.azure/credentials file.
profile_status		Choices: enabled ← disabled	The status of the Traffic Manager profile.
resource_group required			Name of a resource group where the Traffic Manager profile exists or will be created.
routing_method		Choices: performance ← priority weighted geographic	The traffic routing method of the Traffic Manager profile.
secret			Azure client secret. Use when authenticating with a Service Principal.
state		Choices: absent present ←	Assert the state of the Traffic Manager profile. Use `present` to create or update a Traffic Manager profile and `absent` to delete it.
subscription_id			Your Azure subscription Id.
tags			Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
tenant			Azure tenant ID. Use when authenticating with a Service Principal.

Notes ¶

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

Examples ¶

- name: Create a Traffic Manager Profile
  azure_rm_trafficmanager:
    name: tmtest
    resource_group: tmt
    location: global
    profile_status: enabled
    routing_method: priority
    dns_config:
      relative_name: tmtest
      ttl: 60
    monitor_config:
      protocol: HTTPS
      port: 80
      path: '/'
    tags:
      Environment: Test

- name: Delete a Traffic Manager Profile
  azure_rm_trafficmanager:
    state: absent
    name: tmtest
    resource_group: tmt

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
endpoints list	when traffic manager endpoints exists	List of endpoint IDs attached to the profile Sample: ['/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/externalEndpoints/e2', '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/externalEndpoints/e1']
id str	when traffic manager profile exists	The ID of the traffic manager profile

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Hai Cao <t-haicao@microsoft.com>
Yunge Zhu <yungez@microsoft.com>

Hint

If you notice any issues in this documentation you can edit this document to improve it.