azure.network.getSubnet (v4)

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Network.GetSubnet.InvokeAsync(new Azure.Network.GetSubnetArgs
        {
            Name = "backend",
            VirtualNetworkName = "production",
            ResourceGroupName = "networking",
        }));
        this.SubnetId = example.Apply(example => example.Id);
    }

    [Output("subnetId")]
    public Output<string> SubnetId { get; set; }
}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := network.LookupSubnet(ctx, &network.LookupSubnetArgs{
			Name:               "backend",
			VirtualNetworkName: "production",
			ResourceGroupName:  "networking",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("subnetId", example.Id)
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.network.getSubnet({
    name: "backend",
    virtualNetworkName: "production",
    resourceGroupName: "networking",
});
export const subnetId = example.then(example => example.id);

import pulumi
import pulumi_azure as azure

example = azure.network.get_subnet(name="backend",
    virtual_network_name="production",
    resource_group_name="networking")
pulumi.export("subnetId", example.id)

Example coming soon!

Using getSubnet

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 getSubnet(args: GetSubnetArgs, opts?: InvokeOptions): Promise<GetSubnetResult>
function getSubnetOutput(args: GetSubnetOutputArgs, opts?: InvokeOptions): Output<GetSubnetResult>

def get_subnet(name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               virtual_network_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSubnetResult
def get_subnet_output(name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               virtual_network_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSubnetResult]

func LookupSubnet(ctx *Context, args *LookupSubnetArgs, opts ...InvokeOption) (*LookupSubnetResult, error)
func LookupSubnetOutput(ctx *Context, args *LookupSubnetOutputArgs, opts ...InvokeOption) LookupSubnetResultOutput

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

public static class GetSubnet 
{
    public static Task<GetSubnetResult> InvokeAsync(GetSubnetArgs args, InvokeOptions? opts = null)
    public static Output<GetSubnetResult> Invoke(GetSubnetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)
public static Output<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)

fn::invoke:
  function: azure:network/getSubnet:getSubnet
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specifies the name of the Subnet.
ResourceGroupName string: Specifies the name of the resource group the Virtual Network is located in.
VirtualNetworkName string: Specifies the name of the Virtual Network this Subnet is located within.

Name string: Specifies the name of the Subnet.
ResourceGroupName string: Specifies the name of the resource group the Virtual Network is located in.
VirtualNetworkName string: Specifies the name of the Virtual Network this Subnet is located within.

name String: Specifies the name of the Subnet.
resourceGroupName String: Specifies the name of the resource group the Virtual Network is located in.
virtualNetworkName String: Specifies the name of the Virtual Network this Subnet is located within.

name string: Specifies the name of the Subnet.
resourceGroupName string: Specifies the name of the resource group the Virtual Network is located in.
virtualNetworkName string: Specifies the name of the Virtual Network this Subnet is located within.

name str: Specifies the name of the Subnet.
resource_group_name str: Specifies the name of the resource group the Virtual Network is located in.
virtual_network_name str: Specifies the name of the Virtual Network this Subnet is located within.

name String: Specifies the name of the Subnet.
resourceGroupName String: Specifies the name of the resource group the Virtual Network is located in.
virtualNetworkName String: Specifies the name of the Virtual Network this Subnet is located within.

getSubnet Result

The following output properties are available:

AddressPrefix string: (Deprecated) The address prefix used for the subnet.
AddressPrefixes List<string>: The address prefixes for the subnet.
EnforcePrivateLinkEndpointNetworkPolicies bool: Enable or Disable network policies for the private link endpoint on the subnet.
EnforcePrivateLinkServiceNetworkPolicies bool: Enable or Disable network policies for the private link service on the subnet.
Id string: The provider-assigned unique ID for this managed resource.
Name string
NetworkSecurityGroupId string: The ID of the Network Security Group associated with the subnet.
ResourceGroupName string
RouteTableId string: The ID of the Route Table associated with this subnet.
ServiceEndpoints List<string>: A list of Service Endpoints within this subnet.
VirtualNetworkName string

AddressPrefix string: (Deprecated) The address prefix used for the subnet.
AddressPrefixes []string: The address prefixes for the subnet.
EnforcePrivateLinkEndpointNetworkPolicies bool: Enable or Disable network policies for the private link endpoint on the subnet.
EnforcePrivateLinkServiceNetworkPolicies bool: Enable or Disable network policies for the private link service on the subnet.
Id string: The provider-assigned unique ID for this managed resource.
Name string
NetworkSecurityGroupId string: The ID of the Network Security Group associated with the subnet.
ResourceGroupName string
RouteTableId string: The ID of the Route Table associated with this subnet.
ServiceEndpoints []string: A list of Service Endpoints within this subnet.
VirtualNetworkName string

addressPrefix String: (Deprecated) The address prefix used for the subnet.
addressPrefixes List<String>: The address prefixes for the subnet.
enforcePrivateLinkEndpointNetworkPolicies Boolean: Enable or Disable network policies for the private link endpoint on the subnet.
enforcePrivateLinkServiceNetworkPolicies Boolean: Enable or Disable network policies for the private link service on the subnet.
id String: The provider-assigned unique ID for this managed resource.
name String
networkSecurityGroupId String: The ID of the Network Security Group associated with the subnet.
resourceGroupName String
routeTableId String: The ID of the Route Table associated with this subnet.
serviceEndpoints List<String>: A list of Service Endpoints within this subnet.
virtualNetworkName String

addressPrefix string: (Deprecated) The address prefix used for the subnet.
addressPrefixes string[]: The address prefixes for the subnet.
enforcePrivateLinkEndpointNetworkPolicies boolean: Enable or Disable network policies for the private link endpoint on the subnet.
enforcePrivateLinkServiceNetworkPolicies boolean: Enable or Disable network policies for the private link service on the subnet.
id string: The provider-assigned unique ID for this managed resource.
name string
networkSecurityGroupId string: The ID of the Network Security Group associated with the subnet.
resourceGroupName string
routeTableId string: The ID of the Route Table associated with this subnet.
serviceEndpoints string[]: A list of Service Endpoints within this subnet.
virtualNetworkName string

address_prefix str: (Deprecated) The address prefix used for the subnet.
address_prefixes Sequence[str]: The address prefixes for the subnet.
enforce_private_link_endpoint_network_policies bool: Enable or Disable network policies for the private link endpoint on the subnet.
enforce_private_link_service_network_policies bool: Enable or Disable network policies for the private link service on the subnet.
id str: The provider-assigned unique ID for this managed resource.
name str
network_security_group_id str: The ID of the Network Security Group associated with the subnet.
resource_group_name str
route_table_id str: The ID of the Route Table associated with this subnet.
service_endpoints Sequence[str]: A list of Service Endpoints within this subnet.
virtual_network_name str

addressPrefix String: (Deprecated) The address prefix used for the subnet.
addressPrefixes List<String>: The address prefixes for the subnet.
enforcePrivateLinkEndpointNetworkPolicies Boolean: Enable or Disable network policies for the private link endpoint on the subnet.
enforcePrivateLinkServiceNetworkPolicies Boolean: Enable or Disable network policies for the private link service on the subnet.
id String: The provider-assigned unique ID for this managed resource.
name String
networkSecurityGroupId String: The ID of the Network Security Group associated with the subnet.
resourceGroupName String
routeTableId String: The ID of the Route Table associated with this subnet.
serviceEndpoints List<String>: A list of Service Endpoints within this subnet.
virtualNetworkName String