azure.azcollection.azure_rm_trafficmanagerprofile_info 模块 – 获取 Azure 流量管理器配置文件信息

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_trafficmanagerprofile_info。

azure.azcollection 0.1.2 中的新增功能

概要

• 获取 Azure 特定流量管理器配置文件或所有流量管理器配置文件的信息。

要求

执行此模块的主机需要满足以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 python 包

• 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数	注释
ad_user string	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url string 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且具有自己的 ADFS 授权时使用。
api_profile string 在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公有云；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
auth_source string 在 azure.azcollection 0.0.1 中添加	控制用于身份验证的凭据的来源。 也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。 设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。 设置为 env 时，凭据将从环境变量中读取 设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。 设置为 cli 时，凭据将从 Azure CLI 配置文件中获取。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果存在多个订阅 ID），否则将使用默认的 az cli 订阅。 设置为 msi 时，主机必须是启用了 MSI 扩展的 azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则将选择第一个订阅。 msi 已在 Ansible 2.6 中添加。 选择 "auto" ← (默认) "cli" "credential_file" "env" "msi"
cert_validation_mode string 在 azure.azcollection 0.0.1 中添加	控制 Azure 终结点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量进行设置。 选择 "ignore" "validate"
client_id string	Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment string 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，可以使用环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment），或元数据发现终结点 URL（Azure Stack 需要）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量进行设置。 默认值： "AzureCloud"
disable_instance_discovery boolean 在 azure.azcollection 2.3.0 中添加	确定尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将其设置为 **True**，将禁用授权的验证。因此，必须确保配置的授权主机是有效且可信的。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选择 false ← (默认) true
log_mode string	父参数。
log_path string	父参数。
name string	将结果限制为特定的流量管理器配置文件。
password string	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件 string	安全配置文件位于 ~/.azure/credentials 文件中。
资源组 string	用于搜索所需流量管理器配置文件的资源组。
密钥 string	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
订阅 ID string	您的 Azure 订阅 ID。
标签 列表 / 元素=字符串	通过提供标签列表来限制结果。标签格式为“键”或“键:值”。
租户 string	Azure 租户 ID。当使用服务主体进行身份验证时使用。
指纹 string 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则为必需项。
x509_certificate_path 路径 在 azure.azcollection 1.14.0 中添加	用于创建 PEM 格式的服务主体的 X509 证书的路径。 证书必须附加到私钥。 当使用服务主体进行身份验证时使用。

注意

注意

• 要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或 playbook 之前使用 az login 登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或者设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或者在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个 ini 文件，其中包含 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant，或者 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get facts for one Traffic Manager profile
  azure_rm_trafficmanager_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all Traffic Manager profiles
  azure_rm_trafficmanager_info:

- name: Get facts by tags
  azure_rm_trafficmanager_info:
    tags:
      - Environment:Test

返回值

常见的返回值在此处记录 此处，以下是此模块特有的字段

键	描述
tms 复杂	流量管理器配置文件列表。 返回： 始终
dns_config 复杂	流量管理器配置文件的 DNS 设置。 返回： 始终
fqdn string	流量管理器配置文件的完全限定域名 (FQDN)。 返回： 始终 示例： "testTm.trafficmanager.net"
relative_name string	流量管理器配置文件提供的相对 DNS 名称。 返回： 始终 示例： "testTm"
ttl 整数	DNS 生存时间 (TTL)，以秒为单位。 返回： 始终 示例： 60
端点 复杂	流量管理器配置文件中的端点列表。 返回： 始终
geo_mapping 列表 / 元素=字符串	当配置文件具有 routing_method geographic 时，映射到此端点的国家/地区列表。 返回： 始终 示例： ["GEO-NA", "GEO-AS"]
id string	资源的完全限定资源 ID。 返回： 始终 示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1"
位置 string	当 type=external_endpoints 或 type=nested_endpoints，且配置文件 routing_method=performance 时，端点的位置。 返回： 始终 示例： "美国东部"
min_child_endpoints 整数	要使父配置文件可用，子配置文件中必须可用的最小端点数。 返回： 始终 示例： 3
name string	端点的名称。 返回： 始终 示例： "e1"
优先级 string	当配置文件具有 routing_method=priority 时，此端点的优先级。 返回： 始终 示例： "3"
状态 string	端点的状态。 返回： 始终 示例： "已启用"
目标 string	端点的完全限定 DNS 名称。 返回： 始终 示例： "8.8.8.8"
target_resource_id string	端点的 Azure 资源 URI。 返回： 始终 示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom ainNames/vscjavaci"
类型 string	端点的类型。 返回： 始终 示例： "external_endpoints"
权重 整数	当配置文件具有 routing_method=weighted 时，此端点的权重。 返回： 始终 示例： 10
位置 string	流量管理器配置文件的位置。 返回： 始终 示例： "global"
monitor_config 复杂	流量管理器配置文件的端点监视设置。 返回： 始终
间隔 整数	此配置文件中端点的监视间隔（以秒为单位）。 返回： 始终 示例： 10
路径 string	相对于端点域名用于探测端点运行状况的路径。 返回： 始终 示例： "/"
端口 整数	用于探测端点运行状况的 TCP 端口。 返回： 始终 示例： 80
协议 string	用于探测端点运行状况的协议 HTTP、HTTPS 或 TCP。 返回： 始终 示例： "HTTP"
超时 整数	此配置文件中端点的监视超时（以秒为单位）。 返回： 始终 示例： 30
容许的失败次数 整数	在下次运行状况检查失败后声明端点已降级之前，连续失败的运行状况检查的次数。 返回： 始终 示例： 3
name string	流量管理器配置文件的名称。 返回： 始终 示例： "testTm"
profile_status string	流量管理器配置文件的状态。 返回： 始终 示例： "已启用"
资源组 string	存在流量管理器配置文件的资源组的名称。 返回： 始终 示例： "testGroup"
routing_method string	流量管理器配置文件的流量路由方法。 返回： 始终 示例： "performance"
状态 string	流量管理器配置文件的状态。 返回： 始终 示例： "present"

作者

• Hai Cao (@caohai)

• Yunge Zhu (@yungezz)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）