1. Packages
  2. Azure Native v2
  3. API Docs
  4. orbital
  5. getL2Connection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.orbital.getL2Connection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets the specified L2 connection in a specified resource group. Azure REST API version: 2024-03-01-preview.

Other available API versions: 2024-03-01.

Using getL2Connection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getL2Connection(args: GetL2ConnectionArgs, opts?: InvokeOptions): Promise<GetL2ConnectionResult>
function getL2ConnectionOutput(args: GetL2ConnectionOutputArgs, opts?: InvokeOptions): Output<GetL2ConnectionResult>
Copy
def get_l2_connection(l2_connection_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetL2ConnectionResult
def get_l2_connection_output(l2_connection_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetL2ConnectionResult]
Copy
func LookupL2Connection(ctx *Context, args *LookupL2ConnectionArgs, opts ...InvokeOption) (*LookupL2ConnectionResult, error)
func LookupL2ConnectionOutput(ctx *Context, args *LookupL2ConnectionOutputArgs, opts ...InvokeOption) LookupL2ConnectionResultOutput
Copy

> Note: This function is named LookupL2Connection in the Go SDK.

public static class GetL2Connection 
{
    public static Task<GetL2ConnectionResult> InvokeAsync(GetL2ConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetL2ConnectionResult> Invoke(GetL2ConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetL2ConnectionResult> getL2Connection(GetL2ConnectionArgs args, InvokeOptions options)
public static Output<GetL2ConnectionResult> getL2Connection(GetL2ConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:orbital:getL2Connection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

L2ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
L2 Connection name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
L2ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
L2 Connection name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
l2ConnectionName
This property is required.
Changes to this property will trigger replacement.
String
L2 Connection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
l2ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
L2 Connection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
l2_connection_name
This property is required.
Changes to this property will trigger replacement.
str
L2 Connection name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
l2ConnectionName
This property is required.
Changes to this property will trigger replacement.
String
L2 Connection name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getL2Connection Result

The following output properties are available:

CircuitId string
Globally-unique identifier for this connection that is to be used as a circuit ID.
EdgeSite Pulumi.AzureNative.Orbital.Outputs.L2ConnectionsPropertiesResponseEdgeSite
A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
GroundStation Pulumi.AzureNative.Orbital.Outputs.L2ConnectionsPropertiesResponseGroundStation
A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the 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"
VlanId int
The VLAN ID for the L2 connection.
Tags Dictionary<string, string>
Resource tags.
CircuitId string
Globally-unique identifier for this connection that is to be used as a circuit ID.
EdgeSite L2ConnectionsPropertiesResponseEdgeSite
A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
GroundStation L2ConnectionsPropertiesResponseGroundStation
A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the 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"
VlanId int
The VLAN ID for the L2 connection.
Tags map[string]string
Resource tags.
circuitId String
Globally-unique identifier for this connection that is to be used as a circuit ID.
edgeSite L2ConnectionsPropertiesResponseEdgeSite
A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
groundStation L2ConnectionsPropertiesResponseGroundStation
A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the 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"
vlanId Integer
The VLAN ID for the L2 connection.
tags Map<String,String>
Resource tags.
circuitId string
Globally-unique identifier for this connection that is to be used as a circuit ID.
edgeSite L2ConnectionsPropertiesResponseEdgeSite
A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
groundStation L2ConnectionsPropertiesResponseGroundStation
A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the 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"
vlanId number
The VLAN ID for the L2 connection.
tags {[key: string]: string}
Resource tags.
circuit_id str
Globally-unique identifier for this connection that is to be used as a circuit ID.
edge_site L2ConnectionsPropertiesResponseEdgeSite
A reference to an Microsoft.Orbital/edgeSites resource to route traffic for.
ground_station L2ConnectionsPropertiesResponseGroundStation
A reference to an Microsoft.Orbital/groundStations resource to route traffic for.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the 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"
vlan_id int
The VLAN ID for the L2 connection.
tags Mapping[str, str]
Resource tags.
circuitId String
Globally-unique identifier for this connection that is to be used as a circuit ID.
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.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the 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"
vlanId Number
The VLAN ID for the L2 connection.
tags Map<String>
Resource tags.

Supporting Types

L2ConnectionsPropertiesResponseEdgeSite

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

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.

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi