Try SpotterManage a Traffic Manager profile.
| "added in version" 2.7 of azure.azcollection"
Authors: Hai Cao <t-haicao@microsoft.com>
preview | supported by community
Install with ansible-galaxy collection install azure.azcollection:==0.3.0
collections:
- name: azure.azcollection
version: 0.3.0Create, update and delete a Traffic Manager profile.
- name: Create a Traffic Manager Profile
azure_rm_trafficmanager:
name: tmtest
resource_group: tmt
location: global
profile_status: Enabled
traffic_routing_method: Priority
dns_config:
relative_name: tmtest
ttl: 60
monitor_config:
protocol: HTTPS
port: 80
path: '/'
endpoints:
- name: e1
type: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints
endpoint_location: West US 2
endpoint_status: Enabled
priority: 2
target: 1.2.3.4
weight: 1
tags:
Environment: Test
- name: Delete a Traffic Manager Profile
azure_rm_trafficmanager:
state: absent
name: tmtest
resource_group: tmt
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:
description:
- Valid azure location. Defaults to 'global'.
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
endpoints:
description:
- The list of endpoints in the Traffic Manager profile.
suboptions:
endpoint_location:
description:
- Specifies the location of the external or nested endpoints when using the 'Performance'
traffic routing method.
endpoint_status:
choices:
- Enabled
- Disabled
description:
- The status of the endpoint.
geo_mapping:
description:
- The list of countries/regions mapped to this endpoint when using the 'Geographic'
traffic routing method.
id:
description:
- Fully qualified resource Id for the resource.
min_child_endpoints:
description:
- The minimum number of endpoints that must be available in the child profile
in order for the parent profile to be considered available.
- Only applicable to endpoint of type 'NestedEndpoints'.
name:
description:
- The name of the endpoint.
required: true
priority:
description:
- The priority of this endpoint when using the 'Priority' traffic routing method.
- Possible values are from 1 to 1000, lower values represent higher priority.
- This is an optional parameter. If specified, it must be specified on all endpoints.
- No two endpoints can share the same priority value.
target:
description:
- The fully-qualified DNS name of the endpoint.
target_resource_id:
description:
- The Azure Resource URI of the of the endpoint.
- Not applicable to endpoints of type 'ExternalEndpoints'.
type:
description:
- The type of the endpoint. Ex- Microsoft.network/TrafficManagerProfiles/ExternalEndpoints.
required: true
weight:
description:
- The weight of this endpoint when using the 'Weighted' traffic routing method.
- Possible values are from 1 to 1000.
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 no provided, name of the Traffic Manager will be used
ttl:
default: 60
description:
- The DNS Time-To-Live (TTL), in seconds.
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: '2.5'
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
description:
- 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 C(auto) if variable is not defined.
- C(auto) will follow the default precedence of module parameters -> environment variables
-> default profile in credential file C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the default Azure CLI profile.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- 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: '2.5'
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_in_seconds:
description:
- The monitor interval for endpoints in this profile.
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 (HTTP, HTTPS or TCP) used to probe for endpoint health.
timeout_in_seconds:
description:
- The monitor timeout for endpoints in this profile.
tolerated_number_of_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
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: '2.4'
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: '2.6'
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: '2.5'
version_added_collection: azure.azcollection
traffic_routing_method:
choices:
- Performance
- Priority
- Weighted
- Geographic
default: Performance
description:
- The traffic routing method of the Traffic Manager profile.
state:
description: Current state of the Traffic Manager Profile
example:
dns_config:
fqdn: tmtest.trafficmanager.net
relative_name: tmtest
ttl: 60
endpoints:
- endpoint_location: West US 2
endpoint_monitor_status: Degraded
endpoint_status: Enabled
geo_mapping: null
id: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1
min_child_endpoints: null
name: e1
priority: 2
target: 1.2.3.4
target_resource_id: null
type: Microsoft.Network/trafficManagerProfiles/externalEndpoints
weight: 1
id: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest
location: global
monitor_config:
interval_in_seconds: 30
path: /
port: 80
profile_monitor_status: Degraded
protocol: HTTPS
timeout_in_seconds: 10
tolerated_number_of_failures: 3
name: tmtest
profile_status: Enabled
tags:
Environment: Test
traffic_routing_method: Priority
type: Microsoft.Network/trafficManagerProfiles
returned: always
type: dict