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

aviatrix.AviatrixAzureSpokeNativePeering

Explore with Pulumi AI

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

The aviatrix_azure_spoke_native_peering resource allows the creation and management of Aviatrix-created Azure Spoke VNet attachments via Native Peering.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    // Create an Aviatrix Azure spoke native peering
    var test = new Aviatrix.AviatrixAzureSpokeNativePeering("test", new()
    {
        SpokeAccountName = "devops-azure",
        SpokeRegion = "West US",
        SpokeVpcId = "Foo_VNet:Bar_RG:GUID",
        TransitGatewayName = "transit-gw-azure",
    });

});
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.NewAviatrixAzureSpokeNativePeering(ctx, "test", &aviatrix.AviatrixAzureSpokeNativePeeringArgs{
			SpokeAccountName:   pulumi.String("devops-azure"),
			SpokeRegion:        pulumi.String("West US"),
			SpokeVpcId:         pulumi.String("Foo_VNet:Bar_RG:GUID"),
			TransitGatewayName: pulumi.String("transit-gw-azure"),
		})
		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.AviatrixAzureSpokeNativePeering;
import com.pulumi.aviatrix.AviatrixAzureSpokeNativePeeringArgs;
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 test = new AviatrixAzureSpokeNativePeering("test", AviatrixAzureSpokeNativePeeringArgs.builder()        
            .spokeAccountName("devops-azure")
            .spokeRegion("West US")
            .spokeVpcId("Foo_VNet:Bar_RG:GUID")
            .transitGatewayName("transit-gw-azure")
            .build());

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

// Create an Aviatrix Azure spoke native peering
const test = new aviatrix.AviatrixAzureSpokeNativePeering("test", {
    spokeAccountName: "devops-azure",
    spokeRegion: "West US",
    spokeVpcId: "Foo_VNet:Bar_RG:GUID",
    transitGatewayName: "transit-gw-azure",
});
Copy
import pulumi
import pulumi_aviatrix as aviatrix

# Create an Aviatrix Azure spoke native peering
test = aviatrix.AviatrixAzureSpokeNativePeering("test",
    spoke_account_name="devops-azure",
    spoke_region="West US",
    spoke_vpc_id="Foo_VNet:Bar_RG:GUID",
    transit_gateway_name="transit-gw-azure")
Copy
resources:
  # Create an Aviatrix Azure spoke native peering
  test:
    type: aviatrix:AviatrixAzureSpokeNativePeering
    properties:
      spokeAccountName: devops-azure
      spokeRegion: West US
      spokeVpcId: Foo_VNet:Bar_RG:GUID
      transitGatewayName: transit-gw-azure
Copy

Create AviatrixAzureSpokeNativePeering Resource

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

Constructor syntax

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

@overload
def AviatrixAzureSpokeNativePeering(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    spoke_account_name: Optional[str] = None,
                                    spoke_region: Optional[str] = None,
                                    spoke_vpc_id: Optional[str] = None,
                                    transit_gateway_name: Optional[str] = None)
func NewAviatrixAzureSpokeNativePeering(ctx *Context, name string, args AviatrixAzureSpokeNativePeeringArgs, opts ...ResourceOption) (*AviatrixAzureSpokeNativePeering, error)
public AviatrixAzureSpokeNativePeering(string name, AviatrixAzureSpokeNativePeeringArgs args, CustomResourceOptions? opts = null)
public AviatrixAzureSpokeNativePeering(String name, AviatrixAzureSpokeNativePeeringArgs args)
public AviatrixAzureSpokeNativePeering(String name, AviatrixAzureSpokeNativePeeringArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixAzureSpokeNativePeering
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. AviatrixAzureSpokeNativePeeringArgs
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. AviatrixAzureSpokeNativePeeringArgs
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. AviatrixAzureSpokeNativePeeringArgs
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. AviatrixAzureSpokeNativePeeringArgs
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. AviatrixAzureSpokeNativePeeringArgs
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 aviatrixAzureSpokeNativePeeringResource = new Aviatrix.AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource", new()
{
    SpokeAccountName = "string",
    SpokeRegion = "string",
    SpokeVpcId = "string",
    TransitGatewayName = "string",
});
Copy
example, err := aviatrix.NewAviatrixAzureSpokeNativePeering(ctx, "aviatrixAzureSpokeNativePeeringResource", &aviatrix.AviatrixAzureSpokeNativePeeringArgs{
	SpokeAccountName:   pulumi.String("string"),
	SpokeRegion:        pulumi.String("string"),
	SpokeVpcId:         pulumi.String("string"),
	TransitGatewayName: pulumi.String("string"),
})
Copy
var aviatrixAzureSpokeNativePeeringResource = new AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource", AviatrixAzureSpokeNativePeeringArgs.builder()
    .spokeAccountName("string")
    .spokeRegion("string")
    .spokeVpcId("string")
    .transitGatewayName("string")
    .build());
