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

aviatrix.AviatrixAzureSpokeNativePeering

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by 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",
        });
    
    });
    
    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
    	})
    }
    
    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());
    
        }
    }
    
    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")
    
    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",
    });
    
    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
    

    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 string
    The unique name of the resource.
    args AviatrixAzureSpokeNativePeeringArgs
    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 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 string
    The unique name of the resource.
    args AviatrixAzureSpokeNativePeeringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixAzureSpokeNativePeeringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
    });
    
    example, err := aviatrix.NewAviatrixAzureSpokeNativePeering(ctx, "aviatrixAzureSpokeNativePeeringResource", &aviatrix.AviatrixAzureSpokeNativePeeringArgs{
    	SpokeAccountName:   pulumi.String("string"),
    	SpokeRegion:        pulumi.String("string"),
    	SpokeVpcId:         pulumi.String("string"),
    	TransitGatewayName: pulumi.String("string"),
    })
    
    var aviatrixAzureSpokeNativePeeringResource = new AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource", AviatrixAzureSpokeNativePeeringArgs.builder()
        .spokeAccountName("string")
        .spokeRegion("string")
        .spokeVpcId("string")
        .transitGatewayName("string")
        .build());
    
    aviatrix_azure_spoke_native_peering_resource = aviatrix.AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource",
        spoke_account_name="string",
        spoke_region="string",
        spoke_vpc_id="string",
        transit_gateway_name="string")
    
    const aviatrixAzureSpokeNativePeeringResource = new aviatrix.AviatrixAzureSpokeNativePeering("aviatrixAzureSpokeNativePeeringResource", {
        spokeAccountName: "string",
        spokeRegion: "string",
        spokeVpcId: "string",
        transitGatewayName: "string",
    });
    
    type: aviatrix:AviatrixAzureSpokeNativePeering
    properties:
        spokeAccountName: string
        spokeRegion: string
        spokeVpcId: string
        transitGatewayName: string
    

    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

    The AviatrixAzureSpokeNativePeering resource accepts the following input properties:

    SpokeAccountName string
    An Aviatrix account that corresponds to a subscription in Azure.
    SpokeRegion string
    Spoke VNet region. Example: "West US".
    SpokeVpcId string
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    TransitGatewayName string
    Name of an Transit FireNet-enabled Azure transit gateway.
    SpokeAccountName string
    An Aviatrix account that corresponds to a subscription in Azure.
    SpokeRegion string
    Spoke VNet region. Example: "West US".
    SpokeVpcId string
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    TransitGatewayName string
    Name of an Transit FireNet-enabled Azure transit gateway.
    spokeAccountName String
    An Aviatrix account that corresponds to a subscription in Azure.
    spokeRegion String
    Spoke VNet region. Example: "West US".
    spokeVpcId String
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transitGatewayName String
    Name of an Transit FireNet-enabled Azure transit gateway.
    spokeAccountName string
    An Aviatrix account that corresponds to a subscription in Azure.
    spokeRegion string
    Spoke VNet region. Example: "West US".
    spokeVpcId string
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transitGatewayName string
    Name of an Transit FireNet-enabled Azure transit gateway.
    spoke_account_name str
    An Aviatrix account that corresponds to a subscription in Azure.
    spoke_region str
    Spoke VNet region. Example: "West US".
    spoke_vpc_id str
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transit_gateway_name str
    Name of an Transit FireNet-enabled Azure transit gateway.
    spokeAccountName String
    An Aviatrix account that corresponds to a subscription in Azure.
    spokeRegion String
    Spoke VNet region. Example: "West US".
    spokeVpcId String
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transitGatewayName 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)
    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:
    SpokeAccountName string
    An Aviatrix account that corresponds to a subscription in Azure.
    SpokeRegion string
    Spoke VNet region. Example: "West US".
    SpokeVpcId string
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    TransitGatewayName string
    Name of an Transit FireNet-enabled Azure transit gateway.
    SpokeAccountName string
    An Aviatrix account that corresponds to a subscription in Azure.
    SpokeRegion string
    Spoke VNet region. Example: "West US".
    SpokeVpcId string
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    TransitGatewayName string
    Name of an Transit FireNet-enabled Azure transit gateway.
    spokeAccountName String
    An Aviatrix account that corresponds to a subscription in Azure.
    spokeRegion String
    Spoke VNet region. Example: "West US".
    spokeVpcId String
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transitGatewayName String
    Name of an Transit FireNet-enabled Azure transit gateway.
    spokeAccountName string
    An Aviatrix account that corresponds to a subscription in Azure.
    spokeRegion string
    Spoke VNet region. Example: "West US".
    spokeVpcId string
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transitGatewayName string
    Name of an Transit FireNet-enabled Azure transit gateway.
    spoke_account_name str
    An Aviatrix account that corresponds to a subscription in Azure.
    spoke_region str
    Spoke VNet region. Example: "West US".
    spoke_vpc_id str
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transit_gateway_name str
    Name of an Transit FireNet-enabled Azure transit gateway.
    spokeAccountName String
    An Aviatrix account that corresponds to a subscription in Azure.
    spokeRegion String
    Spoke VNet region. Example: "West US".
    spokeVpcId String
    Combination of the Spoke's VNet name, resource group and GUID. Example: "Foo_VNet:Bar_RG:GUID".
    transitGatewayName 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
    

    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 logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix