community / community.azure / 0.1.0 / module / azure_rm_trafficmanagerendpoint_info Get Azure Traffic Manager endpoint facts Authors: Hai Cao (@caohai), Yunge Zhu (@yungezz) preview | supported by communitycommunity.azure.azure_rm_trafficmanagerendpoint_info (0.1.0) — module
Install with ansible-galaxy collection install community.azure:==0.1.0
collections: - name: community.azure version: 0.1.0
Get facts for a specific Traffic Manager endpoints or all endpoints in a Traffic Manager profile.
- name: Get endpoints facts of a Traffic Manager profile azure_rm_trafficmanagerendpoint_info: resource_group: myResourceGroup profile_name: Testing
- name: Get specific endpoint of a Traffic Manager profile azure_rm_trafficmanager_info: resource_group: myResourceGroup profile_name: Testing name: test_external_endpoint
name: description: - Limit results to a specific Traffic Manager endpoint. type: choices: - azure_endpoints - external_endpoints - nested_endpoints description: - Type of endpoint. 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 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. 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: '2.5' version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi description: - 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 C(auto) if variable is not defined. - C(auto) will follow the default precedence of module parameters -> environment variables -> default profile in credential file C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the default Azure CLI profile. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - 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: '2.5' version_added_collection: azure.azcollection profile_name: description: - Name of Traffic Manager Profile. required: true resource_group: description: - The resource group to search for the desired Traffic Manager profile. required: true 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: '2.4' 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: '2.6' 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: '2.5' version_added_collection: azure.azcollection
endpoints: contains: enabled: description: - The status of the endpoint. returned: always sample: Enabled type: str geo_mapping: description: - The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. returned: always sample: - GEO-NA - GEO-AS type: list location: description: - The location of the external or nested endpoints when using the 'Performance' traffic routing method. returned: always sample: East US type: str min_child_endpoints: description: - The minimum number of endpoints that must be available in the child profile to make the parent profile available. returned: always sample: 3 type: int name: description: - Name of the Traffic Manager endpoint. returned: always sample: testendpoint type: str priority: description: - The priority of this endpoint when using the 'Priority' traffic routing method. returned: always sample: 3 type: str resource_group: description: - Name of a resource group. returned: always sample: myResourceGroup type: str target: description: - The fully-qualified DNS name of the endpoint. returned: always sample: 8.8.8.8 type: str target_resource_id: description: - The Azure Resource URI of the of the endpoint. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/vscjavaci type: str type: description: - The type of the endpoint. returned: always sample: external_endpoints type: str weight: description: - The weight of this endpoint when using the 'Weighted' traffic routing method. returned: always sample: 10 type: int description: - List of Traffic Manager endpoints. returned: always type: complex