azure.azcollection.azure_rm_virtualnetwork 模块 – 管理 Azure 虚拟网络

注意

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

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

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

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

azure.azcollection 0.1.0 中的新增功能

概要 

创建、更新或删除虚拟网络。允许设置和更新可用的 IPv4 地址范围并设置自定义 DNS 服务器。使用 azure.azcollection.azure_rm_subnet 模块将子网与虚拟网络关联。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 中模块的主机上
完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到

参数 

参数	注释
ad_user 字符串	Active Directory 用户名。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
address_prefixes_cidr 别名：address_prefixes 列表 / 元素=字符串	IPv4 地址范围列表，每个范围都使用 CIDR 表示法格式化。创建新的虚拟网络或使用 purge_address_prefixes 时必填。
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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。 Ansible 2.6 中添加了 `msi`。选项 `"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`
dns_servers 列表 / 元素=字符串	自定义 DNS 服务器列表。列表中的第一个服务器将被视为主服务器。这是一个显式列表。现有的 DNS 服务器将被指定列表替换。使用 purge_dns_servers 选项可以删除所有自定义 DNS 服务器并恢复到默认的 Azure 服务器。
flow_timeout_in_minutes 整数	虚拟网络的 FlowTimeout 值（以分钟为单位）。
location 字符串	有效的 Azure 位置。默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	虚拟网络的名称。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
purge_address_prefixes 别名：purge 布尔值	与 state=present 一起使用以删除任何现有的 address_prefixes。选项 `false` ← (默认) `true`
purge_dns_servers 布尔值	与 state=present 一起使用以删除现有的 DNS 服务器，恢复到默认的 Azure 服务器。与 DNS 服务器互斥。选项 `false` ← (默认) `true`
resource_group 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
state 字符串	虚拟网络的状态。使用 `present` 创建或更新，使用 `absent` 删除。选项 `“absent”` `"present"` ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	字符串：字符串对的字典，作为元数据分配给对象。对象的元数据标签将使用任何提供的 value 更新。要删除标签，请将 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，则需要此参数。
x509_certificate_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 a virtual network
  azure_rm_virtualnetwork:
    resource_group: myResourceGroup
    name: myVirtualNetwork
    address_prefixes_cidr:
      - 10.1.0.0/16
      - 172.100.0.0/16
    dns_servers:
      - 127.0.0.1
      - 127.0.0.2
    tags:
      testing: testing
      delete: on-exit

- name: Delete a virtual network
  azure_rm_virtualnetwork:
    resource_group: myResourceGroup
    name: myVirtualNetwork
    state: absent

返回值 

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

键	描述
state 复杂	虚拟网络的当前状态。返回：始终
address_prefixes 列表 / 元素=字符串	虚拟网络 IPv4 地址范围。返回：始终示例： `["10.1.0.0/16", "172.100.0.0/16"]`
dns_servers 列表 / 元素=字符串	DNS 服务器。返回：始终示例： `["127.0.0.1", "127.0.0.3"]`
etag 字符串	每当资源更新时都会更改的唯一只读字符串。返回：始终示例： `"W/\"0712e87c-f02f-4bb3-8b9e-2da0390a3886\""`
flow_timeout_in_minutes 整数	虚拟网络的 FlowTimeout 值（以分钟为单位）。返回：始终示例： `8`
id 字符串	资源 ID。返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/ Microsoft.Network/virtualNetworks/myVirtualNetwork"`
location 字符串	资源所在的地理位置。返回：始终示例： `"eastus"`
name 字符串	资源名称。返回：始终示例： `"my_test_network"`
provisioning_state 字符串	虚拟网络的预配状态。返回：始终示例： `"Succeeded"`
tags 字典	资源标签，例如 { ‘tags1’:’value1’ }。返回：始终示例： `{"key1": "value1"}`
type 字符串	资源类型。返回：始终示例： `"Microsoft.Network/virtualNetworks"`

作者

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)