azure.azcollection.azure_rm_subnet 模块 – 管理 Azure 子网

注意

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

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

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

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

azure.azcollection 0.1.0 中的新增功能

概要

  • 在给定的虚拟网络中创建、更新或删除子网。

  • 允许设置和更新地址前缀 CIDR，它必须在虚拟网络的上下文中有效。

  • 使用 azure.azcollection.azure_rm_networkinterface 模块将接口与子网关联并分配特定的 IP 地址。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

活动目录用户名。使用活动目录用户而不是服务主体进行身份验证时使用。

address_prefix_cidr

别名：address_prefix

字符串

定义子网 IPv4 地址空间的 CIDR。必须在虚拟网络的上下文中有效。

address_prefixes_cidr

别名：address_prefixes

列表 / 元素=字符串

azure.azcollection 1.0.0 中新增

定义子网 IPv4 和 IPv6 地址空间的 CIDR。必须在虚拟网络的上下文中有效。

如果设置了 *address_prefix*，则不会设置此参数。

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"

委派

列表 / 元素=字典

委派数组。

操作

列表 / 元素=字符串

操作列表。

默认值： []

名称

字符串 / 必填

委派名称。

serviceName

字符串 / 必填

端点服务的类型。

选项

  • "Microsoft.ContainerService/managedClusters"

  • "Microsoft.Web/serverFarms"

  • "Microsoft.ContainerInstance/containerGroups"

  • "Microsoft.Netapp/volumes"

  • "Microsoft.HardwareSecurityModules/dedicatedHSMs"

  • "Microsoft.ServiceFabricMesh/networks"

  • "Microsoft.Logic/integrationServiceEnvironments"

  • "Microsoft.Batch/batchAccounts"

  • "Microsoft.Sql/managedInstances"

  • "Microsoft.Web/hostingEnvironments"

  • "Microsoft.BareMetal/CrayServers"

  • "Microsoft.BareMetal/MonitoringServers"

  • "Microsoft.Databricks/workspaces"

  • "Microsoft.BareMetal/AzureHostedService"

  • "Microsoft.BareMetal/AzureVMware"

  • "Microsoft.BareMetal/AzureHPC"

  • "Microsoft.BareMetal/AzurePaymentHSM"

  • "Microsoft.StreamAnalytics/streamingJobs"

  • "Microsoft.DBforPostgreSQL/serversv2"

  • "Microsoft.AzureCosmosDB/clusters"

  • "Microsoft.MachineLearningServices/workspaces"

  • "Microsoft.DBforPostgreSQL/singleServers"

  • "Microsoft.DBforPostgreSQL/flexibleServers"

  • "Microsoft.DBforMySQL/serversv2"

  • "Microsoft.DBforMySQL/flexibleServers"

  • "Microsoft.ApiManagement/service"

  • "Microsoft.Synapse/workspaces"

  • "Microsoft.PowerPlatform/vnetaccesslinks"

  • "Microsoft.Network/managedResolvers"

  • "Microsoft.Kusto/clusters"

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

字符串

父参数。

名称

字符串 / 必填

子网名称。

nat_gateway

字符串

与子网关联的现有NAT网关。

它可以是与资源组相同的NAT网关名称。

可以是NAT网关的资源ID。

可以是包含NAT网关的*名称*和*资源组*的字典。

password

字符串

Active Directory用户密码。在使用Active Directory用户而不是服务主体进行身份验证时使用。

private_endpoint_network_policies

字符串

Enabled 或 Disabled 对子网中的专用端点应用网络策略。

选项

  • "Enabled" ← (默认)

  • "Disabled"

字符串

Enabled 或 Disabled 对子网中的专用链接服务应用网络策略。

选项

  • "Enabled" ← (默认)

  • "Disabled"

profile

字符串

在~/.azure/credentials文件中找到的安全配置文件。

resource_group

字符串 / 必填

资源组名称。

route_table

任意

路由表资源的引用。

可以是路由表的名称或资源ID。

可以是包含路由表的*名称*和*资源组*的字典。

没有此配置，关联的路由表将被取消关联。如果没有关联的路由表，则不会产生影响。

secret

字符串

Azure客户端密钥。在使用服务主体进行身份验证时使用。

安全组

别名：security_group_name

任意

与子网关联的现有安全组。

它可以是与资源组相同的安全组名称。

可以是安全组的资源ID。

可以是包含安全组的*名称*和*资源组*的字典。

service_endpoints

列表 / 元素=字典

服务端点数组。

locations

列表 / 元素=字符串

位置列表。

service

字符串 / 必填

端点服务的类型。

state

字符串

断言子网的状态。使用present创建或更新子网，使用absent删除子网。

选项

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的Azure订阅ID。

tenant

字符串

Azure租户ID。在使用服务主体进行身份验证时使用。

thumbprint

字符串

azure.azcollection 1.14.0版本新增

在*x509_certificate_path*中指定的私钥的指纹。

在使用服务主体进行身份验证时使用。

如果定义了*x509_certificate_path*，则为必填项。

虚拟网络名称

别名：virtual_network

字符串 / 必填

与子网关联或将要关联的现有虚拟网络的名称。

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 subnet
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/24"

- name: Create a subnet refer nsg from other resource group
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    security_group:
      name: secgroupfoo
      resource_group: mySecondResourceGroup
    route_table: route

- name: Create a subnet with service endpoint
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    service_endpoints:
      - service: "Microsoft.Sql"
        locations:
          - "eastus"

- name: Create a subnet with delegations
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    delegations:
      - name: 'mydeleg'
        serviceName: 'Microsoft.ContainerInstance/containerGroups'

- name: Create a subnet with an associated NAT Gateway
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    nat_gateway: myNatGateway

- name: Delete a subnet
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    state: absent

返回值

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

键

描述

state

复杂类型

子网的当前状态。

返回：成功

address_prefix

字符串

IP地址CIDR。

返回：始终返回

示例： "10.1.0.0/16"

address_prefixes

列表 / 元素=字符串

IPv4和IPv6的IP地址CIDR。

返回：始终返回

示例： ["10.2.0.0/24", "fdda:e69b:1587:495e::/64"]

委派

列表 / 元素=字符串

子网关联的委派

返回：始终返回

操作

列表 / 元素=字符串

与委派服务关联的操作列表

返回：当委派存在时

示例： ["Microsoft.Network/virtualNetworks/subnets/action"]

名称

字符串

委派名称

返回：当委派存在时

示例： "delegationname"

serviceName

字符串

与委派关联的服务

返回：当委派存在时

示例： "Microsoft.ContainerInstance/containerGroups"

id

字符串

子网资源路径。

返回：始终返回

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet"

名称

字符串

子网名称。

返回：始终返回

示例： "foobar"

network_security_group

复杂类型

子网关联的网络安全组。

返回：始终返回

id

字符串

安全组资源标识符。

返回：始终返回

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroupfoo"

名称

字符串

安全组名称。

返回：始终返回

示例： "secgroupfoo"

private_endpoint_network_policies

字符串

Enabled 或 Disabled 对子网中的专用端点应用网络策略。

返回：始终返回

示例： "Enabled"

字符串

Enabled 或 Disabled 对子网中的专用链接服务应用网络策略。

返回：始终返回

示例： "Disabled"

provisioning_state

字符串

预配事件的成功或失败。

返回：始终返回

示例： "Succeeded"

作者

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)