azure.azcollection.azure_rm_localnetworkgateway 模块 – 在资源组中管理 Azure 本地网络网关

注意

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

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

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

要在剧本中使用它，请指定：azure.azcollection.azure_rm_localnetworkgateway。

azure.azcollection 2.4.0 中的新增功能

概要

• 在资源组中创建、更新或删除 Azure 本地网络网关

要求

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

• 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"
append_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"
bgp_settings 字典	本地网络网关的 BGP 扬声器设置。
asn 整数	BGP 扬声器的 ASN。
bgp_peering_address 字符串	此 BGP 扬声器的 BGP 对等地址和 BGP 标识符。
peer_weight 整数	添加到从此 BGP 扬声器学习的路由的权重。
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
fqdn 字符串	本地网络网关的 FQDN。
gateway_ip_address 字符串	本地网络网关的 IP 地址。
local_network_address_space 字典	本地网络站点的地址空间。
address_prefixes list / elements=string	以 CIDR 表示法为此虚拟网络保留的地址块列表。
location 字符串	本地网络网关的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name string / required	本地网络网关的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group string / required	本地网络网关的资源组。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	使用 present 创建或更新本地网络网关。 使用 absent 删除本地网络网关。 选择 "absent" "present" ←（默认）
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要分配为对象元数据的 string:string 对的字典。 对象的元数据标签将使用任何提供的值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。
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 中的配置文件，或者在运行任务或 playbook 之前使用 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。也可以添加其他配置文件。通过传递配置文件或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create a new local network gateway
  azure_rm_localnetworkgateway:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    local_network_address_space:
      address_prefixes:
        - 10.0.0.0/24
        - 20.0.0.0/24
    fqdn: fredtest.com
    tags:
      key: value
    bgp_settings:
      asn: 8
      bgp_peering_address: 10.3.0.1
      peer_weight: 3

- name: Delete local network gateway
  azure_rm_localnetworkgateway:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    state: absent

返回值

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

键	描述
state 复杂	Azure 本地网络网关资源的当前状态。 返回值：始终
bgp_settings 复杂	本地网络网关的 BGP 扬声器设置。 返回值：成功
asn 整数	BGP 扬声器的 ASN。 返回值：始终 示例： 10
bgp_peering_address 字符串	此 BGP 扬声器的 BGP 对等地址和 BGP 标识符。 返回值：始终 示例： "10.0.0.3"
peer_weight 整数	添加到从此 BGP 扬声器学习的路由的权重。 返回值：始终 示例： 0
etag 字符串	一个唯一的只读字符串，每次更新资源时都会更改。 返回值：始终 示例： "b5a32693-2e75-49e0-9137-ded19db658d6"
fqdn 字符串	本地网络网关的 FQDN。 返回值：始终 示例： "testfqdn.com"
gateway_ip_address 字符串	本地网络网关的 IP 地址。 返回值：始终 示例： "10.1.1.1"
id 字符串	资源 ID。 返回值：始终 示例： "/subscriptions/xxxx-xxxx/resourceGroups/testRG/providers/Microsoft.Network/localNetworkGateways/testgateway"
local_network_address_space 复杂	本地网络站点的地址空间。 返回值：成功
address_prefixes list / elements=string	以 CIDR 表示法为此虚拟网络保留的地址块列表。 返回值：始终 示例： ["10.0.0.0/24", "20.0.0.0/24"]
location 字符串	资源位置。 返回值：始终 示例： "eastus"
name 字符串	资源名称。 返回值：始终 示例： "testgateway"
provisioning_state 字符串	本地网络网关资源的预配状态。 返回值：始终 示例： "Succeeded"
tags 字符串	资源标签。 返回值：始终 示例： "{'key1': 'value1', 'key2': 'value2'}"
type 字符串	资源类型。 返回值：始终 示例： "Microsoft.Network/localNetworkGateways"

作者

• xuzhang3 (@xuzhang3)

• Fred Sun (@Fred-sun)

集合链接

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