formulas

Creates, updates, deletes, gets or lists a formulas resource.

Overview

Name	formulas
Type	Resource
Id	azure.dev_test_labs.formulas

Fields

vw_formulas

Name	Datatype	Description
id	text	The identifier of the resource.
name	text	The name of the resource.
description	text	field from the properties object
author	text	field from the properties object
creation_date	text	field from the properties object
formula_content	text	field from the properties object
labName	text	field from the properties object
location	text	The location of the resource.
os_type	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	The tags of the resource.
type	text	The type of the resource.
unique_identifier	text	field from the properties object
vm	text	field from the properties object

formulas

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
location	string	The location of the resource.
properties	object	Properties of a formula.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	labName, name, resourceGroupName, subscriptionId	Get formula.
list	SELECT	labName, resourceGroupName, subscriptionId	List formulas in a given lab.
create_or_update	INSERT	labName, name, resourceGroupName, subscriptionId, data__properties	Create or replace an existing formula. This operation can take a while to complete.
delete	DELETE	labName, name, resourceGroupName, subscriptionId	Delete formula.
update	UPDATE	labName, name, resourceGroupName, subscriptionId	Allows modifying tags of formulas. All other properties will be ignored.

SELECT examples

List formulas in a given lab.

vw_formulas

SELECT
id,
name,
description,
author,
creation_date,
formula_content,
labName,
location,
os_type,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
unique_identifier,
vm
FROM azure.dev_test_labs.vw_formulas
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

formulas

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.formulas
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new formulas resource.

All Properties

/*+ create */
INSERT INTO azure.dev_test_labs.formulas (
labName,
name,
resourceGroupName,
subscriptionId,
data__properties,
location,
tags,
properties
)
SELECT 
'{{ labName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: description
          value: string
        - name: author
          value: string
        - name: osType
          value: string
        - name: creationDate
          value: string
        - name: formulaContent
          value:
            - name: properties
              value:
                - name: bulkCreationParameters
                  value:
                    - name: instanceCount
                      value: integer
                - name: notes
                  value: string
                - name: ownerObjectId
                  value: string
                - name: ownerUserPrincipalName
                  value: string
                - name: createdDate
                  value: string
                - name: customImageId
                  value: string
                - name: size
                  value: string
                - name: userName
                  value: string
                - name: password
                  value: string
                - name: sshKey
                  value: string
                - name: isAuthenticationWithSshKey
                  value: boolean
                - name: labSubnetName
                  value: string
                - name: labVirtualNetworkId
                  value: string
                - name: disallowPublicIpAddress
                  value: boolean
                - name: artifacts
                  value:
                    - - name: artifactId
                        value: string
                      - name: artifactTitle
                        value: string
                      - name: parameters
                        value:
                          - - name: name
                              value: string
                            - name: value
                              value: string
                      - name: status
                        value: string
                      - name: deploymentStatusMessage
                        value: string
                      - name: vmExtensionStatusMessage
                        value: string
                      - name: installTime
                        value: string
                - name: galleryImageReference
                  value:
                    - name: offer
                      value: string
                    - name: publisher
                      value: string
                    - name: sku
                      value: string
                    - name: osType
                      value: string
                    - name: version
                      value: string
                - name: planId
                  value: string
                - name: networkInterface
                  value:
                    - name: virtualNetworkId
                      value: string
                    - name: subnetId
                      value: string
                    - name: publicIpAddressId
                      value: string
                    - name: publicIpAddress
                      value: string
                    - name: privateIpAddress
                      value: string
                    - name: dnsName
                      value: string
                    - name: rdpAuthority
                      value: string
                    - name: sshAuthority
                      value: string
                    - name: sharedPublicIpAddressConfiguration
                      value:
                        - name: inboundNatRules
                          value:
                            - - name: transportProtocol
                                value: string
                              - name: frontendPort
                                value: integer
                              - name: backendPort
                                value: integer
                - name: expirationDate
                  value: string
                - name: allowClaim
                  value: boolean
                - name: storageType
                  value: string
                - name: environmentId
                  value: string
                - name: dataDiskParameters
                  value:
                    - - name: attachNewDataDiskOptions
                        value:
                          - name: diskSizeGiB
                            value: integer
                          - name: diskName
                            value: string
                          - name: diskType
                            value: string
                      - name: existingLabDiskId
                        value: string
                      - name: hostCaching
                        value: string
                - name: scheduleParameters
                  value:
                    - - name: properties
                        value:
                          - name: status
                            value: string
                          - name: taskType
                            value: string
                          - name: weeklyRecurrence
                            value:
                              - name: weekdays
                                value:
                                  - string
                              - name: time
                                value: string
                          - name: dailyRecurrence
                            value:
                              - name: time
                                value: string
                          - name: hourlyRecurrence
                            value:
                              - name: minute
                                value: integer
                          - name: timeZoneId
                            value: string
                          - name: notificationSettings
                            value:
                              - name: status
                                value: string
                              - name: timeInMinutes
                                value: integer
                              - name: webhookUrl
                                value: string
                              - name: emailRecipient
                                value: string
                              - name: notificationLocale
                                value: string
                          - name: targetResourceId
                            value: string
                      - name: name
                        value: string
                      - name: location
                        value: string
                      - name: tags
                        value: object
            - name: name
              value: string
            - name: location
              value: string
            - name: tags
              value: object
        - name: vm
          value:
            - name: labVmId
              value: string
        - name: provisioningState
          value: string
        - name: uniqueIdentifier
          value: string

UPDATE example

Updates a formulas resource.

/*+ update */
UPDATE azure.dev_test_labs.formulas
SET 
tags = '{{ tags }}'
WHERE 
labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified formulas resource.

/*+ delete */
DELETE FROM azure.dev_test_labs.formulas
WHERE labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';