azure.azcollection.azure_rm_privatelinkservice 模块 – 托管专用链路服务资源

注意

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

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

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

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

azure.azcollection 1.12.0 中的新增功能

概要

• 创建、更新或删除专用链路服务资源。

要求

在执行此模块的主机上需要以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行来自 azure.azcollection 的模块的主机上

• 完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数	注释
ad_user 字符串	活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。
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 参数中找不到的任何标签都将从对象的元数据中删除。 选项 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"
auto_approval 字典	专用链路服务的自动批准列表。
subscriptions 列表 / 元素=字符串	订阅列表。
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
enable_proxy_protocol 布尔值	私有链路服务是否启用代理协议。 选项 false true
fqdns 列表 / 元素=字符串	完全限定域名列表。
ip_configurations 列表 / 元素=字典	私有链路服务 IP 配置的数组。
name 字符串	私有链路服务 IP 配置的名称。
properties 字典	私有链路服务 IP 配置的属性。
primary 布尔值	该 IP 配置是否为主配置。 选项 false true
private_ip_address_version 字符串	指定 IP 配置是 IPv4 还是 IPv6。 选项 "IPv4" "IPv6"
private_ip_allocation_method 字符串	私有 IP 地址分配方法。 选项 "静态" "动态"
subnet 字典	对子网资源的引用。
id 字符串	子网的 ID。
load_balancer_frontend_ip_configurations 列表 / 元素=字典	对负载均衡器 IP 配置的引用的数组 私有链路服务上不能有多个负载均衡器前端 IP 配置。
id 字符串	负载均衡器前端 IP 的 ID。
location 字符串	资源位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	私有链路服务的名称。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
state 字符串	断言私有链路服务的状态。 使用 state=present 创建或更新链路服务，使用 state=absent 删除它。 选项 "present" ← (默认) "absent"
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串：字符串对的字典。 对象的元数据标签将使用任何提供的数值进行更新。 要移除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 资源上仅支持 15 个标签。
tenant 字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
thumbprint 字符串 azure.azcollection 1.14.0 版本新增	在 x509_certificate_path 中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
visibility 字典	私有链路服务的可见性列表。
subscriptions 列表 / 元素=字符串	订阅列表。
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 中。这是一个包含 [default] 部分和以下密钥的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create the private link service
  azure_rm_privatelinkservice:
    name: linkservice-name
    resource_group: myResourceGroup
    enable_proxy_protocol: true
    fqdns:
      - 'dns01.com'
      - 'dns02.com'
    visibility:
      subscriptions:
        - xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        - yyyyyy-yyyyy-yyyy-yyyy-yyyyyyyyyyy
    auto_approval:
      subscriptions:
        - xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        - yyyyyy-yyyyy-yyyy-yyyy-yyyyyyyyyyy
    load_balancer_frontend_ip_configurations:
      - id: load_balancer_frontend_ip_configurations_id
    ip_configurations:
      - name: testSubnet
        properties:
          primary: false
          private_ip_allocation_method: 'Dynamic'
          private_ip_address_version: 'IPv4'
          subnet:
            id: subnet_id
      - name: subnetfredprivate-1
        properties:
          primary: true
          private_ip_allocation_method: 'Static'
          private_ip_address_version: 'IPv4'
          subnet:
            id: subnet_id
    tags:
      key1: value1
      key2: value2

- name: delete the private link service
  azure_rm_privatelinkservice:
    name: linkservice-name
    resource_group: myResourceGroup
    state: absent

返回值

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

键	描述
link_service 复杂类型	私有链路服务信息的列表。 返回： 始终
alias 字符串	私有链路服务的别名。 返回： 始终 示例： "linkservice.6a244dd8-8416-40cf-8c04-52b353bdd507.eastus.azure.privatelinkservice"
auto_approval 字典	专用链路服务的自动批准列表。 返回： 始终 示例： {"subscriptions": ["xxxx-xxxx", "yyyy-yyyyy"]}
enable_proxy_protocol 布尔值	私有链路服务是否启用代理协议。 返回： 始终 示例： false
etag 字符串	每当资源更新时都会更改的唯一只读字符串。 返回： 始终 示例： "f7d60f37-ea2b-4091-8546-1327f35468c4"
fqdns 列表 / 元素=字符串	完全限定域名列表。 返回： 始终 示例： ["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/subnamee"}
load_balancer_frontend_ip_configurations 列表 / 元素=字符串	对负载均衡器 IP 配置的引用的数组。 返回： 始终 示例： [{"id": "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/loadBalancers/testlb/frontendIPConfigurations/front01"}]
location 字符串	资源位置。 返回： 始终 示例： "eastus"
name 字符串	私有链路服务的名称。 返回： 始终 示例： "linkservice"
network_interfaces 列表 / 元素=字符串	对为此私有链路服务创建的网络接口的引用的数组。 返回： 始终 示例： [{"id": "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/testlinkservice.nic.f5"}]
private_endpoint_connections 复杂类型	关于与私有端点连接的列表的数组。 返回： 始终
id 字符串	私有端点连接的 ID。 返回： 始终 示例： "/subscriptions/xxx/resourceGroups/myRG/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": ["xxxx-xxxx", "yyyy-yyyyy"]}

作者

• xuzhang3 (@xuzhang3)

• Fred-sun (@Fred-sun)

资源链接

• 问题追踪器
• 主页
• 代码仓库