Copy
aviatrix_azure_spoke_native_peering_resource = aviatrix.AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource",
    spoke_account_name="string",
    spoke_region="string",
    spoke_vpc_id="string",
    transit_gateway_name="string")
Copy
const aviatrixAzureSpokeNativePeeringResource = new aviatrix.AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource", {
    spokeAccountName: "string",
    spokeRegion: "string",
    spokeVpcId: "string",
    transitGatewayName: "string",
});
Copy
type: aviatrix:AviatrixAzureSpokeNativePeering
properties:
    spokeAccountName: string
    spokeRegion: string
    spokeVpcId: string
    transitGatewayName: string
Copy

AviatrixAzureSpokeNativePeering 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 AviatrixAzureSpokeNativePeering resource accepts the following input properties:

SpokeAccountName
This property is required.
Changes to this property will trigger replacement.
string
An Aviatrix account that corresponds to a subscription in Azure.
SpokeRegion
This property is required.
Changes to this property will trigger replacement.
string
Spoke VNet region. Example: "West US".
SpokeVpcId
This property is required.
Changes to this property will trigger replacement.
string
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
TransitGatewayName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Transit FireNet-enabled Azure transit gateway.
SpokeAccountName
This property is required.
Changes to this property will trigger replacement.
string
An Aviatrix account that corresponds to a subscription in Azure.
SpokeRegion
This property is required.
Changes to this property will trigger replacement.
string
Spoke VNet region. Example: "West US".
SpokeVpcId
This property is required.
Changes to this property will trigger replacement.
string
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
TransitGatewayName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Transit FireNet-enabled Azure transit gateway.
spokeAccountName
This property is required.
Changes to this property will trigger replacement.
String
An Aviatrix account that corresponds to a subscription in Azure.
spokeRegion
This property is required.
Changes to this property will trigger replacement.
String
Spoke VNet region. Example: "West US".
spokeVpcId
This property is required.
Changes to this property will trigger replacement.
String
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transitGatewayName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Transit FireNet-enabled Azure transit gateway.
spokeAccountName
This property is required.
Changes to this property will trigger replacement.
string
An Aviatrix account that corresponds to a subscription in Azure.
spokeRegion
This property is required.
Changes to this property will trigger replacement.
string
Spoke VNet region. Example: "West US".
spokeVpcId
This property is required.
Changes to this property will trigger replacement.
string
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transitGatewayName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Transit FireNet-enabled Azure transit gateway.
spoke_account_name
This property is required.
Changes to this property will trigger replacement.
str
An Aviatrix account that corresponds to a subscription in Azure.
spoke_region
This property is required.
Changes to this property will trigger replacement.
str
Spoke VNet region. Example: "West US".
spoke_vpc_id
This property is required.
Changes to this property will trigger replacement.
str
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transit_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Transit FireNet-enabled Azure transit gateway.
spokeAccountName
This property is required.
Changes to this property will trigger replacement.
String
An Aviatrix account that corresponds to a subscription in Azure.
spokeRegion
This property is required.
Changes to this property will trigger replacement.
String
Spoke VNet region. Example: "West US".
spokeVpcId
This property is required.
Changes to this property will trigger replacement.
String
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transitGatewayName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Transit FireNet-enabled Azure transit gateway.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AviatrixAzureSpokeNativePeering Resource

