azure_rm_trafficmanagerendpoint – Manage Azure Traffic Manager endpoint — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_trafficmanagerendpoint – Manage Azure Traffic Manager endpoint

New in version 2.7.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## 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
- 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 | Choices: auto cli credential_file env msi | 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 | 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 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.
enabled boolean | Choices: no yes ← | The status of the endpoint.
geo_mapping list |  | 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 - | 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 - / 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.

## 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 | Returned | Description
--- | --- | ---
id string | when traffic manager endpoint exists | The ID of the traffic manager endpoint.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

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

Hint

If you notice any issues in this documentation, you can edit this document to improve it.