dev_box_definitions

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

Overview

Name	dev_box_definitions
Type	Resource
Id	azure.dev_center.dev_box_definitions

Fields

vw_dev_box_definitions

Name	Datatype	Description
active_image_reference	text	field from the properties object
devBoxDefinitionName	text	field from the properties object
devCenterName	text	field from the properties object
hibernate_support	text	field from the properties object
image_reference	text	field from the properties object
image_validation_error_details	text	field from the properties object
image_validation_status	text	field from the properties object
location	text	The geo-location where the resource lives
os_storage_type	text	field from the properties object
projectName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
validation_status	text	field from the properties object

dev_box_definitions

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a Dev Box definition.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	devBoxDefinitionName, devCenterName, resourceGroupName, subscriptionId	Gets a Dev Box definition
get_by_project	SELECT	devBoxDefinitionName, projectName, resourceGroupName, subscriptionId	Gets a Dev Box definition configured for a project
list_by_dev_center	SELECT	devCenterName, resourceGroupName, subscriptionId	List Dev Box definitions for a devcenter.
list_by_project	SELECT	projectName, resourceGroupName, subscriptionId	List Dev Box definitions configured for a project.
create_or_update	INSERT	devBoxDefinitionName, devCenterName, resourceGroupName, subscriptionId	Creates or updates a Dev Box definition.
delete	DELETE	devBoxDefinitionName, devCenterName, resourceGroupName, subscriptionId	Deletes a Dev Box definition
update	UPDATE	devBoxDefinitionName, devCenterName, resourceGroupName, subscriptionId	Partially updates a Dev Box definition.

SELECT examples

List Dev Box definitions configured for a project.

vw_dev_box_definitions

SELECT
active_image_reference,
devBoxDefinitionName,
devCenterName,
hibernate_support,
image_reference,
image_validation_error_details,
image_validation_status,
location,
os_storage_type,
projectName,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
tags,
validation_status
FROM azure.dev_center.vw_dev_box_definitions
WHERE projectName = '{{ projectName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

dev_box_definitions

SELECT
location,
properties,
tags
FROM azure.dev_center.dev_box_definitions
WHERE projectName = '{{ projectName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.dev_center.dev_box_definitions (
devBoxDefinitionName,
devCenterName,
resourceGroupName,
subscriptionId,
tags,
location,
properties
)
SELECT 
'{{ devBoxDefinitionName }}',
'{{ devCenterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: imageReference
          value:
            - name: id
              value: string
            - name: exactVersion
              value: string
        - name: sku
          value:
            - name: name
              value: string
            - name: tier
              value: []
            - name: size
              value: string
            - name: family
              value: string
            - name: capacity
              value: integer
        - name: osStorageType
          value: string
        - name: hibernateSupport
          value: []
        - name: provisioningState
          value: []
        - name: imageValidationStatus
          value: []
        - name: imageValidationErrorDetails
          value:
            - name: code
              value: string
            - name: message
              value: string
        - name: validationStatus
          value: []

UPDATE example

Updates a dev_box_definitions resource.

/*+ update */
UPDATE azure.dev_center.dev_box_definitions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
devBoxDefinitionName = '{{ devBoxDefinitionName }}'
AND devCenterName = '{{ devCenterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified dev_box_definitions resource.

/*+ delete */
DELETE FROM azure.dev_center.dev_box_definitions
WHERE devBoxDefinitionName = '{{ devBoxDefinitionName }}'
AND devCenterName = '{{ devCenterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';