Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. networkcloud
  5. getL2Network
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
pulumi/pulumi-azure-native

azure-native-v2.networkcloud.getL2Network

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
pulumi/pulumi-azure-native

Get properties of the provided layer 2 (L2) network. Azure REST API version: 2023-10-01-preview.

Other available API versions: 2023-07-01, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

Using getL2Network

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 getL2Network(args: GetL2NetworkArgs, opts?: InvokeOptions): Promise<GetL2NetworkResult>
function getL2NetworkOutput(args: GetL2NetworkOutputArgs, opts?: InvokeOptions): Output<GetL2NetworkResult>
Copy
def get_l2_network(l2_network_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetL2NetworkResult
def get_l2_network_output(l2_network_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetL2NetworkResult]
Copy
func LookupL2Network(ctx *Context, args *LookupL2NetworkArgs, opts ...InvokeOption) (*LookupL2NetworkResult, error)
func LookupL2NetworkOutput(ctx *Context, args *LookupL2NetworkOutputArgs, opts ...InvokeOption) LookupL2NetworkResultOutput
Copy

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

public static class GetL2Network 
{
    public static Task<GetL2NetworkResult> InvokeAsync(GetL2NetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetL2NetworkResult> Invoke(GetL2NetworkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetL2NetworkResult> getL2Network(GetL2NetworkArgs args, InvokeOptions options)
public static Output<GetL2NetworkResult> getL2Network(GetL2NetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:networkcloud:getL2Network
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

L2NetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the L2 network.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
L2NetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the L2 network.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
l2NetworkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the L2 network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
l2NetworkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the L2 network.
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_network_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the L2 network.
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.
l2NetworkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the L2 network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getL2Network Result

The following output properties are available:

AssociatedResourceIds List<string>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
ClusterId string
The resource ID of the Network Cloud cluster this L2 network is associated with.
DetailedStatus string
The more detailed status of the L2 network.
DetailedStatusMessage string
The descriptive message about the current detailed status.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
The extended location of the cluster associated with the resource.
HybridAksClustersAssociatedIds List<string>
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
L2IsolationDomainId string
The resource ID of the Network Fabric l2IsolationDomain.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the L2 network.
SystemData Pulumi.AzureNative.NetworkCloud.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"
VirtualMachinesAssociatedIds List<string>
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.
HybridAksPluginType string
Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
InterfaceName string
The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
Tags Dictionary<string, string>
Resource tags.
AssociatedResourceIds []string
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
ClusterId string
The resource ID of the Network Cloud cluster this L2 network is associated with.
DetailedStatus string
The more detailed status of the L2 network.
DetailedStatusMessage string
The descriptive message about the current detailed status.
ExtendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
HybridAksClustersAssociatedIds []string
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
L2IsolationDomainId string
The resource ID of the Network Fabric l2IsolationDomain.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the L2 network.
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"
VirtualMachinesAssociatedIds []string
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.
HybridAksPluginType string
Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
InterfaceName string
The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
Tags map[string]string
Resource tags.
associatedResourceIds List<String>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId String
The resource ID of the Network Cloud cluster this L2 network is associated with.
detailedStatus String
The more detailed status of the L2 network.
detailedStatusMessage String
The descriptive message about the current detailed status.
extendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
hybridAksClustersAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
l2IsolationDomainId String
The resource ID of the Network Fabric l2IsolationDomain.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the L2 network.
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"
virtualMachinesAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.
hybridAksPluginType String
Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
interfaceName String
The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
tags Map<String,String>
Resource tags.
associatedResourceIds string[]
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId string
The resource ID of the Network Cloud cluster this L2 network is associated with.
detailedStatus string
The more detailed status of the L2 network.
detailedStatusMessage string
The descriptive message about the current detailed status.
extendedLocation ExtendedLocationResponse
The extended location of the cluster associated with the resource.
hybridAksClustersAssociatedIds string[]
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
l2IsolationDomainId string
The resource ID of the Network Fabric l2IsolationDomain.
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
The provisioning state of the L2 network.
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"
virtualMachinesAssociatedIds string[]
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.
hybridAksPluginType string
Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
interfaceName string
The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
tags {[key: string]: string}
Resource tags.
associated_resource_ids Sequence[str]
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
cluster_id str
The resource ID of the Network Cloud cluster this L2 network is associated with.
detailed_status str
The more detailed status of the L2 network.
detailed_status_message str
The descriptive message about the current detailed status.
extended_location ExtendedLocationResponse
The extended location of the cluster associated with the resource.
hybrid_aks_clusters_associated_ids Sequence[str]
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
l2_isolation_domain_id str
The resource ID of the Network Fabric l2IsolationDomain.
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
The provisioning state of the L2 network.
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"
virtual_machines_associated_ids Sequence[str]
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.
hybrid_aks_plugin_type str
Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
interface_name str
The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
tags Mapping[str, str]
Resource tags.
associatedResourceIds List<String>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
clusterId String
The resource ID of the Network Cloud cluster this L2 network is associated with.
detailedStatus String
The more detailed status of the L2 network.
detailedStatusMessage String
The descriptive message about the current detailed status.
extendedLocation Property Map
The extended location of the cluster associated with the resource.
hybridAksClustersAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
l2IsolationDomainId String
The resource ID of the Network Fabric l2IsolationDomain.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the L2 network.
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"
virtualMachinesAssociatedIds List<String>
Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.
hybridAksPluginType String
Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.
interfaceName String
The default interface name for this L2 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
tags Map<String>
Resource tags.

Supporting Types

ExtendedLocationResponse

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

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
pulumi/pulumi-azure-native