Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. orbital
  5. L2Connection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.orbital.L2Connection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Connects an edge site to an orbital gateway and describes what layer 2 traffic to forward between them. Azure REST API version: 2024-03-01-preview.

    Other available API versions: 2024-03-01.

    Example Usage

    Create L2 Connection

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var l2Connection = new AzureNative.Orbital.L2Connection("l2Connection", new()
    {
        EdgeSite = new AzureNative.Orbital.Inputs.L2ConnectionsPropertiesEdgeSiteArgs
        {
            Id = "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1",
        },
        GroundStation = new AzureNative.Orbital.Inputs.L2ConnectionsPropertiesGroundStationArgs
        {
            Id = "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1",
        },
        L2ConnectionName = "connection1",
        Location = "westus",
        Name = "customerName-SiteName-01",
        ResourceGroupName = "rg1",
        Tags = 
        {
            { "tag1", "value1" },
            { "tag2", "value2" },
        },
        VlanId = 200,
    });

});

    package main

import (
	orbital "github.com/pulumi/pulumi-azure-native-sdk/orbital/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := orbital.NewL2Connection(ctx, "l2Connection", &orbital.L2ConnectionArgs{
			EdgeSite: &orbital.L2ConnectionsPropertiesEdgeSiteArgs{
				Id: pulumi.String("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1"),
			},
			GroundStation: &orbital.L2ConnectionsPropertiesGroundStationArgs{
				Id: pulumi.String("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1"),
			},
			L2ConnectionName:  pulumi.String("connection1"),
			Location:          pulumi.String("westus"),
			Name:              pulumi.String("customerName-SiteName-01"),
			ResourceGroupName: pulumi.String("rg1"),
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
			},
			VlanId: pulumi.Int(200),
		})
		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.azurenative.orbital.L2Connection;
import com.pulumi.azurenative.orbital.L2ConnectionArgs;
import com.pulumi.azurenative.orbital.inputs.L2ConnectionsPropertiesEdgeSiteArgs;
import com.pulumi.azurenative.orbital.inputs.L2ConnectionsPropertiesGroundStationArgs;
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 l2Connection = new L2Connection("l2Connection", L2ConnectionArgs.builder()
            .edgeSite(L2ConnectionsPropertiesEdgeSiteArgs.builder()
                .id("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1")
                .build())
            .groundStation(L2ConnectionsPropertiesGroundStationArgs.builder()
                .id("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1")
                .build())
            .l2ConnectionName("connection1")
            .location("westus")
            .name("customerName-SiteName-01")
            .resourceGroupName("rg1")
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2")
            ))
            .vlanId(200)
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

l2_connection = azure_native.orbital.L2Connection("l2Connection",
    edge_site={
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1",
    },
    ground_station={
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1",
    },
    l2_connection_name="connection1",
    location="westus",
    name="customerName-SiteName-01",
    resource_group_name="rg1",
    tags={
        "tag1": "value1",
        "tag2": "value2",
    },
    vlan_id=200)

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const l2Connection = new azure_native.orbital.L2Connection("l2Connection", {
    edgeSite: {
        id: "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1",
    },
    groundStation: {
        id: "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1",
    },
    l2ConnectionName: "connection1",
    location: "westus",
    name: "customerName-SiteName-01",
    resourceGroupName: "rg1",
    tags: {
        tag1: "value1",
        tag2: "value2",
    },
    vlanId: 200,
});

    resources:
  l2Connection:
    type: azure-native:orbital:L2Connection
    properties:
      edgeSite:
        id: /subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/edgeSites/es1
      groundStation:
        id: /subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/rg1/providers/Microsoft.Orbital/groundStations/gs1
      l2ConnectionName: connection1
      location: westus
      name: customerName-SiteName-01
      resourceGroupName: rg1
      tags:
        tag1: value1
        tag2: value2
      vlanId: 200

    Create L2Connection Resource

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

    Constructor syntax

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

