azure-native.orbital.L2Connection
Explore with Pulumi AI
Connects an edge site to an orbital gateway and describes what layer 2 traffic to forward between them.
Uses Azure REST API version 2024-03-01-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01-preview.
Other available API versions: 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native orbital [ApiVersion]
. See the version guide for details.
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,
ground_station_partner_router: Optional[L2ConnectionsPropertiesGroundStationPartnerRouterArgs] = 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
This property is required. string - The unique name of the resource.
- args
This property is required. L2ConnectionArgs - 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. 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
This property is required. string - The unique name of the resource.
- args
This property is required. L2ConnectionArgs - 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. L2ConnectionArgs - 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. 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",
},
GroundStationPartnerRouter = new AzureNative.Orbital.Inputs.L2ConnectionsPropertiesGroundStationPartnerRouterArgs
{
Name = "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"),
},
GroundStationPartnerRouter: &orbital.L2ConnectionsPropertiesGroundStationPartnerRouterArgs{
Name: 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())
.groundStationPartnerRouter(L2ConnectionsPropertiesGroundStationPartnerRouterArgs.builder()
.name("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",
},
ground_station_partner_router={
"name": "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",
},
groundStationPartnerRouter: {
name: "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
groundStationPartnerRouter:
name: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The L2Connection resource accepts the following input properties:
- Edge
Site This property is required. Pulumi.Azure Native. Orbital. Inputs. L2Connections Properties Edge Site - A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
- Ground
Station This property is required. Pulumi.Azure Native. Orbital. Inputs. L2Connections Properties Ground Station - A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
- Ground
Station Partner Router This property is required. Changes to this property will trigger replacement.
Azure Native. Orbital. Inputs. L2Connections Properties Ground Station Partner Router - The name of the partner router to establish a connection to within the ground station.
- Name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Vlan
Id This property is required. int - The VLAN ID for the L2 connection.
- L2Connection
Name Changes to this property will trigger replacement.
- L2 Connection name.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Edge
Site This property is required. L2ConnectionsProperties Edge Site Args - A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
- Ground
Station This property is required. L2ConnectionsProperties Ground Station Args - A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
- Ground
Station Partner Router This property is required. Changes to this property will trigger replacement.
Properties Ground Station Partner Router Args - The name of the partner router to establish a connection to within the ground station.
- Name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Vlan
Id This property is required. int - The VLAN ID for the L2 connection.
- L2Connection
Name Changes to this property will trigger replacement.
- L2 Connection name.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- edge
Site This property is required. L2ConnectionsProperties Edge Site - A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
- ground
Station This property is required. L2ConnectionsProperties Ground Station - A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
- ground
Station Partner Router This property is required. Changes to this property will trigger replacement.
Properties Ground Station Partner Router - The name of the partner router to establish a connection to within the ground station.
- name
This property is required. String - The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- vlan
Id This property is required. Integer - The VLAN ID for the L2 connection.
- l2Connection
Name Changes to this property will trigger replacement.
- L2 Connection name.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- edge
Site This property is required. L2ConnectionsProperties Edge Site - A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
- ground
Station This property is required. L2ConnectionsProperties Ground Station - A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
- ground
Station Partner Router This property is required. Changes to this property will trigger replacement.
Properties Ground Station Partner Router - The name of the partner router to establish a connection to within the ground station.
- name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- vlan
Id This property is required. number - The VLAN ID for the L2 connection.
- l2Connection
Name Changes to this property will trigger replacement.
- L2 Connection name.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- edge_
site This property is required. L2ConnectionsProperties Edge Site Args - A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
- ground_
station This property is required. L2ConnectionsProperties Ground Station Args - A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
- ground_
station_ partner_ router This property is required. Changes to this property will trigger replacement.
Properties Ground Station Partner Router Args - The name of the partner router to establish a connection to within the ground station.
- name
This property is required. str - The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- vlan_
id This property is required. int - The VLAN ID for the L2 connection.
- l2_
connection_ name Changes to this property will trigger replacement.
- L2 Connection name.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- edge
Site This property is required. Property Map - A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
- ground
Station This property is required. Property Map - A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
- ground
Station Partner Router This property is required. Changes to this property will trigger replacement.
- The name of the partner router to establish a connection to within the ground station.
- name
This property is required. String - The unique name of the partner router that cross-connects with the Orbital Edge Router at the edge site.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- vlan
Id This property is required. Number - The VLAN ID for the L2 connection.
- l2Connection
Name Changes to this property will trigger replacement.
- L2 Connection name.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the L2Connection resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Circuit
Id 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.
- System
Data Pulumi.Azure Native. Orbital. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- Circuit
Id 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.
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- circuit
Id 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.
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- circuit
Id 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.
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- 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 SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- circuit
Id 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.
- system
Data 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
This property is required. string - Resource ID.
- Id
This property is required. string - Resource ID.
- id
This property is required. String - Resource ID.
- id
This property is required. string - Resource ID.
- id
This property is required. str - Resource ID.
- id
This property is required. String - Resource ID.
L2ConnectionsPropertiesGroundStation, L2ConnectionsPropertiesGroundStationArgs
- Id
This property is required. string - Resource ID.
- Id
This property is required. string - Resource ID.
- id
This property is required. String - Resource ID.
- id
This property is required. string - Resource ID.
- id
This property is required. str - Resource ID.
- id
This property is required. String - Resource ID.
L2ConnectionsPropertiesGroundStationPartnerRouter, L2ConnectionsPropertiesGroundStationPartnerRouterArgs
- Name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- Name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. String - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. str - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. String - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
L2ConnectionsPropertiesResponseEdgeSite, L2ConnectionsPropertiesResponseEdgeSiteArgs
- Id
This property is required. string - Resource ID.
- Id
This property is required. string - Resource ID.
- id
This property is required. String - Resource ID.
- id
This property is required. string - Resource ID.
- id
This property is required. str - Resource ID.
- id
This property is required. String - Resource ID.
L2ConnectionsPropertiesResponseGroundStation, L2ConnectionsPropertiesResponseGroundStationArgs
- Id
This property is required. string - Resource ID.
- Id
This property is required. string - Resource ID.
- id
This property is required. String - Resource ID.
- id
This property is required. string - Resource ID.
- id
This property is required. str - Resource ID.
- id
This property is required. String - Resource ID.
L2ConnectionsPropertiesResponseGroundStationPartnerRouter, L2ConnectionsPropertiesResponseGroundStationPartnerRouterArgs
- Name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- Name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. String - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. string - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. str - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
- name
This property is required. String - The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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