github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/providers/azurerm/r/virtual_network_peering.html.markdown (about)

     1  ---
     2  layout: "azurerm"
     3  page_title: "Azure Resource Manager: azure_virtual_network_peering"
     4  sidebar_current: "docs-azurerm-resource-network-virtual-network-peering"
     5  description: |-
     6    Creates a new virtual network peering which allows resources to access other
     7    resources in the linked virtual network.
     8  ---
     9  
    10  # azurerm\_virtual\_network\_peering
    11  
    12  Creates a new virtual network peering which allows resources to access other
    13  resources in the linked virtual network.
    14  
    15  ## Example Usage
    16  
    17  ```
    18  resource "azurerm_resource_group" "test" {
    19    name     = "peeredvnets-rg"
    20    location = "West US"
    21  }
    22  
    23  resource "azurerm_virtual_network" "test1" {
    24    name                = "peternetwork1"
    25    resource_group_name = "${azurerm_resource_group.test.name}"
    26    address_space       = ["10.0.1.0/24"]
    27    location            = "West US"
    28  }
    29  
    30  resource "azurerm_virtual_network" "test2" {
    31    name                = "peternetwork2"
    32    resource_group_name = "${azurerm_resource_group.test.name}"
    33    address_space       = ["10.0.2.0/24"]
    34    location            = "West US"
    35  }
    36  
    37  resource "azurerm_virtual_network_peering" "test1" {
    38    name                      = "peer1to2"
    39    resource_group_name       = "${azurerm_resource_group.test.name}"
    40    virtual_network_name      = "${azurerm_virtual_network.test1.name}"
    41    remote_virtual_network_id = "${azurerm_virtual_network.test2.id}"
    42  }
    43  
    44  resource "azurerm_virtual_network_peering" "test2" {
    45    name                      = "peer2to1"
    46    resource_group_name       = "${azurerm_resource_group.test.name}"
    47    virtual_network_name      = "${azurerm_virtual_network.test2.name}"
    48    remote_virtual_network_id = "${azurerm_virtual_network.test1.id}"
    49  }
    50  ```
    51  
    52  ## Argument Reference
    53  
    54  The following arguments are supported:
    55  
    56  * `name` - (Required) The name of the virtual network peering. Changing this 
    57      forces a new resource to be created.
    58  
    59  * `virtual_network_name` - (Required) The name of the virtual network. Changing
    60      this forces a new resource to be created.
    61  
    62  * `remote_virtual_network_id` - (Required) The full Azure resource ID of the
    63      remote virtual network.  Changing this forces a new resource to be created.
    64  
    65  * `resource_group_name` - (Required) The name of the resource group in which to
    66      create the virtual network. Changing this forces a new resource to be
    67      created.
    68  
    69  * `allow_virtual_network_access` - (Optional) Controls if the VMs in the remote
    70      virtual network can access VMs in the local virtual network. Defaults to
    71      false.
    72  
    73  * `allow_forwarded_traffic` - (Optional) Controls if forwarded traffic from  VMs
    74      in the remote virtual network is allowed. Defaults to false.
    75  
    76  * `allow_gateway_transit` - (Optional) Controls gatewayLinks can be used in the 
    77      remote virtual network’s link to the local virtual network.
    78  
    79  * `use_remote_gateways` - (Optional) Controls if remote gateways can be used on 
    80      the local virtual network. If the flag is set to true, and 
    81      allowGatewayTransit on the remote peering is also true, virtual network will
    82      use gateways of remote virtual network for transit. Only one peering can
    83      have this flag set to true. This flag cannot be set if virtual network
    84      already has a gateway. Defaults to false.     
    85  
    86  ## Attributes Reference
    87  
    88  The following attributes are exported:
    89  
    90  * `id` - The Virtual Network Peering resource ID.
    91  
    92  ## Note
    93  
    94  Virtual Network peerings cannot be created, updated or deleted concurrently.
    95  
    96  ## Import
    97  
    98  Virtual Network Peerings can be imported using the `resource id`, e.g. 
    99  
   100  ```
   101  terraform import azurerm_virtual_network_peering.testPeering /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/virtualNetworks/myvnet1/virtualNetworkPeerings/myvnet1peering
   102  ```