azure.azcollection.azure_rm_privatelinkservice_info 模块 – 获取私有终结点连接信息

注意

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

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

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

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

azure.azcollection 1.12.0 中的新增功能

概要

• 获取私有终结点连接信息的事实。

要求

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

• 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 和 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 private link service info by name
  azure_rm_privatelinkservice_info:
    name: pn-service-name
    resource_group: myResourceGroup

- name: Get all private link service by resource group
  azure_rm_privatelinkservice_info:
    resource_group: myResourceGroup

- name: Get all private link service by subscription filter by tags
  azure_rm_privatelinkservice_info:
    tags:
      - key1
      - abc

返回值

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

键	描述
link_service 复杂	私有链接服务信息的列表。 返回： 总是
alias 字符串	私有链接服务的别名。 返回： 总是 示例： "linkservice.6a244dd8-8416-40cf-8c04-52b353bdd507.eastus.azure.privatelinkservice"
auto_approval 字典	私有链接服务的自动批准列表。 返回： 总是 示例： {"subscriptions": []}
enable_proxy_protocol 布尔值	是否为私有链接服务启用了代理协议 返回： 总是 示例： false
etag 字符串	一个唯一的只读字符串，在资源更新时会发生变化。 返回： 总是 示例： "f7d60f37-ea2b-4091-8546-1327f35468c4"
fqdns list / elements=string	Fqdn 的列表。 返回： 总是 示例： ["fqdns1.com", "fqdns2.com"]
id 字符串	私有链接服务的资源 ID。 返回： 总是 示例： "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateLinkServices/linkservice"
ip_configurations 复杂	私有链接服务 IP 配置的数组。 返回： 总是
name 字符串	IP 配置的名称。 返回： 总是 示例： "subnetfredprivate-1"
properties 复杂	IP 配置属性。 返回： 总是
primary 布尔值	IP 配置是否为主配置。 返回： 总是 示例： true
private_ip_address_version 字符串	特定的 IP 配置是 IPv4 还是 IPv6。 返回： 总是 示例： "IPv4"
private_ip_allocation_method 字符串	私有 IP 地址分配方法。 返回： 总是 示例： "Dynamic"
subnet 字典	对子网资源的引用。 返回： 总是 示例： {"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subname"}
load_balancer_frontend_ip_configurations list / elements=string	对负载均衡器 IP 配置的引用数组。 返回： 总是 示例： [{"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/loadBalancers/testlb/frontendIPConfigurations/front01"}]
location 字符串	资源位置。 返回： 总是 示例： "eastus"
name 字符串	私有链接服务的名称。 返回： 总是 示例： "linkservice"
network_interfaces list / elements=string	对此私有链接服务创建的网络接口的引用数组。 返回： 总是 示例： [{"id": "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/testlinkservice.nic.f5"}]
private_endpoint_connections 复杂	有关与私有终结点的连接的列表数组。 返回： 总是
id 字符串	私有终结点连接的 ID。 返回： 总是 示例： "/subscriptions/xxx/resourceGroups/myReG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/tes"
private_endpoint 字符串	私有终结点的 ID。 返回： 总是 示例： "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/test002"
provisioning_state 字符串	私有链接服务资源的预配状态。 返回： 总是 示例： "Succeeded"
tags 字典	资源标签。 返回： 总是 示例： {"key1": "value1"}
type 字符串	资源类型。 返回： 总是 示例： "Microsoft.Network/privateLinkServices"
visibility 字典	私有链接服务的可见性列表。 返回： 总是 示例： {"subscriptions": []}

作者

• xuzhang3 (@xuzhang3)

• Fred-sun (@Fred-sun)

集合链接

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