consoles

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

Overview

Name	consoles
Type	Resource
Id	azure.serial_console.consoles

Fields

The following fields are returned by SELECT queries:

get_status

OK - Returns a JSON object

Name	Datatype	Description
properties	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_status	select	subscriptionId, default		Gets whether or not Serial Console is disabled for a given subscription
disable	exec	subscriptionId, default		Disables the Serial Console service for all VMs and VM scale sets in the provided subscription
enable	exec	subscriptionId, default		Enables the Serial Console service for all VMs and VM scale sets in the provided subscription

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
default	string	Default parameter. Leave the value as "default".
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get_status

Gets whether or not Serial Console is disabled for a given subscription

SELECT
properties
FROM azure.serial_console.consoles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND default = '{{ default }}' -- required
;

Lifecycle Methods

disable

Disables the Serial Console service for all VMs and VM scale sets in the provided subscription

EXEC azure.serial_console.consoles.disable 
@subscriptionId='{{ subscriptionId }}' --required, 
@default='{{ default }}' --required
;

enable

Enables the Serial Console service for all VMs and VM scale sets in the provided subscription

EXEC azure.serial_console.consoles.enable 
@subscriptionId='{{ subscriptionId }}' --required, 
@default='{{ default }}' --required
;