dev_box_actions

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

Overview

Name	dev_box_actions
Type	Resource
Id	azure.developer_devcenter.dev_box_actions

Fields

The following fields are returned by SELECT queries:

get_dev_box_action

Name	Datatype	Description
name	string	The name of the action. Required.
actionType	string	The action that will be taken. Required. "Stop" (Stop)
next	object	Details about the next run of this action.
sourceId	string	The id of the resource which triggered this action. Required.
suspendedUntil	string (date-time)	The earliest time that the action could occur (UTC).

list_dev_box_actions

Name	Datatype	Description
name	string	The name of the action. Required.
actionType	string	The action that will be taken. Required. "Stop" (Stop)
next	object	Details about the next run of this action.
sourceId	string	The id of the resource which triggered this action. Required.
suspendedUntil	string (date-time)	The earliest time that the action could occur (UTC).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dev_box_action	select	project_name, user_id, dev_box_name, action_name, endpoint		Gets an action.
list_dev_box_actions	select	project_name, user_id, dev_box_name, endpoint		Lists actions on a Dev Box.

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
action_name	string	The name of the action. Required.
dev_box_name	string	Display name for the Dev Box. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
project_name	string	Name of the project. Required.
user_id	string	The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. Required.

SELECT examples

get_dev_box_action

Gets an action.

SELECT
name,
actionType,
next,
sourceId,
suspendedUntil
FROM azure.developer_devcenter.dev_box_actions
WHERE project_name = '{{ project_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND dev_box_name = '{{ dev_box_name }}' -- required
AND action_name = '{{ action_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_dev_box_actions

Lists actions on a Dev Box.

SELECT
name,
actionType,
next,
sourceId,
suspendedUntil
FROM azure.developer_devcenter.dev_box_actions
WHERE project_name = '{{ project_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND dev_box_name = '{{ dev_box_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;