Try SpotterManage Azure Traffic Manager endpoint
| "added in version" 2.7 of ansible.builtin"
Authors: Hai Cao (@caohai), Yunge Zhu (@yungezz)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create, update and delete Azure Traffic Manager endpoint.
- 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
name:
description:
- The name of the endpoint.
required: true
type: str
type:
choices:
- azure_endpoints
- external_endpoints
- nested_endpoints
description:
- The type of the endpoint.
required: true
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Traffic Manager endpoint. Use C(present) to create or update
a Traffic Manager endpoint and C(absent) to delete it.
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
target:
description:
- The fully-qualified DNS name of the endpoint.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
weight:
description:
- The weight of this endpoint when traffic manager profile has routing_method of C(weighted).
- Possible values are from 1 to 1000.
type: int
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
enabled:
default: true
description:
- The status of the endpoint.
type: bool
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
description:
- Specifies the location of the external or nested endpoints when using the 'Performance'
traffic routing method.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
priority:
description:
- The priority of this endpoint when traffic manager profile has routing_method of
I(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.
type: int
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
geo_mapping:
description:
- The list of countries/regions mapped to this endpoint when traffic manager profile
has routing_method of C(geographic).
type: list
profile_name:
description:
- Name of Traffic Manager profile where this endpoints attaches to.
required: true
type: str
resource_group:
description:
- Name of a resource group where the Traffic Manager endpoint exists or will be created.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
target_resource_id:
description:
- The Azure Resource URI of the of the endpoint.
- Not applicable to endpoints of I(type=external_endpoints).
type: str
min_child_endpoints:
description:
- 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 I(type=nested_endpoints).
type: int
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
id:
description:
- The ID of the traffic manager endpoint.
example: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/testProfil
e/externalEndpoints/testendpoint
returned: when traffic manager endpoint exists
type: str