W3cubDocs

/Ansible 2.10

community.azure.azure_rm_trafficmanagerendpoint_facts – Get Azure Traffic Manager endpoint facts

Note

This plugin is part of the community.azure collection.

To install it use: ansible-galaxy collection install community.azure.

To use it in a playbook, specify: community.azure.azure_rm_trafficmanagerendpoint_facts.

Synopsis

  • Get facts for a specific Traffic Manager endpoints or all endpoints in a Traffic Manager profile.

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 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
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 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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 0.0.1 of azure.azcollection
    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 0.0.1 of azure.azcollection
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
string
Limit results to a specific Traffic Manager endpoint.
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.
profile_name
string / required
Name of Traffic Manager Profile.
resource_group
string / required
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.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
type
string
    Choices:
  • azure_endpoints
  • external_endpoints
  • nested_endpoints
Type of endpoint.

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 endpoints facts of a Traffic Manager profile
  community.azure.azure_rm_trafficmanagerendpoint_info:
    resource_group: myResourceGroup
    profile_name: Testing

- name: Get specific endpoint of a Traffic Manager profile
  azure_rm_trafficmanager_info:
    resource_group: myResourceGroup
    profile_name: Testing
    name: test_external_endpoint

Return Values

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

Key Returned Description
endpoints
complex
always
List of Traffic Manager endpoints.
enabled
string
always
The status of the endpoint.

Sample:
Enabled
geo_mapping
list / elements=string
always
The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.

Sample:
['GEO-NA', 'GEO-AS']
location
string
always
The location of the external or nested endpoints when using the 'Performance' traffic routing method.

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
Name of the Traffic Manager endpoint.

Sample:
testendpoint
priority
string
always
The priority of this endpoint when using the 'Priority' traffic routing method.

Sample:
3
resource_group
string
always
Name of a resource group.

Sample:
myResourceGroup
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/domainNames/vscjavaci
type
string
always
The type of the endpoint.

Sample:
external_endpoints
weight
integer
always
The weight of this endpoint when using the 'Weighted' traffic routing method.

Sample:
10


Authors

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_trafficmanagerendpoint_facts_module.html