lab_plans

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

Overview

Name	lab_plans
Type	Resource
Id	azure.lab_services.lab_plans

Fields

vw_lab_plans

Name	Datatype	Description
allowed_regions	text	field from the properties object
default_auto_shutdown_profile	text	field from the properties object
default_connection_profile	text	field from the properties object
default_network_profile	text	field from the properties object
identity	text	Identity for the resource.
labPlanName	text	field from the properties object
linked_lms_instance	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_operation_error	text	field from the properties object
shared_gallery_id	text	field from the properties object
subscriptionId	text	field from the properties object
support_info	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.

lab_plans

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	Lab plan resource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	labPlanName, resourceGroupName, subscriptionId	Retrieves the properties of a Lab Plan.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns a list of all lab plans for a subscription and resource group.
list_by_subscription	SELECT	subscriptionId	Returns a list of all lab plans within a subscription
create_or_update	INSERT	labPlanName, resourceGroupName, subscriptionId, data__properties	Operation to create or update a Lab Plan resource.
delete	DELETE	labPlanName, resourceGroupName, subscriptionId	Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
update	UPDATE	labPlanName, resourceGroupName, subscriptionId	Operation to update a Lab Plan resource.
save_image	EXEC	labPlanName, resourceGroupName, subscriptionId	Saves an image from a lab VM to the attached shared image gallery.

SELECT examples

Returns a list of all lab plans within a subscription

vw_lab_plans

SELECT
allowed_regions,
default_auto_shutdown_profile,
default_connection_profile,
default_network_profile,
identity,
labPlanName,
linked_lms_instance,
location,
provisioning_state,
resourceGroupName,
resource_operation_error,
shared_gallery_id,
subscriptionId,
support_info,
system_data,
tags
FROM azure.lab_services.vw_lab_plans
WHERE subscriptionId = '{{ subscriptionId }}';

lab_plans

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.lab_services.lab_plans
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.lab_services.lab_plans (
labPlanName,
resourceGroupName,
subscriptionId,
data__properties,
tags,
location,
properties,
identity
)
SELECT 
'{{ labPlanName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: defaultConnectionProfile
          value:
            - name: webSshAccess
              value: []
        - name: defaultAutoShutdownProfile
          value:
            - name: shutdownOnDisconnect
              value: []
            - name: shutdownOnIdle
              value: []
            - name: disconnectDelay
              value: string
            - name: noConnectDelay
              value: string
            - name: idleDelay
              value: string
        - name: defaultNetworkProfile
          value:
            - name: subnetId
              value: []
        - name: allowedRegions
          value:
            - string
        - name: supportInfo
          value:
            - name: email
              value: []
            - name: phone
              value: []
            - name: instructions
              value: string
        - name: provisioningState
          value: []
        - name: resourceOperationError
          value:
            - name: timestamp
              value: string
            - name: code
              value: string
            - name: message
              value: string
            - name: action
              value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string

UPDATE example

Updates a lab_plans resource.

/*+ update */
UPDATE azure.lab_services.lab_plans
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
labPlanName = '{{ labPlanName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified lab_plans resource.

/*+ delete */
DELETE FROM azure.lab_services.lab_plans
WHERE labPlanName = '{{ labPlanName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';