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 配置文件。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 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 list / elements=string	通过提供标签列表来限制结果。将标签格式化为 “key” 或 “key:value”。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
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 和密码，或在环境中设置 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

返回值

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

键	描述
state 复杂	私有端点字典列表，格式与 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"
manual_private_link_service_connections 复杂	要连接的私有端点的资源 ID。 返回： 当使用时
connection_state 复杂	端点连接的状态详细信息 返回： 总是
actions_required 字符串	一条消息，指示服务提供商上的更改是否需要在使用者上进行任何更新。 返回： 总是 示例： "This is action_required string"
description 字符串	连接的批准/拒绝原因。 返回： 总是 示例： "Auto Approved"
status 字符串	指示连接是否已被服务所有者批准/拒绝/删除。 返回： 总是 示例： "Approved"
id 字符串	要连接的私有端点的资源 ID。 返回： 总是 示例： "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/privateEndpoints/ped01/privateLinkServiceConnections/ped01"
name 字符串	私有端点连接的名称。 返回： 总是 示例： "ped_name01"
name 字符串	私有端点的名称。 返回： 总是 示例： "ped01"
network_interfaces list / elements=string	网络接口的列表 ID。 返回： 总是 示例： ["/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic"]
private_link_service_connections 复杂	要连接的私有端点的资源 ID。 返回： 当使用时
connection_state 复杂	端点连接的状态详细信息 返回： 总是
actions_required 字符串	一条消息，指示服务提供商上的更改是否需要在使用者上进行任何更新。 返回： 总是 示例： "This is action_required string"
description 字符串	连接的批准/拒绝原因。 返回： 总是 示例： "Auto Approved"
status 字符串	指示连接是否已被服务所有者批准/拒绝/删除。 返回： 总是 示例： "Approved"
group_ids list / elements=string	与私有端点关联的 group_ids 列表 返回： 总是 示例： ["postgresqlServer"]
id 字符串	要连接的私有端点的资源 ID。 返回： 总是 示例： "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/privateEndpoints/ped01/privateLinkServiceConnections/ped02"
name 字符串	私有端点连接的名称。 返回： 总是 示例： "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)

集合链接

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