New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
ad_user |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
|
|
adfs_authority_url
(added in 2.6) |
Default: None
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
api_profile
(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
(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
(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 |
Azure client ID. Use when authenticating with a Service Principal.
|
|
cloud_environment
(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 |
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 |
Azure client secret. Use when authenticating with a Service Principal.
|
|
subscription_id |
Your Azure subscription Id.
|
|
tenant |
Azure tenant ID. Use when authenticating with a Service Principal.
|
|
type |
|
Type of endpoint.
|
Note
- name: Get endpoints facts of a Traffic Manager profile
azure_rm_trafficmanagerendpoint_facts:
resource_group: TestRG
profile_name: Testing
- name: Get specific endpoint of a Traffic Manager profie
azure_rm_trafficmanager_facts:
resource_group: TestRG
profile_name: Testing
name: test_external_endpoint
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.
|
|
resource_group
str
|
always |
Name of a resource group.
Sample:
testGroup
|
|
name
str
|
always |
Name of the Traffic Manager endpoint.
Sample:
testendpoint
|
|
type
str
|
The type of the endpoint.
Sample:
external_endpoints
|
||
target_resource_id
str
|
The Azure Resource URI of the of the endpoint.
Sample:
/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/vscjavaci/providers/Microsoft.ClassicCompute/domainNames/vscjavaci
|
||
target
str
|
The fully-qualified DNS name of the endpoint.
Sample:
8.8.8.8
|
||
enabled
str
|
The status of the endpoint.
Sample:
Enabled
|
||
weight
int
|
The weight of this endpoint when using the 'Weighted' traffic routing method.
Sample:
10
|
||
priority
str
|
The priority of this endpoint when using the 'Priority' traffic routing method.
Sample:
3
|
||
location
str
|
The location of the external or nested endpoints when using the 'Performance' traffic routing method.
Sample:
East US
|
||
min_child_endpoints
int
|
The minimum number of endpoints that must be available in the child profile to make the parent profile available.
Sample:
3
|
||
geo_mapping
list
|
The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method.
Sample:
['GEO-NA', 'GEO-AS']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.