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
|
|
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.
|
enabled
boolean
|
|
The status of the endpoint.
|
geo_mapping
list
/ elements=string
|
|
The list of countries/regions mapped to this endpoint when traffic manager profile has routing_method of geographic .
|
location
string
|
|
Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
|
min_child_endpoints
integer
|
|
The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available.
Only applicable to endpoint of type=nested_endpoints.
|
name
string
/ required
|
|
The name of the endpoint.
|
password
string
|
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
priority
integer
|
|
The priority of this endpoint when traffic manager profile has routing_method of priority.
Possible values are from 1 to 1000, lower values represent higher priority.
This is an optional parameter. If specified, it must be specified on all endpoints.
No two endpoints can share the same priority value.
|
profile
string
|
|
Security profile found in ~/.azure/credentials file.
|
profile_name
string
/ required
|
|
Name of Traffic Manager profile where this endpoints attaches to.
|
resource_group
string
/ required
|
|
Name of a resource group where the Traffic Manager endpoint exists or will be created.
|
secret
string
|
|
Azure client secret. Use when authenticating with a Service Principal.
|
state
string
|
Choices:
- absent
present ←
|
Assert the state of the Traffic Manager endpoint. Use present to create or update a Traffic Manager endpoint and absent to delete it.
|
subscription_id
string
|
|
Your Azure subscription Id.
|
target
string
|
|
The fully-qualified DNS name of the endpoint.
|
target_resource_id
string
|
|
The Azure Resource URI of the of the endpoint.
Not applicable to endpoints of type=external_endpoints.
|
tenant
string
|
|
Azure tenant ID. Use when authenticating with a Service Principal.
|
type
string
/ required
|
Choices:
- azure_endpoints
- external_endpoints
- nested_endpoints
|
The type of the endpoint.
|
weight
integer
|
|
The weight of this endpoint when traffic manager profile has routing_method of weighted .
Possible values are from 1 to 1000.
|