dev_box_definitions

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

Overview

Name	dev_box_definitions
Type	Resource
Id	azure.devcenter.dev_box_definitions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeImageReference	object	Image reference information for the currently active image (only populated during updates).
hibernateSupport	string	Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
imageReference	object	Image reference information.
imageValidationErrorDetails	object	Details for image validator error. Populated when the image validation is not successful.
imageValidationStatus	string	Validation status of the configured image. Known values are: "Unknown", "Pending", "Succeeded", "Failed", and "TimedOut".
location	string	The geo-location where the resource lives. Required.
osStorageType	string	The storage type used for the Operating System disk of Dev Boxes created using this definition.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
sku	object	The SKU for Dev Boxes created using this definition.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the Dev Box Definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

get_by_project

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeImageReference	object	Image reference information for the currently active image (only populated during updates).
hibernateSupport	string	Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
imageReference	object	Image reference information.
imageValidationErrorDetails	object	Details for image validator error. Populated when the image validation is not successful.
imageValidationStatus	string	Validation status of the configured image. Known values are: "Unknown", "Pending", "Succeeded", "Failed", and "TimedOut".
location	string	The geo-location where the resource lives. Required.
osStorageType	string	The storage type used for the Operating System disk of Dev Boxes created using this definition.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
sku	object	The SKU for Dev Boxes created using this definition.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the Dev Box Definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

list_by_dev_center

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeImageReference	object	Image reference information for the currently active image (only populated during updates).
hibernateSupport	string	Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
imageReference	object	Image reference information.
imageValidationErrorDetails	object	Details for image validator error. Populated when the image validation is not successful.
imageValidationStatus	string	Validation status of the configured image. Known values are: "Unknown", "Pending", "Succeeded", "Failed", and "TimedOut".
location	string	The geo-location where the resource lives. Required.
osStorageType	string	The storage type used for the Operating System disk of Dev Boxes created using this definition.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
sku	object	The SKU for Dev Boxes created using this definition.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the Dev Box Definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

list_by_project

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeImageReference	object	Image reference information for the currently active image (only populated during updates).
hibernateSupport	string	Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate. Known values are: "Disabled" and "Enabled".
imageReference	object	Image reference information.
imageValidationErrorDetails	object	Details for image validator error. Populated when the image validation is not successful.
imageValidationStatus	string	Validation status of the configured image. Known values are: "Unknown", "Pending", "Succeeded", "Failed", and "TimedOut".
location	string	The geo-location where the resource lives. Required.
osStorageType	string	The storage type used for the Operating System disk of Dev Boxes created using this definition.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
sku	object	The SKU for Dev Boxes created using this definition.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationStatus	string	Validation status for the Dev Box Definition. Known values are: "Unknown", "Pending", "Succeeded", and "Failed".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, dev_center_name, dev_box_definition_name, subscription_id		Gets a Dev Box definition.
get_by_project	select	resource_group_name, project_name, dev_box_definition_name, subscription_id		Gets a Dev Box definition configured for a project.
list_by_dev_center	select	resource_group_name, dev_center_name, subscription_id	$top	List Dev Box definitions for a devcenter.
list_by_project	select	resource_group_name, project_name, subscription_id	$top	List Dev Box definitions configured for a project.
create_or_update	insert	resource_group_name, dev_center_name, dev_box_definition_name, subscription_id, location		Creates or updates a Dev Box definition.
update	update	resource_group_name, dev_center_name, dev_box_definition_name, subscription_id		Partially updates a Dev Box definition.
create_or_update	replace	resource_group_name, dev_center_name, dev_box_definition_name, subscription_id, location		Creates or updates a Dev Box definition.
delete	delete	resource_group_name, dev_center_name, dev_box_definition_name, subscription_id		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
dev_box_definition_name	string	The name of the Dev Box definition. Required.
dev_center_name	string	The name of the devcenter. Required.
project_name	string	The name of the project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a Dev Box definition.

SELECT
id,
name,
activeImageReference,
hibernateSupport,
imageReference,
imageValidationErrorDetails,
imageValidationStatus,
location,
osStorageType,
provisioningState,
sku,
systemData,
tags,
type,
validationStatus
FROM azure.devcenter.dev_box_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND dev_box_definition_name = '{{ dev_box_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_by_project

Gets a Dev Box definition configured for a project.

SELECT
id,
name,
activeImageReference,
hibernateSupport,
imageReference,
imageValidationErrorDetails,
imageValidationStatus,
location,
osStorageType,
provisioningState,
sku,
systemData,
tags,
type,
validationStatus
FROM azure.devcenter.dev_box_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND dev_box_definition_name = '{{ dev_box_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_dev_center

List Dev Box definitions for a devcenter.

SELECT
id,
name,
activeImageReference,
hibernateSupport,
imageReference,
imageValidationErrorDetails,
imageValidationStatus,
location,
osStorageType,
provisioningState,
sku,
systemData,
tags,
type,
validationStatus
FROM azure.devcenter.dev_box_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dev_center_name = '{{ dev_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_project

List Dev Box definitions configured for a project.

SELECT
id,
name,
activeImageReference,
hibernateSupport,
imageReference,
imageValidationErrorDetails,
imageValidationStatus,
location,
osStorageType,
provisioningState,
sku,
systemData,
tags,
type,
validationStatus
FROM azure.devcenter.dev_box_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a Dev Box definition.

INSERT INTO azure.devcenter.dev_box_definitions (
tags,
location,
properties,
resource_group_name,
dev_center_name,
dev_box_definition_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ dev_center_name }}',
'{{ dev_box_definition_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: dev_box_definitions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dev_box_definitions resource.
  - name: dev_center_name
    value: "{{ dev_center_name }}"
    description: Required parameter for the dev_box_definitions resource.
  - name: dev_box_definition_name
    value: "{{ dev_box_definition_name }}"
    description: Required parameter for the dev_box_definitions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dev_box_definitions resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      imageReference:
        id: "{{ id }}"
        exactVersion: "{{ exactVersion }}"
      sku:
        name: "{{ name }}"
        tier: "{{ tier }}"
        size: "{{ size }}"
        family: "{{ family }}"
        capacity: {{ capacity }}
      osStorageType: "{{ osStorageType }}"
      hibernateSupport: "{{ hibernateSupport }}"

UPDATE examples

update

Partially updates a Dev Box definition.

UPDATE azure.devcenter.dev_box_definitions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND dev_box_definition_name = '{{ dev_box_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Dev Box definition.

REPLACE azure.devcenter.dev_box_definitions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND dev_box_definition_name = '{{ dev_box_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Dev Box definition.

DELETE FROM azure.devcenter.dev_box_definitions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dev_center_name = '{{ dev_center_name }}' --required
AND dev_box_definition_name = '{{ dev_box_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;