azure.azcollection.azure_rm_privateendpoint_info 模块 – 获取私有终结点信息

注意

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

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

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

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

azure.azcollection 1.8.0 中的新增功能

概要

  • 获取私有终结点的 facts。

要求

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

  • 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 配置文件获取凭据。如果存在多个订阅 ID，可以使用 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

字符串

资源组的名称。

password

字符串

Active Directory 用户密码。当使用 Active Directory 用户而非服务主体进行身份验证时使用。

profile

字符串

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

resource_group

字符串

按资源组限制结果。

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 one private endpoint
  azure_rm_privateendpoint_info:
    resource_group: myResourceGroup
    name: testprivateendpoint

- name: Get all private endpoint under the resource group
  azure_rm_privateendpoint_info:
    resource_group: myResourceGroup

- name: Get all private endpoint under subscription
  azure_rm_virtualnetwork_info:
    tags:
      - key1:value1

返回值

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

键

描述

状态

复杂

私有端点字典列表，格式与 azure.azcollection.azure_rm_privateendpoint 模块参数相同。

已返回: 总是

etag

字符串

一个唯一的只读字符串，每次资源更新时都会更改。

已返回: 总是

示例: "W/\"20803842-7d51-46b2-a790-ded8971b4d8a"

id

字符串

私有端点的资源 ID。

已返回: 总是

示例: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/ped01"

location

字符串

有效的 Azure 位置。

已返回: 总是

示例: "eastus"

复杂

要连接的私有端点的资源 ID。

已返回: 当使用时

复杂

端点连接的状态详细信息

已返回: 总是

字符串

一条消息，指示服务提供商上的更改是否需要消费者进行任何更新。

已返回: 总是

示例: "This is action_required string"

字符串

批准/拒绝连接的原因。

已返回: 总是

示例: "Auto Approved"

字符串

指示连接是否已被服务所有者批准/拒绝/删除。

已返回: 总是

示例: "Approved"

字符串

要连接的私有端点的资源 ID。

已返回: 总是

示例: "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/privateEndpoints/ped01/privateLinkServiceConnections/ped01"

字符串

私有端点连接的名称。

已返回: 总是

示例: "ped_name01"

name

字符串

私有端点的名称。

已返回: 总是

示例: "ped01"

network_interfaces

列表 / 元素=字符串

网络接口的 ID 列表。

已返回: 总是

示例: ["/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic"]

复杂

要连接的私有端点的资源 ID。

已返回: 当使用时

复杂

端点连接的状态详细信息

已返回: 总是

字符串

一条消息，指示服务提供商上的更改是否需要消费者进行任何更新。

已返回: 总是

示例: "This is action_required string"

字符串

批准/拒绝连接的原因。

已返回: 总是

示例: "Auto Approved"

字符串

指示连接是否已被服务所有者批准/拒绝/删除。

已返回: 总是

示例: "Approved"

列表 / 元素=字符串

与私有端点关联的 group_ids 列表

已返回: 总是

示例: ["postgresqlServer"]

字符串

要连接的私有端点的资源 ID。

已返回: 总是

示例: "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/privateEndpoints/ped01/privateLinkServiceConnections/ped02"

字符串

私有端点连接的名称。

已返回: 总是

示例: "ped_name02"

provisioning_state

字符串

资源的预配状态。

已返回: 总是

示例: "Succeeded"

subnets_id

字符串

与虚拟网络关联的子网。

已返回: 总是

示例: "/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredtestRG-vnet/subnets/default"

tags

dictionary

分配给资源的标签。字符串:字符串对的字典。

已返回: 总是

示例: {"tag1": "abc"}

type

字符串

资源类型。

已返回: 总是

示例: "Microsoft.Network/privateEndpoints"

作者

  • Fred-sun (@Fred-sun)