azure.azcollection.azure_rm_trafficmanagerprofile_info 模块 – 获取 Azure Traffic Manager 配置文件信息

注意

此模块是 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 特定 Traffic Manager 配置文件或所有 Traffic Manager 配置文件的信息。

需求

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

• python >= 2.7

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

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

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

参数

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

备注

注意

• 对于使用 Azure 进行身份验证，您可以传递参数，设置环境变量，使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用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 中。这是一个包含 [default] 部分和以下键的 ini 文件：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 字符串	流量管理器配置文件的完全限定域名 (FQDN)。 返回：始终 示例："testTm.trafficmanager.net"
relative_name 字符串	流量管理器配置文件提供的相对 DNS 名称。 返回：始终 示例："testTm"
ttl 整数	DNS 生存时间 (TTL)，以秒为单位。 返回：始终 示例：60
endpoints 复杂的	流量管理器配置文件中的端点列表。 返回：始终
geo_mapping 列表 / 元素=字符串	当配置文件具有 routing_method geographic时，映射到此端点的国家/地区列表。 返回：始终 示例：["GEO-NA", "GEO-AS"]
id 字符串	资源的完全限定资源 ID。 返回：始终 示例："/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficMan agerProfiles/tmtest/externalEndpoints/e1"
location 字符串	当type=external_endpoints或type=nested_endpoints且配置文件routing_method=performance时，端点的位置。 返回：始终 示例："East US"
min_child_endpoints 整数	子配置文件中必须可用的端点最小数量，才能使父配置文件可用。 返回：始终 示例：3
name 字符串	端点的名称。 返回：始终 示例："e1"
priority 字符串	当配置文件具有routing_method=priority时，此端点的优先级。 返回：始终 示例："3"
status 字符串	端点的状态。 返回：始终 示例："Enabled"
target 字符串	端点的完全限定域名。 返回：始终 示例："8.8.8.8"
target_resource_id 字符串	端点的 Azure 资源 URI。 返回：始终 示例："/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/dom ainNames/vscjavaci"
type 字符串	端点的类型。 返回：始终 示例："external_endpoints"
weight 整数	当配置文件具有routing_method=weighted时，此端点的权重。 返回：始终 示例：10
location 字符串	流量管理器配置文件的位置。 返回：始终 示例："global"
monitor_config 复杂的	流量管理器配置文件的端点监控设置。 返回：始终
interval 整数	此配置文件中端点的监控间隔，以秒为单位。 返回：始终 示例：10
路径 字符串	相对于端点域名用于探测端点运行状况的路径。 返回：始终 示例："/"
port 整数	用于探测端点运行状况的 TCP 端口。 返回：始终 示例：80
protocol 字符串	用于探测端点运行状况的协议 HTTP、HTTPS 或 TCP。 返回：始终 示例："HTTP"
timeout 整数	此配置文件中端点的监控超时，以秒为单位。 返回：始终 示例：30
tolerated_failures 整数	在下一个失败的健康检查后声明端点降级之前，连续失败的健康检查次数。 返回：始终 示例：3
name 字符串	流量管理器配置文件的名称。 返回：始终 示例："testTm"
profile_status 字符串	流量管理器配置文件的状态。 返回：始终 示例："Enabled"
resource_group 字符串	存在流量管理器配置文件的资源组的名称。 返回：始终 示例："testGroup"
routing_method 字符串	流量管理器配置文件的流量路由方法。 返回：始终 示例："performance"
state 字符串	流量管理器配置文件的状态。 返回：始终 示例："present"

作者

• 曹海 (@caohai)

• 朱韵歌 (@yungezz)

集合链接

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