azure.azcollection.azure_rm_cdnendpoint_info 模块 – 获取 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_info。

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取特定 Azure CDN 终结点或所有 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"

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

字符串

将结果限制为特定的 Azure CDN 端点。

password

字符串

Active Directory 用户密码。在通过 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

profile_name

字符串 / 必需

CDN 配置文件的名称。

resource_group

字符串 / 必需

此 CDN 配置文件所属的资源组的名称。

secret

字符串

Azure 客户端密钥。在通过服务主体进行身份验证时使用。

subscription_id

字符串

您的 Azure 订阅 ID。

tags

列表 / 元素=字符串

通过提供标签列表来限制结果。将标签格式化为“key”或“key:value”。

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 中。这是一个 ini 文件，包含一个 [default] 部分以及以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get facts for all endpoints in CDN profile
  azure_rm_cdnendpoint_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile
    tags:
      - key
      - key:value

- name: Get facts of specific CDN endpoint
  azure_rm_cdnendpoint_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile
    name: myEndpoint1

返回值

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

键

描述

cdnendpoints

复杂

Azure CDN 端点的列表。

返回：始终

content_types_to_compress

列表 / 元素=字符串

应用压缩的内容类型列表。

返回：成功

示例： ["text/plain", "text/html", "text/css", "text/javascript", "application/x-javascript", "application/javascript", "application/json", "application/xml"]

id

字符串

Azure CDN 端点的 ID。

返回：成功

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myCDN/providers/Microsoft.Cdn/profiles/myProfile/endpoints/myEndpoint1"

is_compression_enabled

布尔值

指示是否在 CDN 上启用了内容压缩。

返回：成功

示例： true

is_http_allowed

布尔值

指示是否允许在端点上使用 HTTP 流量。

返回：成功

示例： true

is_https_allowed

布尔值

指示是否允许在端点上使用 HTTPS 流量。

返回：成功

示例： true

location

字符串

Azure CDN 端点的位置。

返回：成功

示例： "WestUS"

name

字符串

Azure CDN 端点的名称。

返回：始终

示例： "myEndpoint"

origin_host_header

字符串

随每个请求发送到源的主机头值。

返回：成功

示例： "xxxxxxxx.blob.core.windows.net"

origin_path

字符串

CDN 可以用来从源检索内容的目录路径。

返回：成功

示例： "/pic/"

origins

字典

通过 CDN 传递的内容的来源。

返回：成功

示例： {"host_name": "xxxxxxxx.blob.core.windows.net", "http_port": null, "https_port": null, "name": "xxxxxxxx-blob-core-windows-net"}

profile_name

字符串

此端点所附加的 Azure CDN 配置文件的名称。

返回：始终

示例： "myProfile"

provisioning_state

字符串

Azure CDN 端点的预配状态。

返回：成功

示例： "Succeeded"

query_string_caching_behavior

字符串

定义 CDN 如何缓存包含查询字符串的请求。

返回：成功

示例： "IgnoreQueryString"

resource_group

字符串

Azure CDN 端点所在的资源组的名称。

返回：始终

示例： "myResourceGroup"

resource_state

字符串

配置文件的资源状态。

返回：成功

示例： "Running"

tags

列表 / 元素=字符串

Azure CDN 端点的标签。

返回：成功

示例： ["foo"]

作者

  • Hai Cao (@caohai)

  • Yunge zhu (@yungezz)