azure.azcollection.azure_rm_trafficmanagerendpoint module – Manage Azure Traffic Manager endpoint

Note

This module is part of the azure.azcollection collection (version 1.14.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 azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_trafficmanagerendpoint.

New in azure.azcollection 0.1.2

Synopsis

  • Create, update and delete Azure Traffic Manager endpoint.

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

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

enabled

boolean

The status of the endpoint.

Choices:

  • false

  • true ← (default)

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.

log_mode

string

Parent argument.

log_path

string

Parent argument.

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

Assert the state of the Traffic Manager endpoint. Use present to create or update a Traffic Manager endpoint and absent to delete it.

Choices:

  • "absent"

  • "present" ← (default)

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.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

type

string / required

The type of the endpoint.

Choices:

  • "azure_endpoints"

  • "external_endpoints"

  • "nested_endpoints"

weight

integer

The weight of this endpoint when traffic manager profile has routing_method of weighted.

Possible values are from 1 to 1000.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

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: create a endpoint for a traffic manager profile
  azure_rm_trafficmanagerendpoint:
      resource_group: testresourcegroup
      profile_name: myprofilename
      name: testendpoint1
      type: external_endpoints
      location: westus
      priority: 2
      weight: 1
      target: 1.2.3.4

Return Values

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

Key

Description

id

string

The ID of the traffic manager endpoint.

Returned: when traffic manager endpoint exists

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/testProfil e/externalEndpoints/testendpoint"

Authors

  • Hai Cao (@caohai)

  • Yunge Zhu (@yungezz)