community.azure.azure_rm_trafficmanagerprofile_info – Get Azure Traffic Manager profile facts
Note
This plugin is part of the community.azure collection (version 1.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_trafficmanagerprofile_info
.
DEPRECATED
- Removed in
version 2.0.0
- Why
The Ansible collection community.azure is deprecated. Use azure.azcollection instead.
- Alternative
Use azure.azcollection.azure_rm_trafficmanagerprofile_info instead.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
Limit results to a specific Traffic Manager profile. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The resource group to search for the desired Traffic Manager profile. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
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.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.
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 |
Description |
---|---|
List of Traffic Manager profiles. Returned: always |
|
The DNS settings of the Traffic Manager profile. Returned: always |
|
The fully-qualified domain name(FQDN) of the Traffic Manager profile. Returned: always Sample: “testTm.trafficmanager.net” |
|
The relative DNS name provided by the Traffic Manager profile. Returned: always Sample: “testTm” |
|
The DNS Time-To-Live(TTL), in seconds. Returned: always Sample: 60 |
|
The list of endpoints in the Traffic Manager profile. Returned: always |
|
The list of countries/regions mapped to this endpoint when the profile has routing_method Returned: always Sample: [“GEO-NA”, “GEO-AS”] |
|
Fully qualified resource ID for the resource. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1” |
|
The location of endpoints when type=external_endpoints or type=nested_endpoints, and profile routing_method=performance. Returned: always Sample: “East US” |
|
The minimum number of endpoints that must be available in the child profile to make the parent profile available. Returned: always Sample: 3 |
|
The name of the endpoint. Returned: always Sample: “e1” |
|
The priority of this endpoint when the profile has routing_method=priority. Returned: always Sample: 3 |
|
The status of the endpoint. Returned: always Sample: “Enabled” |
|
The fully-qualified DNS name of the endpoint. Returned: always Sample: “8.8.8.8” |
|
The Azure Resource URI of the of the endpoint. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom ainNames/vscjavaci” |
|
The type of the endpoint. Returned: always Sample: “external_endpoints” |
|
The weight of this endpoint when the profile has routing_method=weighted. Returned: always Sample: 10 |
|
Location of the Traffic Manager profile. Returned: always Sample: “global” |
|
The endpoint monitoring settings of the Traffic Manager profile. Returned: always |
|
The monitor interval for endpoints in this profile in seconds. Returned: always Sample: 10 |
|
The path relative to the endpoint domain name used to probe for endpoint health. Returned: always Sample: “/” |
|
The TCP port used to probe for endpoint health. Returned: always Sample: 80 |
|
The protocol Returned: always Sample: “HTTP” |
|
The monitor timeout for endpoints in this profile in seconds. Returned: always Sample: 30 |
|
The number of consecutive failed health check before declaring an endpoint Degraded after the next failed health check. Returned: always Sample: 3 |
|
Name of the Traffic Manager profile. Returned: always Sample: “testTm” |
|
The status of the Traffic Manager profile. Returned: always Sample: “Enabled” |
|
Name of a resource group where the Traffic Manager profile exists. Returned: always Sample: “testGroup” |
|
The traffic routing method of the Traffic Manager profile. Returned: always Sample: “performance” |
|
The state of the Traffic Manager profile. Returned: always Sample: “present” |
Status
This module will be removed in version 2.0.0. [deprecated]
For more information see DEPRECATED.
Authors
Hai Cao (@caohai)
Yunge Zhu (@yungezz)