1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getL3Network
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.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

azure-native.networkcloud.getL3Network

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.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

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

    Other available API versions: 2023-07-01.

    Using getL3Network

    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 getL3Network(args: GetL3NetworkArgs, opts?: InvokeOptions): Promise<GetL3NetworkResult>
    function getL3NetworkOutput(args: GetL3NetworkOutputArgs, opts?: InvokeOptions): Output<GetL3NetworkResult>
    def get_l3_network(l3_network_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetL3NetworkResult
    def get_l3_network_output(l3_network_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetL3NetworkResult]
    func LookupL3Network(ctx *Context, args *LookupL3NetworkArgs, opts ...InvokeOption) (*LookupL3NetworkResult, error)
    func LookupL3NetworkOutput(ctx *Context, args *LookupL3NetworkOutputArgs, opts ...InvokeOption) LookupL3NetworkResultOutput

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

    public static class GetL3Network 
    {
        public static Task<GetL3NetworkResult> InvokeAsync(GetL3NetworkArgs args, InvokeOptions? opts = null)
        public static Output<GetL3NetworkResult> Invoke(GetL3NetworkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetL3NetworkResult> getL3Network(GetL3NetworkArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:networkcloud:getL3Network
      arguments:
        # arguments dictionary

    The following arguments are supported:

    L3NetworkName string
    The name of the L3 network.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    L3NetworkName string
    The name of the L3 network.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    l3NetworkName String
    The name of the L3 network.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    l3NetworkName string
    The name of the L3 network.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    l3_network_name str
    The name of the L3 network.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    l3NetworkName String
    The name of the L3 network.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getL3Network 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 L3 network is associated with.
    DetailedStatus string
    The more detailed status of the L3 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 IDs that are associated with this L3 network.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    L3IsolationDomainId string
    The resource ID of the Network Fabric l3IsolationDomain.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the L3 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 IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
    Vlan double
    The VLAN from the l3IsolationDomain that is used for this network.
    HybridAksIpamEnabled string
    Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
    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 L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
    IpAllocationType string
    The type of the IP address allocation, defaulted to "DualStack".
    Ipv4ConnectedPrefix string
    The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
    Ipv6ConnectedPrefix string
    The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
    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 L3 network is associated with.
    DetailedStatus string
    The more detailed status of the L3 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 IDs that are associated with this L3 network.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    L3IsolationDomainId string
    The resource ID of the Network Fabric l3IsolationDomain.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the L3 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 IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
    Vlan float64
    The VLAN from the l3IsolationDomain that is used for this network.
    HybridAksIpamEnabled string
    Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
    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 L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
    IpAllocationType string
    The type of the IP address allocation, defaulted to "DualStack".
    Ipv4ConnectedPrefix string
    The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
    Ipv6ConnectedPrefix string
    The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
    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 L3 network is associated with.
    detailedStatus String
    The more detailed status of the L3 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 IDs that are associated with this L3 network.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    l3IsolationDomainId String
    The resource ID of the Network Fabric l3IsolationDomain.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the L3 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 IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
    vlan Double
    The VLAN from the l3IsolationDomain that is used for this network.
    hybridAksIpamEnabled String
    Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
    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 L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
    ipAllocationType String
    The type of the IP address allocation, defaulted to "DualStack".
    ipv4ConnectedPrefix String
    The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
    ipv6ConnectedPrefix String
    The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
    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 L3 network is associated with.
    detailedStatus string
    The more detailed status of the L3 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 IDs that are associated with this L3 network.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    l3IsolationDomainId string
    The resource ID of the Network Fabric l3IsolationDomain.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the L3 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 IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
    vlan number
    The VLAN from the l3IsolationDomain that is used for this network.
    hybridAksIpamEnabled string
    Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
    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 L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
    ipAllocationType string
    The type of the IP address allocation, defaulted to "DualStack".
    ipv4ConnectedPrefix string
    The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
    ipv6ConnectedPrefix string
    The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
    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 L3 network is associated with.
    detailed_status str
    The more detailed status of the L3 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 IDs that are associated with this L3 network.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    l3_isolation_domain_id str
    The resource ID of the Network Fabric l3IsolationDomain.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the L3 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 IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
    vlan float
    The VLAN from the l3IsolationDomain that is used for this network.
    hybrid_aks_ipam_enabled str
    Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
    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 L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
    ip_allocation_type str
    The type of the IP address allocation, defaulted to "DualStack".
    ipv4_connected_prefix str
    The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
    ipv6_connected_prefix str
    The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
    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 L3 network is associated with.
    detailedStatus String
    The more detailed status of the L3 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 IDs that are associated with this L3 network.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    l3IsolationDomainId String
    The resource ID of the Network Fabric l3IsolationDomain.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the L3 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 IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.
    vlan Number
    The VLAN from the l3IsolationDomain that is used for this network.
    hybridAksIpamEnabled String
    Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.
    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 L3 network in the virtual machine. This name can be overridden by the name supplied in the network attachment configuration of that virtual machine.
    ipAllocationType String
    The type of the IP address allocation, defaulted to "DualStack".
    ipv4ConnectedPrefix String
    The IPV4 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV4 or DualStack.
    ipv6ConnectedPrefix String
    The IPV6 prefix (CIDR) assigned to this L3 network. Required when the IP allocation type is IPV6 or DualStack.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationResponse

    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type 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 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.49.1 published on Tuesday, Jul 9, 2024 by Pulumi