@overload
def L2Connection(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 edge_site: Optional[L2ConnectionsPropertiesEdgeSiteArgs] = None,
                 ground_station: Optional[L2ConnectionsPropertiesGroundStationArgs] = None,
                 name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 vlan_id: Optional[int] = None,
                 l2_connection_name: Optional[str] = None,
                 location: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
    func NewL2Connection(ctx *Context, name string, args L2ConnectionArgs, opts ...ResourceOption) (*L2Connection, error)
    public L2Connection(string name, L2ConnectionArgs args, CustomResourceOptions? opts = null)
    public L2Connection(String name, L2ConnectionArgs args)
public L2Connection(String name, L2ConnectionArgs args, CustomResourceOptions options)

    type: azure-native:orbital:L2Connection
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 L2ConnectionArgs
    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 L2ConnectionArgs
    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 L2ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args L2ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args L2ConnectionArgs
    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 l2connectionResource = new AzureNative.Orbital.L2Connection("l2connectionResource", new()
{
    EdgeSite = new AzureNative.Orbital.Inputs.L2ConnectionsPropertiesEdgeSiteArgs
    {
        Id = "string",
    },
    GroundStation = new AzureNative.Orbital.Inputs.L2ConnectionsPropertiesGroundStationArgs
    {
        Id = "string",
    },
    Name = "string",
    ResourceGroupName = "string",
    VlanId = 0,
    L2ConnectionName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := orbital.NewL2Connection(ctx, "l2connectionResource", &orbital.L2ConnectionArgs{
	EdgeSite: &orbital.L2ConnectionsPropertiesEdgeSiteArgs{
		Id: pulumi.String("string"),
	},
	GroundStation: &orbital.L2ConnectionsPropertiesGroundStationArgs{
		Id: pulumi.String("string"),
	},
	Name:              pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	VlanId:            pulumi.Int(0),
	L2ConnectionName:  pulumi.String("string"),
	Location:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var l2connectionResource = new L2Connection("l2connectionResource", L2ConnectionArgs.builder()
    .edgeSite(L2ConnectionsPropertiesEdgeSiteArgs.builder()
        .id("string")
        .build())
    .groundStation(L2ConnectionsPropertiesGroundStationArgs.builder()
        .id("string")
        .build())
    .name("string")
    .resourceGroupName("string")
    .vlanId(0)
    .l2ConnectionName("string")
    .location("string")
    .tags(Map.of("string", "string"))
    .build());

    l2connection_resource = azure_native.orbital.L2Connection("l2connectionResource",
    edge_site={
        "id": "string",
    },
    ground_station={
        "id": "string",
    },
    name="string",
    resource_group_name="string",
    vlan_id=0,
    l2_connection_name="string",
    location="string",
    tags={
        "string": "string",
    })

    const l2connectionResource = new azure_native.orbital.L2Connection("l2connectionResource", {
    edgeSite: {
        id: "string",
    },
    groundStation: {
        id: "string",
    },
    name: "string",
    resourceGroupName: "string",
    vlanId: 0,
    l2ConnectionName: "string",
    location: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:orbital:L2Connection
properties:
    edgeSite:
        id: string
    groundStation:
        id: string
    l2ConnectionName: string
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
    vlanId: 0

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

    EdgeSite Pulumi.AzureNative.Orbital.Inputs.L2ConnectionsPropertiesEdgeSite
    A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
    GroundStation Pulumi.AzureNative.Orbital.Inputs.L2ConnectionsPropertiesGroundStation
    A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
    Name string
    The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VlanId int
    The VLAN ID for the L2 connection.
    L2ConnectionName string
    L2 Connection name.
    Location string
    The geo-location where the resource lives
    Tags Dictionary<string, string>
    Resource tags.
    EdgeSite L2ConnectionsPropertiesEdgeSiteArgs
    A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
    GroundStation L2ConnectionsPropertiesGroundStationArgs
    A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
    Name string
    The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VlanId int
    The VLAN ID for the L2 connection.
    L2ConnectionName string
    L2 Connection name.
    Location string
    The geo-location where the resource lives
    Tags map[string]string
    Resource tags.
    edgeSite L2ConnectionsPropertiesEdgeSite
    A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
    groundStation L2ConnectionsPropertiesGroundStation
    A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
    name String
    The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    vlanId Integer
    The VLAN ID for the L2 connection.
    l2ConnectionName String
    L2 Connection name.
    location String
    The geo-location where the resource lives
    tags Map<String,String>
    Resource tags.
    edgeSite L2ConnectionsPropertiesEdgeSite
    A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
    groundStation L2ConnectionsPropertiesGroundStation
    A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
    name string
    The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    vlanId number
    The VLAN ID for the L2 connection.
    l2ConnectionName string
    L2 Connection name.
    location string
    The geo-location where the resource lives
    tags {[key: string]: string}
    Resource tags.
    edge_site L2ConnectionsPropertiesEdgeSiteArgs
    A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
    ground_station L2ConnectionsPropertiesGroundStationArgs
    A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
    name str
    The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    vlan_id int
    The VLAN ID for the L2 connection.
    l2_connection_name str
    L2 Connection name.
    location str
    The geo-location where the resource lives
    tags Mapping[str, str]
    Resource tags.
    edgeSite Property Map
    A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
    groundStation Property Map
    A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
    name String
    The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    vlanId Number
    The VLAN ID for the L2 connection.
    l2ConnectionName String
    L2 Connection name.
    location String
    The geo-location where the resource lives
    tags Map<String>
    Resource tags.

    Outputs

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

    CircuitId string
    Globally-unique identifier for this connection that is to be used as a circuit ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.Orbital.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    CircuitId string
    Globally-unique identifier for this connection that is to be used as a circuit ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    circuitId String
    Globally-unique identifier for this connection that is to be used as a circuit ID.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    circuitId string
    Globally-unique identifier for this connection that is to be used as a circuit ID.
    id string
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    circuit_id str
    Globally-unique identifier for this connection that is to be used as a circuit ID.
    id str
    The provider-assigned unique ID for this managed resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    circuitId String
    Globally-unique identifier for this connection that is to be used as a circuit ID.
    id String
    The provider-assigned unique ID for this managed resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    L2ConnectionsPropertiesEdgeSite, L2ConnectionsPropertiesEdgeSiteArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    L2ConnectionsPropertiesGroundStation, L2ConnectionsPropertiesGroundStationArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    L2ConnectionsPropertiesResponseEdgeSite, L2ConnectionsPropertiesResponseEdgeSiteArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    L2ConnectionsPropertiesResponseGroundStation, L2ConnectionsPropertiesResponseGroundStationArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:orbital:L2Connection connection1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/l2Connections/{l2ConnectionName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native