azure.azcollection.azure_rm_trafficmanagerprofile 模块 – 管理 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。

azure.azcollection 0.1.2 中的新增功能

概要

• 创建、更新和删除流量管理器配置文件。

要求

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

• python >= 2.7

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

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

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

参数

参数	注释
ad_user 字符串	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
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"
append_tags 布尔值	用于控制 tags 字段是规范的还是仅附加到现有标签。 当为规范时，任何在 tags 参数中找不到的标签都将从对象的元数据中删除。 选项 false true ←（默认）
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
dns_config 字典	流量管理器配置文件的 DNS 设置。
relative_name 字符串	此流量管理器配置文件提供的相对 DNS 名称。 如果未提供，将使用流量管理器的名称。
ttl 整数	DNS 生存时间 (TTL)，以秒为单位。
location 字符串	有效的 Azure 位置。默认为 global，因为在默认的公共 Azure 云中，流量管理器配置文件只能全局部署。 参考 https://docs.microsoft.com/zh-cn/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile。 默认值: "global"
log_mode 字符串	父参数。
log_path 字符串	父参数。
monitor_config 字典	流量管理器配置文件的端点监视设置。 默认值: {"path": "/", "port": 80, "protocol": "HTTP"}
interval 整数	此配置文件中端点的监视间隔，以秒为单位。
path 字符串	用于探测端点运行状况的相对于端点域名的路径。
port 整数	用于探测端点运行状况的 TCP 端口。
profile_monitor_status 字符串	流量管理器的配置文件级监视状态。
protocol 字符串	用于探测端点运行状况的协议 HTTP、HTTPS 或 TCP。 选项 "HTTPS" "HTTP" "TCP"
timeout 整数	此配置文件中端点的监视超时，以秒为单位。
tolerated_failures 整数	在此配置文件中声明某个端点在下一次运行状况检查失败后降级之前，允许连续失败的运行状况检查次数。
name 字符串 / 必需	流量管理器配置文件的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
profile_status 字符串	流量管理器配置文件的状态。 选项 "enabled" ← (默认) "disabled"
resource_group 字符串 / 必需	流量管理器配置文件存在或将要创建的资源组的名称。
routing_method 字符串	流量管理器配置文件的流量路由方法。 选项 "performance" ← (默认) "priority" "weighted" "geographic"
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	断言流量管理器配置文件的状态。使用 present 创建或更新流量管理器配置文件，并使用 absent 删除它。 选项 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要分配为对象元数据的字符串：字符串对的字典。 对象上的元数据标签将使用任何提供的值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
x509_certificate_path 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: Create a Traffic Manager Profile
  azure_rm_trafficmanagerprofile:
    name: tmtest
    resource_group: myResourceGroup
    location: global
    profile_status: enabled
    routing_method: priority
    dns_config:
      relative_name: tmtest
      ttl: 60
    monitor_config:
      protocol: HTTPS
      port: 80
      path: '/'
    tags:
      Environment: Test

- name: Delete a Traffic Manager Profile
  azure_rm_trafficmanagerprofile:
    state: absent
    name: tmtest
    resource_group: myResourceGroup

返回值

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

键	描述
endpoints 列表 / 元素=字符串	附加到配置文件的端点 ID 列表。 返回: 当存在流量管理器端点时 示例: ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e2", "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e1"]
id 字符串	流量管理器配置文件的 ID。 返回: 当存在流量管理器配置文件时 示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest"

作者

• Hai Cao (@caohai)

• Yunge Zhu (@yungezz)

集合链接

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