azure_rm_trafficmanagerprofile_info – Get Azure Traffic Manager profile facts¶

New in version 2.9.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

Synopsis ¶

Get facts for a Azure specific Traffic Manager profile or all Traffic Manager profiles.

Aliases: azure_rm_trafficmanagerprofile_facts

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 string		Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 2.6		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string 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.
auth_source string 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 string added in 2.5	Choices: ignore validate	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 string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string 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.
name -		Limit results to a specific Traffic Manager profile.
password string		Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string		Security profile found in ~/.azure/credentials file.
resource_group -		The resource group to search for the desired Traffic Manager profile.
secret string		Azure client secret. Use when authenticating with a Service Principal.
subscription_id string		Your Azure subscription Id.
tags -		Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant string		Azure tenant ID. Use when authenticating with a Service Principal.

Notes ¶

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also 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: Get facts for one Traffic Manager profile
  azure_rm_trafficmanager_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all Traffic Manager profiles
  azure_rm_trafficmanager_info:

- name: Get facts by tags
  azure_rm_trafficmanager_info:
    tags:
      - Environment:Test

Return Values ¶

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

Key			Returned	Description
tms complex			always	List of Traffic Manager profiles.
	dns_config complex		always	The DNS settings of the Traffic Manager profile.
		fqdn string	always	The fully-qualified domain name(FQDN) of the Traffic Manager profile. Sample: testTm.trafficmanager.net
		relative_name string	always	The relative DNS name provided by the Traffic Manager profile. Sample: testTm
		ttl integer	always	The DNS Time-To-Live(TTL), in seconds. Sample: 60
	endpoints complex		always	The list of endpoints in the Traffic Manager profile.
		geo_mapping list	always	The list of countries/regions mapped to this endpoint when the profile has routing_method `geographic`. Sample: ['GEO-NA', 'GEO-AS']
		id string	always	Fully qualified resource ID for the resource. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1
		location string	always	The location of endpoints when type=external_endpoints or type=nested_endpoints, and profile routing_method=performance. Sample: East US
		min_child_endpoints integer	always	The minimum number of endpoints that must be available in the child profile to make the parent profile available. Sample: 3
		name string	always	The name of the endpoint. Sample: e1
		priority string	always	The priority of this endpoint when the profile has routing_method=priority. Sample: 3
		status string	always	The status of the endpoint. Sample: Enabled
		target string	always	The fully-qualified DNS name of the endpoint. Sample: 8.8.8.8
		target_resource_id string	always	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 string	always	The type of the endpoint. Sample: external_endpoints
		weight integer	always	The weight of this endpoint when the profile has routing_method=weighted. Sample: 10
	location string		always	Location of the Traffic Manager profile. Sample: global
	monitor_config complex		always	The endpoint monitoring settings of the Traffic Manager profile.
		interval integer	always	The monitor interval for endpoints in this profile in seconds. Sample: 10
		path string	always	The path relative to the endpoint domain name used to probe for endpoint health. Sample: /
		port integer	always	The TCP port used to probe for endpoint health. Sample: 80
		protocol string	always	The protocol `HTTP`, `HTTPS` or `TCP` used to probe for endpoint health. Sample: HTTP
		timeout integer	always	The monitor timeout for endpoints in this profile in seconds. Sample: 30
		tolerated_failures integer	always	The number of consecutive failed health check before declaring an endpoint Degraded after the next failed health check. Sample: 3
	name string		always	Name of the Traffic Manager profile. Sample: testTm
	profile_status string		always	The status of the Traffic Manager profile. Sample: Enabled
	resource_group string		always	Name of a resource group where the Traffic Manager profile exists. Sample: testGroup
	routing_method string		always	The traffic routing method of the Traffic Manager profile. Sample: performance
	state string		always	The state of the Traffic Manager profile. Sample: present

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Hai Cao (@caohai)
Yunge Zhu (@yungezz)

Hint

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