Get an existing AviatrixAzureSpokeNativePeering 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?: AviatrixAzureSpokeNativePeeringState, opts?: CustomResourceOptions): AviatrixAzureSpokeNativePeering
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        spoke_account_name: Optional[str] = None,
        spoke_region: Optional[str] = None,
        spoke_vpc_id: Optional[str] = None,
        transit_gateway_name: Optional[str] = None) -> AviatrixAzureSpokeNativePeering
func GetAviatrixAzureSpokeNativePeering(ctx *Context, name string, id IDInput, state *AviatrixAzureSpokeNativePeeringState, opts ...ResourceOption) (*AviatrixAzureSpokeNativePeering, error)
public static AviatrixAzureSpokeNativePeering Get(string name, Input<string> id, AviatrixAzureSpokeNativePeeringState? state, CustomResourceOptions? opts = null)
public static AviatrixAzureSpokeNativePeering get(String name, Output<String> id, AviatrixAzureSpokeNativePeeringState state, CustomResourceOptions options)
resources:  _:    type: aviatrix:AviatrixAzureSpokeNativePeering    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:
SpokeAccountName Changes to this property will trigger replacement. string
An Aviatrix account that corresponds to a subscription in Azure.
SpokeRegion Changes to this property will trigger replacement. string
Spoke VNet region. Example: "West US".
SpokeVpcId Changes to this property will trigger replacement. string
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
TransitGatewayName Changes to this property will trigger replacement. string
Name of an Transit FireNet-enabled Azure transit gateway.
SpokeAccountName Changes to this property will trigger replacement. string
An Aviatrix account that corresponds to a subscription in Azure.
SpokeRegion Changes to this property will trigger replacement. string
Spoke VNet region. Example: "West US".
SpokeVpcId Changes to this property will trigger replacement. string
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
TransitGatewayName Changes to this property will trigger replacement. string
Name of an Transit FireNet-enabled Azure transit gateway.
spokeAccountName Changes to this property will trigger replacement. String
An Aviatrix account that corresponds to a subscription in Azure.
spokeRegion Changes to this property will trigger replacement. String
Spoke VNet region. Example: "West US".
spokeVpcId Changes to this property will trigger replacement. String
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transitGatewayName Changes to this property will trigger replacement. String
Name of an Transit FireNet-enabled Azure transit gateway.
spokeAccountName Changes to this property will trigger replacement. string
An Aviatrix account that corresponds to a subscription in Azure.
spokeRegion Changes to this property will trigger replacement. string
Spoke VNet region. Example: "West US".
spokeVpcId Changes to this property will trigger replacement. string
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transitGatewayName Changes to this property will trigger replacement. string
Name of an Transit FireNet-enabled Azure transit gateway.
spoke_account_name Changes to this property will trigger replacement. str
An Aviatrix account that corresponds to a subscription in Azure.
spoke_region Changes to this property will trigger replacement. str
Spoke VNet region. Example: "West US".
spoke_vpc_id Changes to this property will trigger replacement. str
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transit_gateway_name Changes to this property will trigger replacement. str
Name of an Transit FireNet-enabled Azure transit gateway.
spokeAccountName Changes to this property will trigger replacement. String
An Aviatrix account that corresponds to a subscription in Azure.
spokeRegion Changes to this property will trigger replacement. String
Spoke VNet region. Example: "West US".
spokeVpcId Changes to this property will trigger replacement. String
Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
transitGatewayName Changes to this property will trigger replacement. String
Name of an Transit FireNet-enabled Azure transit gateway.

Import

azure_spoke_native_peering can be imported using the transit_gateway_name, spoke_account_name and spoke_vpc_id, e.g.

 $ pulumi import aviatrix:index/aviatrixAzureSpokeNativePeering:AviatrixAzureSpokeNativePeering test transit_gateway_name~spoke_account_name~spoke_vpc_id
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