azure-native.devtestlab.getVirtualNetwork

Azure Native v3.16.0, Mar 20 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getVirtualNetwork

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 getVirtualNetwork(args: GetVirtualNetworkArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkResult>
function getVirtualNetworkOutput(args: GetVirtualNetworkOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkResult>

def get_virtual_network(expand: Optional[str] = None,
                        lab_name: Optional[str] = None,
                        name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkResult
def get_virtual_network_output(expand: Optional[pulumi.Input[str]] = None,
                        lab_name: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkResult]

func LookupVirtualNetwork(ctx *Context, args *LookupVirtualNetworkArgs, opts ...InvokeOption) (*LookupVirtualNetworkResult, error)
func LookupVirtualNetworkOutput(ctx *Context, args *LookupVirtualNetworkOutputArgs, opts ...InvokeOption) LookupVirtualNetworkResultOutput

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

public static class GetVirtualNetwork 
{
    public static Task<GetVirtualNetworkResult> InvokeAsync(GetVirtualNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkResult> Invoke(GetVirtualNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualNetworkResult> getVirtualNetwork(GetVirtualNetworkArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkResult> getVirtualNetwork(GetVirtualNetworkArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:devtestlab:getVirtualNetwork
  arguments:
    # arguments dictionary

The following arguments are supported:

LabName string: The name of the lab.
Name string: The name of the virtual network.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
Expand string: Specify the $expand query. Example: 'properties($expand=externalSubnets)'

LabName string: The name of the lab.
Name string: The name of the virtual network.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
Expand string: Specify the $expand query. Example: 'properties($expand=externalSubnets)'

labName String: The name of the lab.
name String: The name of the virtual network.
resourceGroupName String: The name of the resource group. The name is case insensitive.
expand String: Specify the $expand query. Example: 'properties($expand=externalSubnets)'

labName string: The name of the lab.
name string: The name of the virtual network.
resourceGroupName string: The name of the resource group. The name is case insensitive.
expand string: Specify the $expand query. Example: 'properties($expand=externalSubnets)'

lab_name str: The name of the lab.
name str: The name of the virtual network.
resource_group_name str: The name of the resource group. The name is case insensitive.
expand str: Specify the $expand query. Example: 'properties($expand=externalSubnets)'

labName String: The name of the lab.
name String: The name of the virtual network.
resourceGroupName String: The name of the resource group. The name is case insensitive.
expand String: Specify the $expand query. Example: 'properties($expand=externalSubnets)'

getVirtualNetwork Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The creation date of the virtual network.
ExternalSubnets List<Pulumi.AzureNative.DevTestLab.Outputs.ExternalSubnetResponse>: The external subnet properties.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status of the resource.
SystemData Pulumi.AzureNative.DevTestLab.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"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
AllowedSubnets List<Pulumi.AzureNative.DevTestLab.Outputs.SubnetResponse>: The allowed subnets of the virtual network.
Description string: The description of the virtual network.
ExternalProviderResourceId string: The Microsoft.Network resource identifier of the virtual network.
Location string: The geo-location where the resource lives
SubnetOverrides List<Pulumi.AzureNative.DevTestLab.Outputs.SubnetOverrideResponse>: The subnet overrides of the virtual network.
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
CreatedDate string: The creation date of the virtual network.
ExternalSubnets []ExternalSubnetResponse: The external subnet properties.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ProvisioningState string: The provisioning status 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"
UniqueIdentifier string: The unique immutable identifier of a resource (Guid).
AllowedSubnets []SubnetResponse: The allowed subnets of the virtual network.
Description string: The description of the virtual network.
ExternalProviderResourceId string: The Microsoft.Network resource identifier of the virtual network.
Location string: The geo-location where the resource lives
SubnetOverrides []SubnetOverrideResponse: The subnet overrides of the virtual network.
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The creation date of the virtual network.
externalSubnets List<ExternalSubnetResponse>: The external subnet properties.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status 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"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
allowedSubnets List<SubnetResponse>: The allowed subnets of the virtual network.
description String: The description of the virtual network.
externalProviderResourceId String: The Microsoft.Network resource identifier of the virtual network.
location String: The geo-location where the resource lives
subnetOverrides List<SubnetOverrideResponse>: The subnet overrides of the virtual network.
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
createdDate string: The creation date of the virtual network.
externalSubnets ExternalSubnetResponse[]: The external subnet properties.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
provisioningState string: The provisioning status 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"
uniqueIdentifier string: The unique immutable identifier of a resource (Guid).
allowedSubnets SubnetResponse[]: The allowed subnets of the virtual network.
description string: The description of the virtual network.
externalProviderResourceId string: The Microsoft.Network resource identifier of the virtual network.
location string: The geo-location where the resource lives
subnetOverrides SubnetOverrideResponse[]: The subnet overrides of the virtual network.
tags {[key: string]: string}: Resource tags.

azure_api_version str: The Azure API version of the resource.
created_date str: The creation date of the virtual network.
external_subnets Sequence[ExternalSubnetResponse]: The external subnet properties.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
provisioning_state str: The provisioning status 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"
unique_identifier str: The unique immutable identifier of a resource (Guid).
allowed_subnets Sequence[SubnetResponse]: The allowed subnets of the virtual network.
description str: The description of the virtual network.
external_provider_resource_id str: The Microsoft.Network resource identifier of the virtual network.
location str: The geo-location where the resource lives
subnet_overrides Sequence[SubnetOverrideResponse]: The subnet overrides of the virtual network.
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
createdDate String: The creation date of the virtual network.
externalSubnets List<Property Map>: The external subnet properties.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
provisioningState String: The provisioning status 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"
uniqueIdentifier String: The unique immutable identifier of a resource (Guid).
allowedSubnets List<Property Map>: The allowed subnets of the virtual network.
description String: The description of the virtual network.
externalProviderResourceId String: The Microsoft.Network resource identifier of the virtual network.
location String: The geo-location where the resource lives
subnetOverrides List<Property Map>: The subnet overrides of the virtual network.
tags Map<String>: Resource tags.

Supporting Types

ExternalSubnetResponse

Id string: Gets or sets the identifier.
Name string: Gets or sets the name.

Id string: Gets or sets the identifier.
Name string: Gets or sets the name.

id String: Gets or sets the identifier.
name String: Gets or sets the name.

id string: Gets or sets the identifier.
name string: Gets or sets the name.

id str: Gets or sets the identifier.
name str: Gets or sets the name.

id String: Gets or sets the identifier.
name String: Gets or sets the name.

PortResponse

BackendPort int: Backend port of the target virtual machine.
TransportProtocol string: Protocol type of the port.

BackendPort int: Backend port of the target virtual machine.
TransportProtocol string: Protocol type of the port.

backendPort Integer: Backend port of the target virtual machine.
transportProtocol String: Protocol type of the port.

backendPort number: Backend port of the target virtual machine.
transportProtocol string: Protocol type of the port.

backend_port int: Backend port of the target virtual machine.
transport_protocol str: Protocol type of the port.

backendPort Number: Backend port of the target virtual machine.
transportProtocol String: Protocol type of the port.

SubnetOverrideResponse

LabSubnetName string: The name given to the subnet within the lab.
ResourceId string: The resource ID of the subnet.
SharedPublicIpAddressConfiguration Pulumi.AzureNative.DevTestLab.Inputs.SubnetSharedPublicIpAddressConfigurationResponse: Properties that virtual machines on this subnet will share.
UseInVmCreationPermission string: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
UsePublicIpAddressPermission string: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
VirtualNetworkPoolName string: The virtual network pool associated with this subnet.

LabSubnetName string: The name given to the subnet within the lab.
ResourceId string: The resource ID of the subnet.
SharedPublicIpAddressConfiguration SubnetSharedPublicIpAddressConfigurationResponse: Properties that virtual machines on this subnet will share.
UseInVmCreationPermission string: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
UsePublicIpAddressPermission string: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
VirtualNetworkPoolName string: The virtual network pool associated with this subnet.

labSubnetName String: The name given to the subnet within the lab.
resourceId String: The resource ID of the subnet.
sharedPublicIpAddressConfiguration SubnetSharedPublicIpAddressConfigurationResponse: Properties that virtual machines on this subnet will share.
useInVmCreationPermission String: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
usePublicIpAddressPermission String: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
virtualNetworkPoolName String: The virtual network pool associated with this subnet.

labSubnetName string: The name given to the subnet within the lab.
resourceId string: The resource ID of the subnet.
sharedPublicIpAddressConfiguration SubnetSharedPublicIpAddressConfigurationResponse: Properties that virtual machines on this subnet will share.
useInVmCreationPermission string: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
usePublicIpAddressPermission string: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
virtualNetworkPoolName string: The virtual network pool associated with this subnet.

lab_subnet_name str: The name given to the subnet within the lab.
resource_id str: The resource ID of the subnet.
shared_public_ip_address_configuration SubnetSharedPublicIpAddressConfigurationResponse: Properties that virtual machines on this subnet will share.
use_in_vm_creation_permission str: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
use_public_ip_address_permission str: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
virtual_network_pool_name str: The virtual network pool associated with this subnet.

labSubnetName String: The name given to the subnet within the lab.
resourceId String: The resource ID of the subnet.
sharedPublicIpAddressConfiguration Property Map: Properties that virtual machines on this subnet will share.
useInVmCreationPermission String: Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
usePublicIpAddressPermission String: Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).
virtualNetworkPoolName String: The virtual network pool associated with this subnet.

SubnetResponse

AllowPublicIp string: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
LabSubnetName string: The name of the subnet as seen in the lab.
ResourceId string: The resource ID of the subnet.

AllowPublicIp string: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
LabSubnetName string: The name of the subnet as seen in the lab.
ResourceId string: The resource ID of the subnet.

allowPublicIp String: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
labSubnetName String: The name of the subnet as seen in the lab.
resourceId String: The resource ID of the subnet.

allowPublicIp string: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
labSubnetName string: The name of the subnet as seen in the lab.
resourceId string: The resource ID of the subnet.

allow_public_ip str: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
lab_subnet_name str: The name of the subnet as seen in the lab.
resource_id str: The resource ID of the subnet.

allowPublicIp String: The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
labSubnetName String: The name of the subnet as seen in the lab.
resourceId String: The resource ID of the subnet.

SubnetSharedPublicIpAddressConfigurationResponse

AllowedPorts List<Pulumi.AzureNative.DevTestLab.Inputs.PortResponse>: Backend ports that virtual machines on this subnet are allowed to expose

AllowedPorts []PortResponse: Backend ports that virtual machines on this subnet are allowed to expose

allowedPorts List<PortResponse>: Backend ports that virtual machines on this subnet are allowed to expose

allowedPorts PortResponse[]: Backend ports that virtual machines on this subnet are allowed to expose

allowed_ports Sequence[PortResponse]: Backend ports that virtual machines on this subnet are allowed to expose

allowedPorts List<Property Map>: Backend ports that virtual machines on this subnet are allowed to expose

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.