azure.azcollection.azure_rm_privateendpointconnection 模块 – 管理的专用终结点连接

注意

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

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

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

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_privateendpointconnection。

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，否则将使用默认的 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"

connection_state

字典

有关服务消费者和服务提供商之间连接状态的信息集合。

actions_required

字符串

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

description

字符串

批准/拒绝连接的原因。

status

字符串

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

选择

  • "Approved"

  • "Rejected"

  • "Removed"

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 客户端密钥。使用服务主体进行身份验证时使用。

service_name

字符串 / 必需

私有链接服务的名称。

state

字符串

声明连接的状态。使用 present 更新连接，使用 absent 删除连接。

选择

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

你的 Azure 订阅 ID。

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 运行任务或 playbook 之前登录。

  • 也可以使用服务主体或 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: Update private endpoint connection
  azure_rm_privateendpointconnection_info:
    name: pe-connection-name
    service_name: testserviceName
    resource_group: myRG
    connection_state:
      description: "new_description string"
      actions_required: "Message string"
      status: "Rejected"

- name: Delee private endpoint connection
  azure_rm_privateendpointconnection_info:
    name: pe-connection-name
    service_name: testserviceName
    resource_group: myRG
    state: absent

返回值

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

Key

描述

state

complex

私有终结点连接信息的列表。

返回： 总是

etag

字符串

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

返回： 总是

示例： "f7d60f37-ea2b-4091-8546-1327f35468c4"

id

字符串

私有终结点连接的资源 ID。

返回： 总是

示例： "/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/link.09"

字符串

使用者链接 ID。

返回： 总是

示例： "536890208"

name

字符串

私有终结点连接的名称。

返回： 总是

示例： "testlink.09"

complex

有关服务消费者和服务提供商之间连接状态的信息集合。

返回： 总是

字符串

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

返回： 总是

示例： "这是 action_required 字符串"

字符串

批准/拒绝连接的原因。

返回： 总是

示例： "自动 已批准"

字符串

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

返回： 总是

示例： "已批准"

PrivateEndpoint

complex

私有终结点的资源。

返回： 总是

id

字符串

私有终结点资源 ID。

返回： 总是

示例： "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/testlink02"

provisioning_state

字符串

资源的预配状态。

返回： 总是

示例： "成功"

type

字符串

资源类型。

返回： 总是

示例： "Microsoft.Network/privateLinkServices/privateEndpointConnections"

作者

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)