console_with_locations
Creates, updates, deletes, gets or lists a console_with_locations
resource.
Overview
Name | console_with_locations |
Type | Resource |
Id | azure.cloud_shell.console_with_locations |
Fields
The following fields are returned by SELECT
queries:
- get
Name | Datatype | Description |
---|---|---|
properties | object | Cloud shell console properties. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | consoleName , location | Gets the console for the user. | |
delete | delete | consoleName , location | Deletes the console |
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 |
---|---|---|
consoleName | string | The name of the console |
location | string | The provider location |
SELECT
examples
- get
Gets the console for the user.
SELECT
properties
FROM azure.cloud_shell.console_with_locations
WHERE consoleName = '{{ consoleName }}' -- required
AND location = '{{ location }}' -- required
;
DELETE
examples
- delete
Deletes the console
DELETE FROM azure.cloud_shell.console_with_locations
WHERE consoleName = '{{ consoleName }}' --required
AND location = '{{ location }}' --required
;