exec.azurerm.network.virtual_network_peering

Azure Resource Manager (ARM) Virtual Network Peering Execution Module

New in version 1.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

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_peering.create_or_update(hub, ctx, name, remote_virtual_network, virtual_network, resource_group, remote_vnet_group=None, **kwargs)

New in version 1.0.0.

Create or update a virtual network peering object.

Parameters:
  • name – The name assigned to the peering object being created or updated.
  • remote_virtual_network – A valid name of a virtual network with which to peer.
  • remote_vnet_group – The resource group of the remote virtual network. Defaults to the same resource group as the “local” virtual network.
  • virtual_network – The virtual network name containing the peering object.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.virtual_network_peering.create_or_update peer1 remotenet testnet testgroup
                                                         remote_vnet_group=remotegroup
idem_azurerm.exec.azurerm.network.virtual_network_peering.delete(hub, ctx, name, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

Delete a virtual network peering object.

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

CLI Example:

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

New in version 1.0.0.

Get details about a specific virtual network peering object.

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

CLI Example:

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

New in version 1.0.0.

List all peerings associated with a virtual network.

Parameters:
  • virtual_network – The virtual network name for which to list peerings.
  • resource_group – The resource group name for the virtual network.

CLI Example:

azurerm.network.virtual_network_peering.list testnet testgroup