Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixArmPeer
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixArmPeer

Explore with Pulumi AI

Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

The aviatrix_arm_peer resource allows the creation and management of Aviatrix ARM peerings.

!> WARNING: The aviatrix.AviatrixArmPeer resource is deprecated as of Release 2.12. It is currently kept for backward-compatibility and will be removed in the future. Please use the Azure peer resource instead. If this is already in the state, please remove it from the state file and import as aviatrix.AviatrixAzurePeer.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix ARM Peering
    var testArmpeer = new Aviatrix.AviatrixArmPeer("testArmpeer", new()
    {
        AccountName1 = "test1-account",
        AccountName2 = "test2-account",
        VnetNameResourceGroup1 = "vpc-abcd1234",
        VnetNameResourceGroup2 = "vpc-rdef3333",
        VnetReg1 = "us-east-1",
        VnetReg2 = "us-west-1",
    });

});
Copy
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.NewAviatrixArmPeer(ctx, "testArmpeer", &aviatrix.AviatrixArmPeerArgs{
			AccountName1:           pulumi.String("test1-account"),
			AccountName2:           pulumi.String("test2-account"),
			VnetNameResourceGroup1: pulumi.String("vpc-abcd1234"),
			VnetNameResourceGroup2: pulumi.String("vpc-rdef3333"),
			VnetReg1:               pulumi.String("us-east-1"),
			VnetReg2:               pulumi.String("us-west-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixArmPeer;
import com.pulumi.aviatrix.AviatrixArmPeerArgs;
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 testArmpeer = new AviatrixArmPeer("testArmpeer", AviatrixArmPeerArgs.builder()        
            .accountName1("test1-account")
            .accountName2("test2-account")
            .vnetNameResourceGroup1("vpc-abcd1234")
            .vnetNameResourceGroup2("vpc-rdef3333")
            .vnetReg1("us-east-1")
            .vnetReg2("us-west-1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Create an Aviatrix ARM Peering
const testArmpeer = new aviatrix.AviatrixArmPeer("test_armpeer", {
    accountName1: "test1-account",
    accountName2: "test2-account",
    vnetNameResourceGroup1: "vpc-abcd1234",
    vnetNameResourceGroup2: "vpc-rdef3333",
    vnetReg1: "us-east-1",
    vnetReg2: "us-west-1",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix ARM Peering
test_armpeer = aviatrix.AviatrixArmPeer("testArmpeer",
    account_name1="test1-account",
    account_name2="test2-account",
    vnet_name_resource_group1="vpc-abcd1234",
    vnet_name_resource_group2="vpc-rdef3333",
    vnet_reg1="us-east-1",
    vnet_reg2="us-west-1")
Copy
resources:
  # Create an Aviatrix ARM Peering
  testArmpeer:
    type: aviatrix:AviatrixArmPeer
    properties:
      accountName1: test1-account
      accountName2: test2-account
      vnetNameResourceGroup1: vpc-abcd1234
      vnetNameResourceGroup2: vpc-rdef3333
      vnetReg1: us-east-1
      vnetReg2: us-west-1
Copy

Create AviatrixArmPeer Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AviatrixArmPeer(name: string, args: AviatrixArmPeerArgs, opts?: CustomResourceOptions);
@overload
def AviatrixArmPeer(resource_name: str,
                    args: AviatrixArmPeerArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def AviatrixArmPeer(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)
func NewAviatrixArmPeer(ctx *Context, name string, args AviatrixArmPeerArgs, opts ...ResourceOption) (*AviatrixArmPeer, error)
public AviatrixArmPeer(string name, AviatrixArmPeerArgs args, CustomResourceOptions? opts = null)
public AviatrixArmPeer(String name, AviatrixArmPeerArgs args)
public AviatrixArmPeer(String name, AviatrixArmPeerArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixArmPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AviatrixArmPeerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AviatrixArmPeerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixArmPeerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AviatrixArmPeerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AviatrixArmPeerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var aviatrixArmPeerResource = new Aviatrix.AviatrixArmPeer("aviatrixArmPeerResource", new()
{
    AccountName1 = "string",
    AccountName2 = "string",
    VnetNameResourceGroup1 = "string",
    VnetNameResourceGroup2 = "string",
    VnetReg1 = "string",
    VnetReg2 = "string",
});
Copy
example, err := aviatrix.NewAviatrixArmPeer(ctx, "aviatrixArmPeerResource", &aviatrix.AviatrixArmPeerArgs{
	AccountName1:           pulumi.String("string"),
	AccountName2:           pulumi.String("string"),
	VnetNameResourceGroup1: pulumi.String("string"),
	VnetNameResourceGroup2: pulumi.String("string"),
	VnetReg1:               pulumi.String("string"),
	VnetReg2:               pulumi.String("string"),
})
Copy
var aviatrixArmPeerResource = new AviatrixArmPeer("aviatrixArmPeerResource", AviatrixArmPeerArgs.builder()
    .accountName1("string")
    .accountName2("string")
    .vnetNameResourceGroup1("string")
    .vnetNameResourceGroup2("string")
    .vnetReg1("string")
    .vnetReg2("string")
    .build());
Copy
aviatrix_arm_peer_resource = aviatrix.AviatrixArmPeer("aviatrixArmPeerResource",
    account_name1="string",
    account_name2="string",
    vnet_name_resource_group1="string",
    vnet_name_resource_group2="string",
    vnet_reg1="string",
    vnet_reg2="string")
Copy
const aviatrixArmPeerResource = new aviatrix.AviatrixArmPeer("aviatrixArmPeerResource", {
    accountName1: "string",
    accountName2: "string",
    vnetNameResourceGroup1: "string",
    vnetNameResourceGroup2: "string",
    vnetReg1: "string",
    vnetReg2: "string",
});
Copy
type: aviatrix:AviatrixArmPeer
properties:
    accountName1: string
    accountName2: string
    vnetNameResourceGroup1: string
    vnetNameResourceGroup2: string
    vnetReg1: string
    vnetReg2: string
Copy

AviatrixArmPeer Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AviatrixArmPeer resource accepts the following input properties:

AccountName1
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
AccountName2
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
VnetNameResourceGroup1
This property is required.
Changes to this property will trigger replacement.
string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetNameResourceGroup2
This property is required.
Changes to this property will trigger replacement.
string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetReg1
This property is required.
Changes to this property will trigger replacement.
string
Region of Azure cloud. Example: "East US 2".
VnetReg2
This property is required.
Changes to this property will trigger replacement.
string
Region of Azure cloud. Example: "East US 2".
AccountName1
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
AccountName2
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
VnetNameResourceGroup1
This property is required.
Changes to this property will trigger replacement.
string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetNameResourceGroup2
This property is required.
Changes to this property will trigger replacement.
string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetReg1
This property is required.
Changes to this property will trigger replacement.
string
Region of Azure cloud. Example: "East US 2".
VnetReg2
This property is required.
Changes to this property will trigger replacement.
string
Region of Azure cloud. Example: "East US 2".
accountName1
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
accountName2
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
vnetNameResourceGroup1
This property is required.
Changes to this property will trigger replacement.
String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetNameResourceGroup2
This property is required.
Changes to this property will trigger replacement.
String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetReg1
This property is required.
Changes to this property will trigger replacement.
String
Region of Azure cloud. Example: "East US 2".
vnetReg2
This property is required.
Changes to this property will trigger replacement.
String
Region of Azure cloud. Example: "East US 2".
accountName1
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
accountName2
This property is required.
Changes to this property will trigger replacement.
string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
vnetNameResourceGroup1
This property is required.
Changes to this property will trigger replacement.
string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetNameResourceGroup2
This property is required.
Changes to this property will trigger replacement.
string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetReg1
This property is required.
Changes to this property will trigger replacement.
string
Region of Azure cloud. Example: "East US 2".
vnetReg2
This property is required.
Changes to this property will trigger replacement.
string
Region of Azure cloud. Example: "East US 2".
account_name1
This property is required.
Changes to this property will trigger replacement.
str
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
account_name2
This property is required.
Changes to this property will trigger replacement.
str
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
vnet_name_resource_group1
This property is required.
Changes to this property will trigger replacement.
str
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnet_name_resource_group2
This property is required.
Changes to this property will trigger replacement.
str
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnet_reg1
This property is required.
Changes to this property will trigger replacement.
str
Region of Azure cloud. Example: "East US 2".
vnet_reg2
This property is required.
Changes to this property will trigger replacement.
str
Region of Azure cloud. Example: "East US 2".
accountName1
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
accountName2
This property is required.
Changes to this property will trigger replacement.
String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
vnetNameResourceGroup1
This property is required.
Changes to this property will trigger replacement.
String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetNameResourceGroup2
This property is required.
Changes to this property will trigger replacement.
String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetReg1
This property is required.
Changes to this property will trigger replacement.
String
Region of Azure cloud. Example: "East US 2".
vnetReg2
This property is required.
Changes to this property will trigger replacement.
String
Region of Azure cloud. Example: "East US 2".

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixArmPeer 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 AviatrixArmPeer Resource

Get an existing AviatrixArmPeer 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?: AviatrixArmPeerState, opts?: CustomResourceOptions): AviatrixArmPeer
@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) -> AviatrixArmPeer
func GetAviatrixArmPeer(ctx *Context, name string, id IDInput, state *AviatrixArmPeerState, opts ...ResourceOption) (*AviatrixArmPeer, error)
public static AviatrixArmPeer Get(string name, Input<string> id, AviatrixArmPeerState? state, CustomResourceOptions? opts = null)
public static AviatrixArmPeer get(String name, Output<String> id, AviatrixArmPeerState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixArmPeer    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
AccountName2 Changes to this property will trigger replacement. string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
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 Changes to this property will trigger replacement. string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetNameResourceGroup2 Changes to this property will trigger replacement. string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetReg1 Changes to this property will trigger replacement. string
Region of Azure cloud. Example: "East US 2".
VnetReg2 Changes to this property will trigger replacement. string
Region of Azure cloud. Example: "East US 2".
AccountName1 Changes to this property will trigger replacement. string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
AccountName2 Changes to this property will trigger replacement. string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
VnetCidr1s []string
List of VNet CIDR of vnet_name_resource_group1.
VnetCidr2s []string
List of VNet CIDR of vnet_name_resource_group2.
VnetNameResourceGroup1 Changes to this property will trigger replacement. string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetNameResourceGroup2 Changes to this property will trigger replacement. string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
VnetReg1 Changes to this property will trigger replacement. string
Region of Azure cloud. Example: "East US 2".
VnetReg2 Changes to this property will trigger replacement. string
Region of Azure cloud. Example: "East US 2".
accountName1 Changes to this property will trigger replacement. String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
accountName2 Changes to this property will trigger replacement. String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
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 Changes to this property will trigger replacement. String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetNameResourceGroup2 Changes to this property will trigger replacement. String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetReg1 Changes to this property will trigger replacement. String
Region of Azure cloud. Example: "East US 2".
vnetReg2 Changes to this property will trigger replacement. String
Region of Azure cloud. Example: "East US 2".
accountName1 Changes to this property will trigger replacement. string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
accountName2 Changes to this property will trigger replacement. string
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
vnetCidr1s string[]
List of VNet CIDR of vnet_name_resource_group1.
vnetCidr2s string[]
List of VNet CIDR of vnet_name_resource_group2.
vnetNameResourceGroup1 Changes to this property will trigger replacement. string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetNameResourceGroup2 Changes to this property will trigger replacement. string
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetReg1 Changes to this property will trigger replacement. string
Region of Azure cloud. Example: "East US 2".
vnetReg2 Changes to this property will trigger replacement. string
Region of Azure cloud. Example: "East US 2".
account_name1 Changes to this property will trigger replacement. str
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
account_name2 Changes to this property will trigger replacement. str
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
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 Changes to this property will trigger replacement. str
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnet_name_resource_group2 Changes to this property will trigger replacement. str
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnet_reg1 Changes to this property will trigger replacement. str
Region of Azure cloud. Example: "East US 2".
vnet_reg2 Changes to this property will trigger replacement. str
Region of Azure cloud. Example: "East US 2".
accountName1 Changes to this property will trigger replacement. String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
accountName2 Changes to this property will trigger replacement. String
This parameter represents the name of an Azure Cloud-Account in Aviatrix controller.
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 Changes to this property will trigger replacement. String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetNameResourceGroup2 Changes to this property will trigger replacement. String
VNet-Name of Azure cloud. Example: "VNet_Name:Resource_Group_Name".
vnetReg1 Changes to this property will trigger replacement. String
Region of Azure cloud. Example: "East US 2".
vnetReg2 Changes to this property will trigger replacement. String
Region of Azure cloud. Example: "East US 2".

Import

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

 $ pulumi import aviatrix:index/aviatrixArmPeer:AviatrixArmPeer test vnet_name_resource_group1~vnet_name_resource_group2
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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