exec.azurerm.network.virtual_network

Azure Resource Manager (ARM) Virtual Network Execution Module

New in version 1.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed via acct. Note that the authentication parameters are case sensitive.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.network.virtual_network.create_or_update(hub, ctx, name, address_prefixes, resource_group, **kwargs)

New in version 1.0.0.

Create or update a virtual network.

Parameters:
  • name – The name assigned to the virtual network being created or updated.
  • address_prefixes – A list of CIDR blocks which can be used by subnets within the virtual network.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network.create_or_update testnet ['10.0.0.0/16'] testgroup
idem_azurerm.exec.azurerm.network.virtual_network.delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete a virtual network.

Parameters:
  • name – The name of the virtual network to delete.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network.delete testnet testgroup
idem_azurerm.exec.azurerm.network.virtual_network.get(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get details about a specific virtual network.

Parameters:
  • name – The name of the virtual network to query.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network.get testnet testgroup
idem_azurerm.exec.azurerm.network.virtual_network.list_(hub, ctx, resource_group=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

List all virtual networks within a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.virtual_network.list
idem_azurerm.exec.azurerm.network.virtual_network.subnet_create_or_update(hub, ctx, name, address_prefix, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

Create or update a subnet.

Parameters:
  • name – The name assigned to the subnet being created or updated.
  • address_prefix – A valid CIDR block within the virtual network.
  • virtual_network – The virtual network name containing the subnet.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network_gateway.subnet_create_or_update testsubnet '10.0.0.0/24' testnet testgroup
idem_azurerm.exec.azurerm.network.virtual_network.subnet_delete(hub, ctx, name, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

Delete a subnet.

Parameters:
  • name – The name of the subnet to delete.
  • virtual_network – The virtual network name containing the subnet.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network_gateway.subnet_delete testsubnet testnet testgroup
idem_azurerm.exec.azurerm.network.virtual_network.subnet_get(hub, ctx, name, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

Get details about a specific subnet.

Parameters:
  • name – The name of the subnet to query.
  • virtual_network – The virtual network name containing the subnet.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network_gateway.subnet_get testsubnet testnet testgroup
idem_azurerm.exec.azurerm.network.virtual_network.subnets_list(hub, ctx, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

List all subnets within a virtual network.

Parameters:
  • virtual_network – The virtual network name to list subnets within.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network_gateway.subnets_list testnet testgroup