azure.azcollection.azure_rm_trafficmanager 模块 – 管理流量管理器配置文件。

注意

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

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

要安装它，请使用： ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

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

azure.azcollection 0.1.2 新增功能

概要

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

要求

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

• python >= 2.7

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

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

• 完整的安装说明可在 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 参数中找不到的任何标签都将从对象的元数据中删除。 选项 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)，以秒为单位。
endpoints 列表 / 元素=字典	流量管理器配置文件中的端点列表。 默认： []
endpoint_location 字符串	使用“性能”流量路由方法时，指定外部或嵌套端点的位置。
endpoint_monitor_status 字符串	端点的监控状态。
endpoint_status 字符串	端点的状态。 选项 “已启用” “已禁用”
geo_mapping 列表 / 元素=字符串	使用“地理位置”流量路由方法时，映射到此端点的国家/地区列表。
id 字符串	资源的完全限定资源 ID。
min_child_endpoints 整数	为了使父配置文件被视为可用，子配置文件中必须可用的端点最小数量。 仅适用于类型为“NestedEndpoints”的端点。
name 字符串	端点的名称。
priority 整数	使用“优先级”流量路由方法时，此端点的优先级。 可能的值为 1 到 1000，较低的值表示较高的优先级。 这是一个可选参数。如果指定，则必须在所有端点上指定。 不允许两个端点共享相同的优先级值。
target 字符串	端点的完全限定 DNS 名称。
target_resource_id 字符串	端点的 Azure 资源 URI。 不适用于类型为“ExternalEndpoints”的端点。
type 字符串	端点的类型。例如- Microsoft.network/TrafficManagerProfiles/ExternalEndpoints。
weight 整数	使用“加权”流量路由方法时，此端点的权重。 可能的值为 1 到 1000。
location 字符串	有效的 Azure 位置。默认为“global”。
log_mode 字符串	父参数。
log_path 字符串	父参数。
monitor_config 字典	流量管理器配置文件的端点监控设置。 默认： {"path": "/", "port": 80, "protocol": "HTTP"}
interval_in_seconds 整数	此配置文件中端点的监控间隔。
path 字符串	相对于端点域名用于探测端点运行状况的路径。
port 整数	用于探测端点运行状况的 TCP 端口。
profile_monitor_status 字符串	流量管理器的配置文件级监控状态。
protocol 字符串	用于探测端点运行状况的协议 (HTTP、HTTPS 或 TCP)。 选项 “HTTP” “HTTPS” “TCP”
timeout_in_seconds 整数	此配置文件中端点的监控超时。
tolerated_number_of_failures 整数	在声明此配置文件中的端点在下次失败的运行状况检查后降级之前，连续失败的运行状况检查次数。
name 字符串 / 必需	流量管理器配置文件的名称。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
profile_status 字符串	流量管理器配置文件的状态。 选项 "Enabled" ← (默认) “已禁用”
resource_group 字符串 / 必需	存在或将创建流量管理器配置文件的资源组的名称。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
state 字符串	声明流量管理器配置文件的状态。使用present创建或更新流量管理器配置文件，使用absent删除它。 选项 “absent” "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串：字符串对字典。 对象的元数据标签将使用任何提供的数值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	在x509_certificate_path中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则为必需。
traffic_routing_method 字符串	流量管理器配置文件的流量路由方法。 选项 "Performance" ← (默认) “Priority” “Weighted” “Geographic”
x509_certificate_path 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: 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

返回值

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

键

描述

state 字典

流量管理器配置文件的当前状态 返回：始终 示例： {"dns_config": {"fqdn": "tmtest.trafficmanager.net", "relative_name": "tmtest", "ttl": 60}, "endpoints": [{"endpoint_location": "美国西部 2", "endpoint_monitor_status": "降级", "endpoint_status": "已启用", "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": "降级", "protocol": "HTTPS", "timeout_in_seconds": 10, "tolerated_number_of_failures": 3}, "name": "tmtest", "profile_status": "已启用", "tags": {"Environment": "Test"}, "traffic_routing_method": "Priority", "type": "Microsoft.Network/trafficManagerProfiles"}

作者

• 曹海 (@caohai)

收藏链接

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