Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. getVirtualNetwork
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devtestlab.getVirtualNetwork

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get virtual network.

Uses Azure REST API version 2018-09-15.

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>
Copy
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]
Copy
func LookupVirtualNetwork(ctx *Context, args *LookupVirtualNetworkArgs, opts ...InvokeOption) (*LookupVirtualNetworkResult, error)
func LookupVirtualNetworkOutput(ctx *Context, args *LookupVirtualNetworkOutputArgs, opts ...InvokeOption) LookupVirtualNetworkResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetVirtualNetworkResult> getVirtualNetwork(GetVirtualNetworkArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkResult> getVirtualNetwork(GetVirtualNetworkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:devtestlab:getVirtualNetwork
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($expand=externalSubnets)'
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Specify the $expand query. Example: 'properties($expand=externalSubnets)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Specify the $expand query. Example: 'properties($expand=externalSubnets)'
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
Specify the $expand query. Example: 'properties($expand=externalSubnets)'
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual network.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
Specify the $expand query. Example: 'properties($expand=externalSubnets)'
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
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
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
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 location of the resource.
SubnetOverrides List<Pulumi.AzureNative.DevTestLab.Outputs.SubnetOverrideResponse>
The subnet overrides of the virtual network.
Tags Dictionary<string, string>
The tags of the resource.
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
The identifier of the resource.
Name string
The name of the resource.
ProvisioningState string
The provisioning status of the resource.
Type string
The type of the resource.
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 location of the resource.
SubnetOverrides []SubnetOverrideResponse
The subnet overrides of the virtual network.
Tags map[string]string
The tags of the resource.
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
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
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 location of the resource.
subnetOverrides List<SubnetOverrideResponse>
The subnet overrides of the virtual network.
tags Map<String,String>
The tags of the resource.
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
The identifier of the resource.
name string
The name of the resource.
provisioningState string
The provisioning status of the resource.
type string
The type of the resource.
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 location of the resource.
subnetOverrides SubnetOverrideResponse[]
The subnet overrides of the virtual network.
tags {[key: string]: string}
The tags of the resource.
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
The identifier of the resource.
name str
The name of the resource.
provisioning_state str
The provisioning status of the resource.
type str
The type of the resource.
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 location of the resource.
subnet_overrides Sequence[SubnetOverrideResponse]
The subnet overrides of the virtual network.
tags Mapping[str, str]
The tags of the resource.
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
The identifier of the resource.
name String
The name of the resource.
provisioningState String
The provisioning status of the resource.
type String
The type of the resource.
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 location of the resource.
subnetOverrides List<Property Map>
The subnet overrides of the virtual network.
tags Map<String>
The tags of the resource.

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native