azure.azcollection.azure_rm_cdnendpoint 模块 – 管理 Azure CDN 终结点

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要 

创建、更新、启动、停止和删除 Azure CDN 终结点。

要求 

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

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"`
content_types_to_compress 列表 / 元素=字符串	应用压缩的内容类型列表。此值应为有效的 MIME 类型。
disable_instance_discovery 布尔值在 azure.azcollection 2.3.0 中添加	确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 True，将禁用授权的验证。因此，必须确保配置的授权主机有效且可信。通过凭据文件配置文件或 `AZURE_DISABLE_INSTANCE_DISCOVERY` 环境变量设置。选项 `false` ← (默认) `true`
is_compression_enabled 布尔值	指示是否在 CDN 上启用了内容压缩。选项 `false` ← (默认) `true`
is_http_allowed 布尔值	指示是否允许在终结点上使用 HTTP 流量。选项 `false` `true` ← (默认)
is_https_allowed 布尔值	指示是否允许在终结点上使用 HTTPS 流量。选项 `false` `true` ← (默认)
location 字符串	有效的 Azure 位置。默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	Azure CDN 终结点的名称。
origin_host_header 字符串	随每个请求发送到源的 Host 标头值。
origin_path 字符串	源上 CDN 可以用来检索内容的目录路径。例如：contoso.cloudapp.net/originpath。
origins 列表 / 元素=字典	通过 CDN 传送的内容的源的集合。创建时必需。
host_name 字符串 / 必需	源的地址。它可以是域名、IPv4 地址或 IPv6 地址。
http_port 整数	HTTP 端口的值。必须介于 `1` 和 `65535` 之间。
https_port 整数	HTTPS 端口的值。必须介于 `1` 和 `65535` 之间。
name 字符串 / 必需	源名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
profile_name 字符串 / 必需	附加终结点的 CDN 配置文件的名称。
purge 布尔值	与 state=present 一起使用以清除终结点。选项 `false` `true`
purge_content_paths 列表 / 元素=字符串	与 state=present 和 purge=true 一起使用，以指定要清除的内容路径。默认值： `["/"]`
query_string_caching_behavior 字符串	定义 CDN 如何缓存包含查询字符串的请求。选项 `"ignore_query_string"` ←（默认） `"bypass_caching"` `"use_query_string"` `"not_set"`
resource_group 字符串 / 必需	Azure CDN 终结点存在或将要创建的资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
started 布尔值	与 state=present 一起使用以启动终结点。选项 `false` `true`
state 字符串	断言 Azure CDN 终结点的状态。使用 `present` 来创建或更新 Azure CDN 终结点，使用 `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 路径在 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 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。还可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅 

另请参阅

使用 Azure CLI 登录: 如何使用 az login 命令进行身份验证。

示例 

- name: Create a Azure CDN endpoint
  azure_rm_cdnendpoint:
    resource_group: myResourceGroup
    profile_name: myProfile
    name: myEndpoint
    origins:
      - name: TestOrig
        host_name: "www.example.com"
    tags:
      testing: testing
      delete: on-exit
      foo: bar
- name: Delete a Azure CDN endpoint
  azure_rm_cdnendpoint:
    resource_group: myResourceGroup
    profile_name: myProfile
    name: myEndpoint
    state: absent

返回值 

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

Key	描述
host_name 字符串	CDN 终结点的主机名。返回：始终示例： `"myendpoint.azureedge.net"`
id 字符串	CDN 终结点的 ID。返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/ myEndpoint"`
state 字符串	Azure CDN 终结点的当前状态。返回：始终

作者

Yunge Zhu (@yungezz)