consoles

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

Overview

Name	consoles
Type	Resource
Id	azure.cloud_shell.consoles

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		Gets the console for the user.
put	replace	consoleName, data__properties		Puts a request for a console
delete	delete	consoleName		Deletes the console
put_with_location	exec	consoleName, location		Puts a request for a console
keep_alive_with_location	exec	consoleName, location		Keep console alive
keep_alive	exec	consoleName		Keep console alive

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.consoles
WHERE consoleName = '{{ consoleName }}' -- required
;

REPLACE examples

put

Puts a request for a console

REPLACE azure.cloud_shell.consoles
SET 
data__properties = '{{ properties }}'
WHERE 
consoleName = '{{ consoleName }}' --required
AND data__properties = '{{ properties }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the console

DELETE FROM azure.cloud_shell.consoles
WHERE consoleName = '{{ consoleName }}' --required
;

Lifecycle Methods

put_with_location

Puts a request for a console

EXEC azure.cloud_shell.consoles.put_with_location 
@consoleName='{{ consoleName }}' --required, 
@location='{{ location }}' --required
;

keep_alive_with_location

Keep console alive

EXEC azure.cloud_shell.consoles.keep_alive_with_location 
@consoleName='{{ consoleName }}' --required, 
@location='{{ location }}' --required
;

keep_alive

Keep console alive

EXEC azure.cloud_shell.consoles.keep_alive 
@consoleName='{{ consoleName }}' --required
;