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

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

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

get_by_project

OK. The request has succeeded.

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

list_by_dev_center

OK. The request has succeeded.

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

list_by_project

OK. The request has succeeded.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a Dev Box definition
get_by_project	select			Gets a Dev Box definition configured for a project
list_by_dev_center	select			List Dev Box definitions for a devcenter.
list_by_project	select			List Dev Box definitions configured for a project.
create_or_update	insert			Creates or updates a Dev Box definition.
update	update			Partially updates a Dev Box definition.
delete	delete			Deletes a Dev Box definition

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

SELECT examples

get

Gets a Dev Box definition

SELECT
location,
properties,
tags
FROM azure.dev_center.dev_box_definitions
;

get_by_project

Gets a Dev Box definition configured for a project

SELECT
location,
properties,
tags
FROM azure.dev_center.dev_box_definitions
;

list_by_dev_center

List Dev Box definitions for a devcenter.

SELECT
location,
properties,
tags
FROM azure.dev_center.dev_box_definitions
;

list_by_project

List Dev Box definitions configured for a project.

SELECT
location,
properties,
tags
FROM azure.dev_center.dev_box_definitions
;

INSERT examples

create_or_update

Creates or updates a Dev Box definition.

INSERT INTO azure.dev_center.dev_box_definitions (
data__tags,
data__location,
data__properties
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: dev_box_definitions
  props:
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Dev Box definition properties

UPDATE examples

update

Partially updates a Dev Box definition.

UPDATE azure.dev_center.dev_box_definitions
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a Dev Box definition

DELETE FROM azure.dev_center.dev_box_definitions
;