azure / azure.azcollection / 2.3.0 / module / azure_rm_trafficmanager Manage a Traffic Manager profile. | "added in version" 0.1.2 of azure.azcollection" Authors: Hai Cao (@caohai)azure.azcollection.azure_rm_trafficmanager (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete a Traffic Manager profile.
- name: Create a Traffic Manager Profile azure_rm_trafficmanager: name: tmtest resource_group: tmt location: global profile_status: Enabled traffic_routing_method: Priority dns_config: relative_name: tmtest ttl: 60 monitor_config: protocol: HTTPS port: 80 path: '/' endpoints: - name: e1 type: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints endpoint_location: West US 2 endpoint_status: Enabled priority: 2 target: 1.2.3.4 weight: 1 tags: Environment: Test
- name: Delete a Traffic Manager Profile azure_rm_trafficmanager: state: absent name: tmtest resource_group: tmt
name: description: - Name of the Traffic Manager profile. required: true type: str tags: description: - Dictionary of string:string pairs to assign as metadata to the object. - Metadata tags on the object will be updated with any provided values. - To remove tags set append_tags option to false. - Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. - Azure Front Door doesn't support the use of - Azure Automation and Azure CDN only support 15 tags on resources. type: dict state: choices: - absent - present default: present description: - Assert the state of the Traffic Manager profile. Use C(present) to create or update a Traffic Manager profile and C(absent) to delete it. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Valid azure location. Defaults to 'global'. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str endpoints: default: [] description: - The list of endpoints in the Traffic Manager profile. elements: dict suboptions: endpoint_location: description: - Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. type: str endpoint_monitor_status: description: - The monitoring status of the endpoint. type: str endpoint_status: choices: - Enabled - Disabled description: - The status of the endpoint. type: str geo_mapping: description: - The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. elements: str type: list id: description: - Fully qualified resource Id for the resource. 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 type 'NestedEndpoints'. type: int name: description: - The name of the endpoint. type: str priority: description: - The priority of this endpoint when using the 'Priority' traffic routing method. - 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 target: description: - The fully-qualified DNS name of the endpoint. type: str target_resource_id: description: - The Azure Resource URI of the of the endpoint. - Not applicable to endpoints of type 'ExternalEndpoints'. type: str type: description: - The type of the endpoint. Ex- Microsoft.network/TrafficManagerProfiles/ExternalEndpoints. type: str weight: description: - The weight of this endpoint when using the 'Weighted' traffic routing method. - Possible values are from 1 to 1000. type: int type: list dns_config: description: - The DNS settings of the Traffic Manager profile. suboptions: relative_name: description: - The relative DNS name provided by this Traffic Manager profile. - If no provided, name of the Traffic Manager will be used type: str ttl: description: - The DNS Time-To-Live (TTL), in seconds. type: int type: dict thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection 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 append_tags: default: true description: - Use to control if tags field is canonical or just appends to existing tags. - When canonical, any tags not found in the tags parameter will be removed from the object's metadata. type: bool 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 monitor_config: default: path: / port: 80 protocol: HTTP description: - The endpoint monitoring settings of the Traffic Manager profile. suboptions: interval_in_seconds: description: - The monitor interval for endpoints in this profile. type: int path: description: - The path relative to the endpoint domain name used to probe for endpoint health. type: str port: description: - The TCP port used to probe for endpoint health. type: int profile_monitor_status: description: - The profile-level monitoring status of the Traffic Manager. type: str protocol: choices: - HTTP - HTTPS - TCP description: - The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. type: str timeout_in_seconds: description: - The monitor timeout for endpoints in this profile. type: int tolerated_number_of_failures: description: - The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check. type: int type: dict profile_status: choices: - Enabled - Disabled default: Enabled description: - The status of the Traffic Manager profile. type: str resource_group: description: - Name of a resource group where the Traffic Manager profile 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 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 x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection traffic_routing_method: choices: - Performance - Priority - Weighted - Geographic default: Performance description: - The traffic routing method of the Traffic Manager profile. type: str disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
state: description: Current state of the Traffic Manager Profile example: dns_config: fqdn: tmtest.trafficmanager.net relative_name: tmtest ttl: 60 endpoints: - endpoint_location: West US 2 endpoint_monitor_status: Degraded endpoint_status: Enabled geo_mapping: null id: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1 min_child_endpoints: null name: e1 priority: 2 target: 1.2.3.4 target_resource_id: null type: Microsoft.Network/trafficManagerProfiles/externalEndpoints weight: 1 id: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest location: global monitor_config: interval_in_seconds: 30 path: / port: 80 profile_monitor_status: Degraded protocol: HTTPS timeout_in_seconds: 10 tolerated_number_of_failures: 3 name: tmtest profile_status: Enabled tags: Environment: Test traffic_routing_method: Priority type: Microsoft.Network/trafficManagerProfiles returned: always type: dict