Virtual Networks - List

Service:

Dev Test Labs

API Version:

2018-09-15

List virtual networks in a given lab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks?api-version=2018-09-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI Parameters

Name	In	Required	Type	Description
labName	path	True	string	The name of the lab.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.
$expand	query		string	Specify the $expand query. Example: 'properties($expand=externalSubnets)'
$filter	query		string	The filter to apply to the operation. Example: '$filter=contains(name,'myName')
$orderby	query		string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'
$top	query		integer int32	The maximum number of resources to return from the operation. Example: '$top=10'

Responses

Name	Type	Description
200 OK	VirtualNetworkList	OK
Other Status Codes	CloudError	BadRequest

Security

azure_auth

OAuth2 Implicit Grant

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Access Microsoft Azure

Examples

VirtualNetworks_List

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks?api-version=2018-09-15

Java

/** Samples for VirtualNetworks List. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json
     */
    /**
     * Sample code: VirtualNetworks_List.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void virtualNetworksList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .virtualNetworks()
            .list("resourceGroupName", "{labName}", null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python virtual_networks_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.virtual_networks.list(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json
func ExampleVirtualNetworksClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVirtualNetworksClient().NewListPager("resourceGroupName", "{labName}", &armdevtestlabs.VirtualNetworksClientListOptions{Expand: nil,
		Filter:  nil,
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.VirtualNetworkList = armdevtestlabs.VirtualNetworkList{
		// 	Value: []*armdevtestlabs.VirtualNetwork{
		// 		{
		// 			Name: to.Ptr("{virtualNetworkName}"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/virtualNetworks"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}"),
		// 			Tags: map[string]*string{
		// 				"tagName1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armdevtestlabs.VirtualNetworkProperties{
		// 				AllowedSubnets: []*armdevtestlabs.Subnet{
		// 					{
		// 						AllowPublicIP: to.Ptr(armdevtestlabs.UsagePermissionTypeAllow),
		// 						LabSubnetName: to.Ptr("{virtualNetworkName}Subnet"),
		// 						ResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet"),
		// 				}},
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-01T20:01:44.600Z"); return t}()),
		// 				ExternalProviderResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SubnetOverrides: []*armdevtestlabs.SubnetOverride{
		// 					{
		// 						LabSubnetName: to.Ptr("{virtualNetworkName}Subnet"),
		// 						ResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet"),
		// 						SharedPublicIPAddressConfiguration: &armdevtestlabs.SubnetSharedPublicIPAddressConfiguration{
		// 							AllowedPorts: []*armdevtestlabs.Port{
		// 								{
		// 									BackendPort: to.Ptr[int32](3389),
		// 									TransportProtocol: to.Ptr(armdevtestlabs.TransportProtocolTCP),
		// 								},
		// 								{
		// 									BackendPort: to.Ptr[int32](22),
		// 									TransportProtocol: to.Ptr(armdevtestlabs.TransportProtocolTCP),
		// 							}},
		// 						},
		// 						UseInVMCreationPermission: to.Ptr(armdevtestlabs.UsagePermissionTypeAllow),
		// 						UsePublicIPAddressPermission: to.Ptr(armdevtestlabs.UsagePermissionTypeAllow),
		// 				}},
		// 				UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List virtual networks in a given lab.
 *
 * @summary List virtual networks in a given lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json
 */
async function virtualNetworksList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.virtualNetworks.list(resourceGroupName, labName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

virtualNetworksList().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json
// this example is just showing the usage of "VirtualNetworks_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabVirtualNetworkResource
DevTestLabVirtualNetworkCollection collection = devTestLab.GetDevTestLabVirtualNetworks();

// invoke the operation and iterate over the result
await foreach (DevTestLabVirtualNetworkResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DevTestLabVirtualNetworkData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "allowedSubnets": [
          {
            "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet",
            "labSubnetName": "{virtualNetworkName}Subnet",
            "allowPublicIp": "Allow"
          }
        ],
        "externalProviderResourceId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}",
        "subnetOverrides": [
          {
            "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{virtualNetworkName}Subnet",
            "labSubnetName": "{virtualNetworkName}Subnet",
            "useInVmCreationPermission": "Allow",
            "usePublicIpAddressPermission": "Allow",
            "sharedPublicIpAddressConfiguration": {
              "allowedPorts": [
                {
                  "transportProtocol": "Tcp",
                  "backendPort": 3389
                },
                {
                  "transportProtocol": "Tcp",
                  "backendPort": 22
                }
              ]
            }
          }
        ],
        "createdDate": "2018-10-01T13:01:44.6005134-07:00",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/virtualnetworks/{virtualNetworkName}",
      "name": "{virtualNetworkName}",
      "type": "Microsoft.DevTestLab/labs/virtualNetworks",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definitions

Name	Description
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
ExternalSubnet	Subnet information as returned by the Microsoft.Network API.
Port	Properties of a network port.
Subnet	Subnet information.
SubnetOverride	Property overrides on a subnet of a virtual network.
SubnetSharedPublicIpAddressConfiguration	Configuration for public IP address sharing.
TransportProtocol	The transport protocol for the endpoint.
UsagePermissionType	The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).
VirtualNetwork	A virtual network.
VirtualNetworkList	The response of a list operation.

CloudError

Error from a REST request.

Name	Type	Description
error	CloudErrorBody	The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name	Type	Description
code	string	The error code.
details	CloudErrorBody[]	Inner errors.
message	string	The error message.
target	string	The error target.

ExternalSubnet

Subnet information as returned by the Microsoft.Network API.

Name	Type	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.

Port

Properties of a network port.

Name	Type	Description
backendPort	integer	Backend port of the target virtual machine.
transportProtocol	TransportProtocol	Protocol type of the port.

Subnet

Subnet information.

Name	Type	Description
allowPublicIp	UsagePermissionType	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.

SubnetOverride

Property overrides on a subnet of a virtual network.

Name	Type	Description
labSubnetName	string	The name given to the subnet within the lab.
resourceId	string	The resource ID of the subnet.
sharedPublicIpAddressConfiguration	SubnetSharedPublicIpAddressConfiguration	Properties that virtual machines on this subnet will share.
useInVmCreationPermission	UsagePermissionType	Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).
usePublicIpAddressPermission	UsagePermissionType	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.

SubnetSharedPublicIpAddressConfiguration

Configuration for public IP address sharing.

Name	Type	Description
allowedPorts	Port[]	Backend ports that virtual machines on this subnet are allowed to expose

TransportProtocol

The transport protocol for the endpoint.

Name	Type	Description
Tcp	string
Udp	string

UsagePermissionType

The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).

Name	Type	Description
Allow	string
Default	string
Deny	string

VirtualNetwork

A virtual network.

Name	Type	Description
id	string	The identifier of the resource.
location	string	The location of the resource.
name	string	The name of the resource.
properties.allowedSubnets	Subnet[]	The allowed subnets of the virtual network.
properties.createdDate	string	The creation date of the virtual network.
properties.description	string	The description of the virtual network.
properties.externalProviderResourceId	string	The Microsoft.Network resource identifier of the virtual network.
properties.externalSubnets	ExternalSubnet[]	The external subnet properties.
properties.provisioningState	string	The provisioning status of the resource.
properties.subnetOverrides	SubnetOverride[]	The subnet overrides of the virtual network.
properties.uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
tags	object	The tags of the resource.
type	string	The type of the resource.

VirtualNetworkList

The response of a list operation.

Name	Type	Description
nextLink	string	Link for next set of results.
value	VirtualNetwork[]	Results of the list operation.