Try SpotterGet Azure Traffic Manager profile facts
| "added in version" 2.7 of ansible.builtin"
Authors: Hai Cao (@caohai) <t-haicao@microsoft.com>, Yunge Zhu (@yungezz) <yungez@microsoft.com>
preview | supported by community
pipInstall with pip install ansible==2.8.19
Get facts for a Azure specific Traffic Manager profile or all Traffic Manager profiles.
- name: Get facts for one Traffic Manager profile
azure_rm_trafficmanager_facts:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all Traffic Manager profiles
azure_rm_trafficmanager_facts:
- name: Get facts by tags
azure_rm_trafficmanager_facts:
tags:
- Environment:Test
name:
description:
- Limit results to a specific Traffic Manager profile.
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
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
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
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
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
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
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
resource_group:
description:
- The resource group to search for the desired 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
x509_certificate_path:
description:
- Path to the X509 certificate used to create the service principal in PEM format.
- The certificate must be appended to the private key.
- Use when authenticating with a Service Principal.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
tms:
contains:
dns_config:
description:
- The DNS settings of the Traffic Manager profile.
sample:
fqdn: testTm.trafficmanager.net
relative_name: testTm
ttl: 60
type: complex
endpoints:
contains:
geo_mapping:
description:
- The list of countries/regions mapped to this endpoint when the profile
has routing_method C(geographic).
sample:
- GEO-NA
- GEO-AS
type: list
id:
description:
- Fully qualified resource Id for the resource.
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan
agerProfiles/tmtest/externalEndpoints/e1
type: str
location:
description:
- The location of endpoints when type is C(external_endpoints) or C(nested_endpoints),
and profile routing_method is (performance).
sample: East US
type: str
min_child_endpoints:
description:
- The minimum number of endpoints that must be available in the child profile
to make the parent profile available.
sample: 3
type: int
name:
description:
- The name of the endpoint.
sample: e1
type: str
priority:
description:
- The priority of this endpoint when the profile has routing_method C(priority).
sample: 3
type: str
status:
description:
- The status of the endpoint.
sample: Enabled
type: str
target:
description:
- The fully-qualified DNS name of the endpoint.
sample: 8.8.8.8
type: str
target_resource_id:
description:
- The Azure Resource URI of the of the endpoint.
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom
ainNames/vscjavaci
type: str
type:
description:
- The type of the endpoint.
sample: external_endpoints
type: str
weight:
description:
- The weight of this endpoint when the profile has routing_method C(weighted).
sample: 10
type: int
description:
- The list of endpoints in the Traffic Manager profile.
element: complex
type: list
location:
description:
- Location of the Traffic Manager profile.
sample: global
type: str
monitor_config:
contains:
interval:
description:
- The monitor interval for endpoints in this profile in seconds.
sample: 10
type: int
path:
description:
- The path relative to the endpoint domain name used to probe for endpoint
health.
sample: /
type: str
port:
description:
- The TCP port used to probe for endpoint health.
sample: 80
type: int
protocol:
description:
- The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
sample: HTTP
type: str
timeout:
description:
- The monitor timeout for endpoints in this profile in seconds.
sample: 30
type: int
tolerated_failures:
description:
- The number of consecutive failed health check before declaring an endpoint
Degraded after the next failed health check.
sample: 3
type: int
description:
- The endpoint monitoring settings of the Traffic Manager profile.
type: complex
name:
description:
- Name of the Traffic Manager profile.
returned: always
sample: testTm
type: str
profile_status:
description:
- The status of the Traffic Manager profile.
sample: Enabled
type: str
resource_group:
description:
- Name of a resource group where the Traffic Manager profile exists.
returned: always
sample: testGroup
type: str
routing_method:
description:
- The traffic routing method of the Traffic Manager profile.
sample: performance
type: str
state:
description:
- The state of the Traffic Manager profile.
sample: present
type: str
description: List of Traffic Manager profiles.
returned: always
type: complex