Try SpotterManage Azure Traffic Manager profile
| "added in version" 2.7 of ansible.builtin"
Authors: Hai Cao (@caohai), Yunge Zhu (@yungezz)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create, update and delete a Traffic Manager profile.
- name: Create a Traffic Manager Profile
azure_rm_trafficmanagerprofile:
name: tmtest
resource_group: myResourceGroup
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_trafficmanagerprofile:
state: absent
name: tmtest
resource_group: myResourceGroup
name:
description:
- Name of the Traffic Manager profile.
required: true
tags:
description:
- 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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Traffic Manager profile. Use C(present) to create or update
a Traffic Manager profile and C(absent) to delete it.
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
default: global
description:
- Valid Azure location. Defaults to C(global) because in default public Azure cloud,
Traffic Manager profile can only be deployed globally.
- Reference U(https://docs.microsoft.com/en-us/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile).
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
dns_config:
description:
- The DNS settings of the Traffic Manager profile.
suboptions:
relative_name:
description:
- The relative DNS name provided by this Traffic Manager profile.
- If not provided, name of the Traffic Manager will be used.
ttl:
default: 60
description:
- The DNS Time-To-Live (TTL), in seconds.
type: int
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- 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.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used
to identify the subscription ID if more than one is present otherwise the default
az cli subscription is used.
- When set to C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
monitor_config:
default:
path: /
port: 80
protocol: HTTP
description:
- The endpoint monitoring settings of the Traffic Manager profile.
suboptions:
interval:
description:
- The monitor interval for endpoints in this profile in seconds.
type: int
path:
description:
- The path relative to the endpoint domain name used to probe for endpoint health.
port:
description:
- The TCP port used to probe for endpoint health.
protocol:
choices:
- HTTP
- HTTPS
- TCP
description:
- The protocol C(HTTP), C(HTTPS) or C(TCP) used to probe for endpoint health.
timeout:
description:
- The monitor timeout for endpoints in this profile in seconds.
type: int
tolerated_failures:
description:
- The number of consecutive failed health check before declaring an endpoint in
this profile Degraded after the next failed health check.
profile_status:
choices:
- enabled
- disabled
default: enabled
description:
- The status of the Traffic Manager profile.
resource_group:
description:
- Name of a resource group where the Traffic Manager profile exists or will be created.
required: true
routing_method:
choices:
- performance
- priority
- weighted
- geographic
default: performance
description:
- The traffic routing method of the Traffic Manager profile.
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
endpoints:
description:
- List of endpoint IDs attached to the profile.
returned: when traffic manager endpoints exists
sample:
- /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter
nalEndpoints/e2
- /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter
nalEndpoints/e1
type: list
id:
description:
- The ID of the traffic manager profile.
returned: when traffic manager profile exists
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest
type: str