azure.azcollection.azure_rm_afdendpoint 模块 – 管理用于标准或高级 Frontdoor 的 Azure Front Door 终结点

注意

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

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

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

要在剧本中使用它，请指定：azure.azcollection.azure_rm_afdendpoint。

azure.azcollection 2.7.0 中的新增功能

概要 

创建、更新和删除 Azure Front Door (AFD) 终结点，该终结点将由使用 azure_rm_cdnprofile 创建的 Front Door 服务配置文件使用。
这与 Front Door 经典服务不同，仅适用于标准或高级服务产品。

要求 

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

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。当为规范时，在 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"`
auto_generated_domain_name_label_scope 字符串	指示终结点名称重用范围。此时不能用于更新现有终结点。选择 `"TenantReuse"` ←（默认） `"SubscriptionReuse"` `"ResourceGroupReuse"` `"NoReuse"`
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`
enabled_state 字符串	是否启用此规则的使用。选择 `"Enabled"` ← （默认值） `"Disabled"`
location 字符串	有效的 Azure 位置。默认为资源组的位置。目前不能用于更新现有的终结点。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name string / 必填	AFD 终结点的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
profile_name string / 必填	将附加终结点的 AFD 配置文件的名称。
resource_group string / 必填	Azure Front Door 终结点存在或将创建的资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	声明 AFD 终结点的状态。使用 `present` 创建或更新 AFD 终结点，使用 `absent` 删除它。选择 `"absent"` `"present"` ← （默认值）
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的 string:string 对的字典。对象上的元数据标记将使用提供的任何值进行更新。要删除标记，请将 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 路径在 azure.azcollection 1.14.0 中添加	用于创建 PEM 格式的服务主体的 X509 证书的路径。证书必须附加到私钥。当使用服务主体进行身份验证时使用。

注意 

注意

要使用 Azure 进行身份验证，您可以传递参数，设置环境变量，使用存储在 ~/.azure/credentials 中的配置文件，或者在使用 az login 运行任务或 playbook 之前登录。
也可以使用服务主体或 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 an AFD Endpoint
  azure_rm_afdendpoint:
    name: myEndpoint
    profile_name: myProfile
    resource_group: myResourceGroup
    state: present
    tags:
      testing: testing

- name: Delete the AFD Endpoint
  azure_rm_afdendpoint:
    name: myEndPoint
    profile_name: myProfile
    resource_group: myResourceGroup
    state: absent

返回值 

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

键	描述
host_name 字符串	AFD 终结点的主机名。返回：始终示例： `"myendpoint.azurefd.net"`
id 字符串	AFD 终结点的 ID。返回：始终示例： `"id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/ myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/myEndpoint"`

作者

Jarret Tooley (@jartoo)