stop_dev_boxes
Creates, updates, deletes, gets or lists a stop_dev_boxes resource.
Overview
| Name | stop_dev_boxes |
| Type | Resource |
| Id | azure.developer_devcenter.stop_dev_boxes |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
stop_dev_box | exec | project_name, user_id, dev_box_name, endpoint | hibernate | Stops 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 |
|---|---|---|
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. |
hibernate | boolean | Optional parameter to hibernate the dev box. Default value is None. |
Lifecycle Methods
- stop_dev_box
Stops a Dev Box.
EXEC azure.developer_devcenter.stop_dev_boxes.stop_dev_box
@project_name='{{ project_name }}' --required,
@user_id='{{ user_id }}' --required,
@dev_box_name='{{ dev_box_name }}' --required,
@endpoint='{{ endpoint }}' --required,
@hibernate={{ hibernate }}
;