azure_rm_trafficmanagerendpoint_facts – Get Azure Traffic Manager endpoint facts¶
New in version 2.7.
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 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 |
|
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 |
|
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 endpoint.
|
|
|
password
-
|
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
-
/ required
|
Name of Traffic Manager Profile
|
|
|
resource_group
-
/ 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
-
|
|
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 logincommand.
Examples¶
- name: Get endpoints facts of a Traffic Manager profile
azure_rm_trafficmanagerendpoint_facts:
resource_group: myResourceGroup
profile_name: Testing
- name: Get specific endpoint of a Traffic Manager profile
azure_rm_trafficmanager_facts:
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
|
The status of the endpoint.
Sample:
Enabled
|
||
|
geo_mapping
list
|
The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
Sample:
['GEO-NA', 'GEO-AS']
|
||
|
location
string
|
The location of the external or nested endpoints when using the 'Performance' traffic routing method.
Sample:
East US
|
||
|
min_child_endpoints
integer
|
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
|
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
|
The fully-qualified DNS name of the endpoint.
Sample:
8.8.8.8
|
||
|
target_resource_id
string
|
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
|
The type of the endpoint.
Sample:
external_endpoints
|
||
|
weight
integer
|
The weight of this endpoint when using the 'Weighted' traffic routing method.
Sample:
10
|
||
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]