1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixAzurePeer
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

aviatrix.AviatrixAzurePeer

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix

    The aviatrix_azure_peer resource allows the creation and management of the Aviatrix-created peerings between Azure VNets.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Aviatrix = Pulumi.Aviatrix;
    
    return await Deployment.RunAsync(() => 
    {
        // Create an Aviatrix Azure Peering
        var testAzurepeer = new Aviatrix.AviatrixAzurePeer("testAzurepeer", new()
        {
            AccountName1 = "test1-account",
            AccountName2 = "test2-account",
            VnetNameResourceGroup1 = "Foo_VNet1:Bar_RG1:GUID1",
            VnetNameResourceGroup2 = "Foo_VNet2:Bar_RG2:GUID2",
            VnetReg1 = "Central US",
            VnetReg2 = "East US",
        });
    
    });
    
    package main
    
    import (
    	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aviatrix.NewAviatrixAzurePeer(ctx, "testAzurepeer", &aviatrix.AviatrixAzurePeerArgs{
    			AccountName1:           pulumi.String("test1-account"),
    			AccountName2:           pulumi.String("test2-account"),
    			VnetNameResourceGroup1: pulumi.String("Foo_VNet1:Bar_RG1:GUID1"),
    			VnetNameResourceGroup2: pulumi.String("Foo_VNet2:Bar_RG2:GUID2"),
    			VnetReg1:               pulumi.String("Central US"),
    			VnetReg2:               pulumi.String("East US"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aviatrix.AviatrixAzurePeer;
    import com.pulumi.aviatrix.AviatrixAzurePeerArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testAzurepeer = new AviatrixAzurePeer("testAzurepeer", AviatrixAzurePeerArgs.builder()        
                .accountName1("test1-account")
                .accountName2("test2-account")
                .vnetNameResourceGroup1("Foo_VNet1:Bar_RG1:GUID1")
                .vnetNameResourceGroup2("Foo_VNet2:Bar_RG2:GUID2")
                .vnetReg1("Central US")
                .vnetReg2("East US")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aviatrix as aviatrix
    
    # Create an Aviatrix Azure Peering
    test_azurepeer = aviatrix.AviatrixAzurePeer("testAzurepeer",
        account_name1="test1-account",
        account_name2="test2-account",
        vnet_name_resource_group1="Foo_VNet1:Bar_RG1:GUID1",
        vnet_name_resource_group2="Foo_VNet2:Bar_RG2:GUID2",
        vnet_reg1="Central US",
        vnet_reg2="East US")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aviatrix from "@pulumi/aviatrix";
    
    // Create an Aviatrix Azure Peering
    const testAzurepeer = new aviatrix.AviatrixAzurePeer("test_azurepeer", {
        accountName1: "test1-account",
        accountName2: "test2-account",
        vnetNameResourceGroup1: "Foo_VNet1:Bar_RG1:GUID1",
        vnetNameResourceGroup2: "Foo_VNet2:Bar_RG2:GUID2",
        vnetReg1: "Central US",
        vnetReg2: "East US",
    });
    
    resources:
      # Create an Aviatrix Azure Peering
      testAzurepeer:
        type: aviatrix:AviatrixAzurePeer
        properties:
          accountName1: test1-account
          accountName2: test2-account
          vnetNameResourceGroup1: Foo_VNet1:Bar_RG1:GUID1
          vnetNameResourceGroup2: Foo_VNet2:Bar_RG2:GUID2
          vnetReg1: Central US
          vnetReg2: East US
    

    Create AviatrixAzurePeer Resource

    new AviatrixAzurePeer(name: string, args: AviatrixAzurePeerArgs, opts?: CustomResourceOptions);
    @overload
    def AviatrixAzurePeer(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          account_name1: Optional[str] = None,
                          account_name2: Optional[str] = None,
                          vnet_name_resource_group1: Optional[str] = None,
                          vnet_name_resource_group2: Optional[str] = None,
                          vnet_reg1: Optional[str] = None,
                          vnet_reg2: Optional[str] = None)
    @overload
    def AviatrixAzurePeer(resource_name: str,
                          args: AviatrixAzurePeerArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewAviatrixAzurePeer(ctx *Context, name string, args AviatrixAzurePeerArgs, opts ...ResourceOption) (*AviatrixAzurePeer, error)
    public AviatrixAzurePeer(string name, AviatrixAzurePeerArgs args, CustomResourceOptions? opts = null)
    public AviatrixAzurePeer(String name, AviatrixAzurePeerArgs args)
    public AviatrixAzurePeer(String name, AviatrixAzurePeerArgs args, CustomResourceOptions options)
    
    type: aviatrix:AviatrixAzurePeer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AviatrixAzurePeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AviatrixAzurePeerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AviatrixAzurePeerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAzurePeerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixAzurePeerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AviatrixAzurePeer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AviatrixAzurePeer resource accepts the following input properties:

    AccountName1 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    AccountName2 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    VnetNameResourceGroup1 string
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    VnetNameResourceGroup2 string
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    VnetReg1 string
    Region of Azure VNet 1. Example: "East US 2".
    VnetReg2 string
    Region of Azure VNet 2. Example: "East US 2".
    AccountName1 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    AccountName2 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    VnetNameResourceGroup1 string
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    VnetNameResourceGroup2 string
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    VnetReg1 string
    Region of Azure VNet 1. Example: "East US 2".
    VnetReg2 string
    Region of Azure VNet 2. Example: "East US 2".
    accountName1 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    accountName2 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnetNameResourceGroup1 String
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnetNameResourceGroup2 String
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnetReg1 String
    Region of Azure VNet 1. Example: "East US 2".
    vnetReg2 String
    Region of Azure VNet 2. Example: "East US 2".
    accountName1 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    accountName2 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnetNameResourceGroup1 string
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnetNameResourceGroup2 string
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnetReg1 string
    Region of Azure VNet 1. Example: "East US 2".
    vnetReg2 string
    Region of Azure VNet 2. Example: "East US 2".
    account_name1 str
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    account_name2 str
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnet_name_resource_group1 str
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnet_name_resource_group2 str
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnet_reg1 str
    Region of Azure VNet 1. Example: "East US 2".
    vnet_reg2 str
    Region of Azure VNet 2. Example: "East US 2".
    accountName1 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    accountName2 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnetNameResourceGroup1 String
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnetNameResourceGroup2 String
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnetReg1 String
    Region of Azure VNet 1. Example: "East US 2".
    vnetReg2 String
    Region of Azure VNet 2. Example: "East US 2".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AviatrixAzurePeer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VnetCidr1s List<string>
    List of VNet CIDR of vnet_name_resource_group1.
    VnetCidr2s List<string>
    List of VNet CIDR of vnet_name_resource_group2.
    Id string
    The provider-assigned unique ID for this managed resource.
    VnetCidr1s []string
    List of VNet CIDR of vnet_name_resource_group1.
    VnetCidr2s []string
    List of VNet CIDR of vnet_name_resource_group2.
    id String
    The provider-assigned unique ID for this managed resource.
    vnetCidr1s List<String>
    List of VNet CIDR of vnet_name_resource_group1.
    vnetCidr2s List<String>
    List of VNet CIDR of vnet_name_resource_group2.
    id string
    The provider-assigned unique ID for this managed resource.
    vnetCidr1s string[]
    List of VNet CIDR of vnet_name_resource_group1.
    vnetCidr2s string[]
    List of VNet CIDR of vnet_name_resource_group2.
    id str
    The provider-assigned unique ID for this managed resource.
    vnet_cidr1s Sequence[str]
    List of VNet CIDR of vnet_name_resource_group1.
    vnet_cidr2s Sequence[str]
    List of VNet CIDR of vnet_name_resource_group2.
    id String
    The provider-assigned unique ID for this managed resource.
    vnetCidr1s List<String>
    List of VNet CIDR of vnet_name_resource_group1.
    vnetCidr2s List<String>
    List of VNet CIDR of vnet_name_resource_group2.

    Look up Existing AviatrixAzurePeer Resource

    Get an existing AviatrixAzurePeer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AviatrixAzurePeerState, opts?: CustomResourceOptions): AviatrixAzurePeer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name1: Optional[str] = None,
            account_name2: Optional[str] = None,
            vnet_cidr1s: Optional[Sequence[str]] = None,
            vnet_cidr2s: Optional[Sequence[str]] = None,
            vnet_name_resource_group1: Optional[str] = None,
            vnet_name_resource_group2: Optional[str] = None,
            vnet_reg1: Optional[str] = None,
            vnet_reg2: Optional[str] = None) -> AviatrixAzurePeer
    func GetAviatrixAzurePeer(ctx *Context, name string, id IDInput, state *AviatrixAzurePeerState, opts ...ResourceOption) (*AviatrixAzurePeer, error)
    public static AviatrixAzurePeer Get(string name, Input<string> id, AviatrixAzurePeerState? state, CustomResourceOptions? opts = null)
    public static AviatrixAzurePeer get(String name, Output<String> id, AviatrixAzurePeerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountName1 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    AccountName2 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    VnetCidr1s List<string>
    List of VNet CIDR of vnet_name_resource_group1.
    VnetCidr2s List<string>
    List of VNet CIDR of vnet_name_resource_group2.
    VnetNameResourceGroup1 string
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    VnetNameResourceGroup2 string
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    VnetReg1 string
    Region of Azure VNet 1. Example: "East US 2".
    VnetReg2 string
    Region of Azure VNet 2. Example: "East US 2".
    AccountName1 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    AccountName2 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    VnetCidr1s []string
    List of VNet CIDR of vnet_name_resource_group1.
    VnetCidr2s []string
    List of VNet CIDR of vnet_name_resource_group2.
    VnetNameResourceGroup1 string
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    VnetNameResourceGroup2 string
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    VnetReg1 string
    Region of Azure VNet 1. Example: "East US 2".
    VnetReg2 string
    Region of Azure VNet 2. Example: "East US 2".
    accountName1 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    accountName2 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnetCidr1s List<String>
    List of VNet CIDR of vnet_name_resource_group1.
    vnetCidr2s List<String>
    List of VNet CIDR of vnet_name_resource_group2.
    vnetNameResourceGroup1 String
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnetNameResourceGroup2 String
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnetReg1 String
    Region of Azure VNet 1. Example: "East US 2".
    vnetReg2 String
    Region of Azure VNet 2. Example: "East US 2".
    accountName1 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    accountName2 string
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnetCidr1s string[]
    List of VNet CIDR of vnet_name_resource_group1.
    vnetCidr2s string[]
    List of VNet CIDR of vnet_name_resource_group2.
    vnetNameResourceGroup1 string
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnetNameResourceGroup2 string
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnetReg1 string
    Region of Azure VNet 1. Example: "East US 2".
    vnetReg2 string
    Region of Azure VNet 2. Example: "East US 2".
    account_name1 str
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    account_name2 str
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnet_cidr1s Sequence[str]
    List of VNet CIDR of vnet_name_resource_group1.
    vnet_cidr2s Sequence[str]
    List of VNet CIDR of vnet_name_resource_group2.
    vnet_name_resource_group1 str
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnet_name_resource_group2 str
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnet_reg1 str
    Region of Azure VNet 1. Example: "East US 2".
    vnet_reg2 str
    Region of Azure VNet 2. Example: "East US 2".
    accountName1 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 1.
    accountName2 String
    Name of the Azure cloud account in the Aviatrix controller for VNet 2.
    vnetCidr1s List<String>
    List of VNet CIDR of vnet_name_resource_group1.
    vnetCidr2s List<String>
    List of VNet CIDR of vnet_name_resource_group2.
    vnetNameResourceGroup1 String
    Azure VNet 1's name. Example: "VNet_Name1:Resource_Group_Name1:GUID1".
    vnetNameResourceGroup2 String
    Azure VNet 2's name. Example: "VNet_Name2:Resource_Group_Name2:GUID2".
    vnetReg1 String
    Region of Azure VNet 1. Example: "East US 2".
    vnetReg2 String
    Region of Azure VNet 2. Example: "East US 2".

    Import

    azure_peer can be imported using the vnet_name_resource_group1 and vnet_name_resource_group2, e.g.

     $ pulumi import aviatrix:index/aviatrixAzurePeer:AviatrixAzurePeer test vnet_name_resource_group1~vnet_name_resource_group2
    

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix