Formulas - List

Service:

Dev Test Labs

API Version:

2018-09-15

List formulas in a given lab.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas?$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($select=description)'
$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	FormulaList	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

Formulas_List

Sample Request

HTTP

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

Java

/** Samples for Formulas List. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Formulas_List.json
     */
    /**
     * Sample code: Formulas_List.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void formulasList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .formulas()
            .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 formulas_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.formulas.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/Formulas_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/Formulas_List.json
func ExampleFormulasClient_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.NewFormulasClient().NewListPager("resourceGroupName", "{labName}", &armdevtestlabs.FormulasClientListOptions{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.FormulaList = armdevtestlabs.FormulaList{
		// 	Value: []*armdevtestlabs.Formula{
		// 		{
		// 			Name: to.Ptr("{formulaName}"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/formulas"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/formulas/{formulaName}"),
		// 			Properties: &armdevtestlabs.FormulaProperties{
		// 				Description: to.Ptr("Formula used to create a Linux VM"),
		// 				Author: to.Ptr("user@contoso.com"),
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-22T19:13:35.992Z"); return t}()),
		// 				FormulaContent: &armdevtestlabs.LabVirtualMachineCreationParameter{
		// 					Location: to.Ptr("{location}"),
		// 					Properties: &armdevtestlabs.LabVirtualMachineCreationParameterProperties{
		// 						AllowClaim: to.Ptr(false),
		// 						Artifacts: []*armdevtestlabs.ArtifactInstallProperties{
		// 							{
		// 								ArtifactID: to.Ptr("/artifactsources/{artifactSourceName}/artifacts/linux-install-nodejs"),
		// 								Parameters: []*armdevtestlabs.ArtifactParameterProperties{
		// 								},
		// 						}},
		// 						DisallowPublicIPAddress: to.Ptr(true),
		// 						GalleryImageReference: &armdevtestlabs.GalleryImageReference{
		// 							Offer: to.Ptr("0001-com-ubuntu-server-groovy"),
		// 							OSType: to.Ptr("Linux"),
		// 							Publisher: to.Ptr("canonical"),
		// 							SKU: to.Ptr("20_10"),
		// 							Version: to.Ptr("latest"),
		// 						},
		// 						IsAuthenticationWithSSHKey: to.Ptr(false),
		// 						LabSubnetName: to.Ptr("Dtl{labName}Subnet"),
		// 						LabVirtualNetworkID: to.Ptr("/virtualnetworks/dtl{labName}"),
		// 						NetworkInterface: &armdevtestlabs.NetworkInterfaceProperties{
		// 							SharedPublicIPAddressConfiguration: &armdevtestlabs.SharedPublicIPAddressConfiguration{
		// 								InboundNatRules: []*armdevtestlabs.InboundNatRule{
		// 									{
		// 										BackendPort: to.Ptr[int32](22),
		// 										TransportProtocol: to.Ptr(armdevtestlabs.TransportProtocolTCP),
		// 								}},
		// 							},
		// 						},
		// 						Notes: to.Ptr("Ubuntu Server 20.10"),
		// 						Size: to.Ptr("Standard_B1ms"),
		// 						StorageType: to.Ptr("Standard"),
		// 						UserName: to.Ptr("user"),
		// 					},
		// 				},
		// 				OSType: to.Ptr("Linux"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				UniqueIdentifier: to.Ptr("7a7d20ab-8a50-46fb-8dc6-7c6c1443a01b"),
		// 			},
		// 	}},
		// }
	}
}

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 formulas in a given lab.
 *
 * @summary List formulas in a given lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Formulas_List.json
 */
async function formulasList() {
  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.formulas.list(resourceGroupName, labName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

formulasList().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;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Formulas_List.json
// this example is just showing the usage of "Formulas_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 DevTestLabFormulaResource
DevTestLabFormulaCollection collection = devTestLab.GetDevTestLabFormulas();

// invoke the operation and iterate over the result
await foreach (DevTestLabFormulaResource 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
    DevTestLabFormulaData 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": {
        "description": "Formula used to create a Linux VM",
        "author": "user@contoso.com",
        "osType": "Linux",
        "creationDate": "2018-12-22T19:13:35.9922091+00:00",
        "formulaContent": {
          "properties": {
            "notes": "Ubuntu Server 20.10",
            "size": "Standard_B1ms",
            "userName": "user",
            "isAuthenticationWithSshKey": false,
            "labSubnetName": "Dtl{labName}Subnet",
            "labVirtualNetworkId": "/virtualnetworks/dtl{labName}",
            "disallowPublicIpAddress": true,
            "galleryImageReference": {
              "offer": "0001-com-ubuntu-server-groovy",
              "publisher": "canonical",
              "sku": "20_10",
              "osType": "Linux",
              "version": "latest"
            },
            "artifacts": [
              {
                "artifactId": "/artifactsources/{artifactSourceName}/artifacts/linux-install-nodejs",
                "parameters": []
              }
            ],
            "networkInterface": {
              "sharedPublicIpAddressConfiguration": {
                "inboundNatRules": [
                  {
                    "transportProtocol": "Tcp",
                    "backendPort": 22
                  }
                ]
              }
            },
            "allowClaim": false,
            "storageType": "Standard"
          },
          "location": "{location}"
        },
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "7a7d20ab-8a50-46fb-8dc6-7c6c1443a01b"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/formulas/{formulaName}",
      "name": "{formulaName}",
      "type": "Microsoft.DevTestLab/labs/formulas"
    }
  ]
}

Definitions

Name	Description
ArtifactInstallProperties	Properties of an artifact.
ArtifactParameterProperties	Properties of an artifact parameter.
AttachNewDataDiskOptions	Properties to attach new disk to the Virtual Machine.
BulkCreationParameters	Parameters for creating multiple virtual machines as a single action.
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
DataDiskProperties	Request body for adding a new or existing data disk to a virtual machine.
DayDetails	Properties of a daily schedule.
EnableStatus	The status of the schedule (i.e. Enabled, Disabled)
Formula	A formula for creating a VM, specifying an image base and other parameters
FormulaList	The response of a list operation.
FormulaPropertiesFromVm	Information about a VM from which a formula is to be created.
GalleryImageReference	The reference information for an Azure Marketplace image.
HostCachingOptions	Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
HourDetails	Properties of an hourly schedule.
InboundNatRule	A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.
LabVirtualMachineCreationParameter	Properties for creating a virtual machine.
NetworkInterfaceProperties	Properties of a network interface.
NotificationSettings	Notification settings for a schedule.
ScheduleCreationParameter	Properties for creating a schedule.
SharedPublicIpAddressConfiguration	Properties of a virtual machine that determine how it is connected to a load balancer.
StorageType	The storage type for the disk (i.e. Standard, Premium).
TransportProtocol	The transport protocol for the endpoint.
WeekDetails	Properties of a weekly schedule.

ArtifactInstallProperties

Properties of an artifact.

Name	Type	Description
artifactId	string	The artifact's identifier.
artifactTitle	string	The artifact's title.
deploymentStatusMessage	string	The status message from the deployment.
installTime	string	The time that the artifact starts to install on the virtual machine.
parameters	ArtifactParameterProperties[]	The parameters of the artifact.
status	string	The status of the artifact.
vmExtensionStatusMessage	string	The status message from the virtual machine extension.

ArtifactParameterProperties

Properties of an artifact parameter.

Name	Type	Description
name	string	The name of the artifact parameter.
value	string	The value of the artifact parameter.

AttachNewDataDiskOptions

Properties to attach new disk to the Virtual Machine.

Name	Type	Description
diskName	string	The name of the disk to be attached.
diskSizeGiB	integer	Size of the disk to be attached in Gibibytes.
diskType	StorageType	The storage type for the disk (i.e. Standard, Premium).

BulkCreationParameters

Parameters for creating multiple virtual machines as a single action.

Name	Type	Description
instanceCount	integer	The number of virtual machine instances to create.

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.

DataDiskProperties

Request body for adding a new or existing data disk to a virtual machine.

Name	Type	Description
attachNewDataDiskOptions	AttachNewDataDiskOptions	Specifies options to attach a new disk to the virtual machine.
existingLabDiskId	string	Specifies the existing lab disk id to attach to virtual machine.
hostCaching	HostCachingOptions	Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).

DayDetails

Properties of a daily schedule.

Name	Type	Description
time	string	The time of day the schedule will occur.

EnableStatus

The status of the schedule (i.e. Enabled, Disabled)

Name	Type	Description
Disabled	string
Enabled	string

Formula

A formula for creating a VM, specifying an image base and other parameters

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.author	string	The author of the formula.
properties.creationDate	string	The creation date of the formula.
properties.description	string	The description of the formula.
properties.formulaContent	LabVirtualMachineCreationParameter	The content of the formula.
properties.osType	string	The OS type of the formula.
properties.provisioningState	string	The provisioning status of the resource.
properties.uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
properties.vm	FormulaPropertiesFromVm	Information about a VM from which a formula is to be created.
tags	object	The tags of the resource.
type	string	The type of the resource.

FormulaList

The response of a list operation.

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

FormulaPropertiesFromVm

Information about a VM from which a formula is to be created.

Name	Type	Description
labVmId	string	The identifier of the VM from which a formula is to be created.

GalleryImageReference

The reference information for an Azure Marketplace image.

Name	Type	Description
offer	string	The offer of the gallery image.
osType	string	The OS type of the gallery image.
publisher	string	The publisher of the gallery image.
sku	string	The SKU of the gallery image.
version	string	The version of the gallery image.

HostCachingOptions

Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).

Name	Type	Description
None	string
ReadOnly	string
ReadWrite	string

HourDetails

Properties of an hourly schedule.

Name	Type	Description
minute	integer	Minutes of the hour the schedule will run.

InboundNatRule

A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.

Name	Type	Description
backendPort	integer	The port to which the external traffic will be redirected.
frontendPort	integer	The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
transportProtocol	TransportProtocol	The transport protocol for the endpoint.

LabVirtualMachineCreationParameter

Properties for creating a virtual machine.

Name	Type	Default Value	Description
location	string		The location of the new virtual machine or environment
name	string		The name of the virtual machine or environment
properties.allowClaim	boolean	False	Indicates whether another user can take ownership of the virtual machine
properties.artifacts	ArtifactInstallProperties[]		The artifacts to be installed on the virtual machine.
properties.bulkCreationParameters	BulkCreationParameters		The number of virtual machine instances to create.
properties.createdDate	string		The creation date of the virtual machine.
properties.customImageId	string		The custom image identifier of the virtual machine.
properties.dataDiskParameters	DataDiskProperties[]		New or existing data disks to attach to the virtual machine after creation
properties.disallowPublicIpAddress	boolean	False	Indicates whether the virtual machine is to be created without a public IP address.
properties.environmentId	string		The resource ID of the environment that contains this virtual machine, if any.
properties.expirationDate	string		The expiration date for VM.
properties.galleryImageReference	GalleryImageReference		The Microsoft Azure Marketplace image reference of the virtual machine.
properties.isAuthenticationWithSshKey	boolean		Indicates whether this virtual machine uses an SSH key for authentication.
properties.labSubnetName	string		The lab subnet name of the virtual machine.
properties.labVirtualNetworkId	string		The lab virtual network identifier of the virtual machine.
properties.networkInterface	NetworkInterfaceProperties		The network interface properties.
properties.notes	string		The notes of the virtual machine.
properties.ownerObjectId	string	dynamicValue	The object identifier of the owner of the virtual machine.
properties.ownerUserPrincipalName	string		The user principal name of the virtual machine owner.
properties.password	string		The password of the virtual machine administrator.
properties.planId	string		The id of the plan associated with the virtual machine image
properties.scheduleParameters	ScheduleCreationParameter[]		Virtual Machine schedules to be created
properties.size	string		The size of the virtual machine.
properties.sshKey	string		The SSH key of the virtual machine administrator.
properties.storageType	string	labStorageType	Storage type to use for virtual machine (i.e. Standard, Premium).
properties.userName	string		The user name of the virtual machine.
tags	object		The tags of the resource.

NetworkInterfaceProperties

Properties of a network interface.

Name	Type	Description
dnsName	string	The DNS name.
privateIpAddress	string	The private IP address.
publicIpAddress	string	The public IP address.
publicIpAddressId	string	The resource ID of the public IP address.
rdpAuthority	string	The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
sharedPublicIpAddressConfiguration	SharedPublicIpAddressConfiguration	The configuration for sharing a public IP address across multiple virtual machines.
sshAuthority	string	The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
subnetId	string	The resource ID of the sub net.
virtualNetworkId	string	The resource ID of the virtual network.

NotificationSettings

Notification settings for a schedule.

Name	Type	Default Value	Description
emailRecipient	string		The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
notificationLocale	string		The locale to use when sending a notification (fallback for unsupported languages is EN).
status	EnableStatus	Disabled	If notifications are enabled for this schedule (i.e. Enabled, Disabled).
timeInMinutes	integer		Time in minutes before event at which notification will be sent.
webhookUrl	string		The webhook URL to which the notification will be sent.

ScheduleCreationParameter

Properties for creating a schedule.

Name	Type	Default Value	Description
location	string		The location of the new virtual machine or environment
name	string		The name of the virtual machine or environment
properties.dailyRecurrence	DayDetails		If the schedule will occur once each day of the week, specify the daily recurrence.
properties.hourlyRecurrence	HourDetails		If the schedule will occur multiple times a day, specify the hourly recurrence.
properties.notificationSettings	NotificationSettings		Notification settings.
properties.status	EnableStatus	Disabled	The status of the schedule (i.e. Enabled, Disabled)
properties.targetResourceId	string		The resource ID to which the schedule belongs
properties.taskType	string		The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.weeklyRecurrence	WeekDetails		If the schedule will occur only some days of the week, specify the weekly recurrence.
tags	object		The tags of the resource.

SharedPublicIpAddressConfiguration

Properties of a virtual machine that determine how it is connected to a load balancer.

Name	Type	Description
inboundNatRules	InboundNatRule[]	The incoming NAT rules

StorageType

The storage type for the disk (i.e. Standard, Premium).

Name	Type	Description
Premium	string
Standard	string
StandardSSD	string

TransportProtocol

The transport protocol for the endpoint.

Name	Type	Description
Tcp	string
Udp	string

WeekDetails

Properties of a weekly schedule.

Name	Type	Description
time	string	The time of the day the schedule will occur.
weekdays	string[]	The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).