consoles

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

Overview

Name	consoles
Type	Resource
Id	azure.nexus.consoles

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster manager associated with the cluster this virtual machine is created on. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ConsoleProperties represents the properties of the virtual machine console.)
tags	object	Resource tags.

list_by_virtual_machine

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster manager associated with the cluster this virtual machine is created on. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ConsoleProperties represents the properties of the virtual machine console.)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualMachineName, consoleName		Get properties of the provided virtual machine console.
list_by_virtual_machine	select	subscriptionId, resourceGroupName, virtualMachineName		Get a list of consoles for the provided virtual machine.
create_or_update	insert	subscriptionId, resourceGroupName, virtualMachineName, consoleName, data__extendedLocation, data__properties		Create a new virtual machine console or update the properties of the existing virtual machine console.
update	update	subscriptionId, resourceGroupName, virtualMachineName, consoleName		Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, virtualMachineName, consoleName		Delete the provided virtual machine 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 virtual machine console.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualMachineName	string	The name of the virtual machine.

SELECT examples

get

Get properties of the provided virtual machine console.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.consoles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineName = '{{ virtualMachineName }}' -- required
AND consoleName = '{{ consoleName }}' -- required
;

list_by_virtual_machine

Get a list of consoles for the provided virtual machine.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.consoles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualMachineName = '{{ virtualMachineName }}' -- required
;

INSERT examples

create_or_update

Create a new virtual machine console or update the properties of the existing virtual machine console.

INSERT INTO azure.nexus.consoles (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
virtualMachineName,
consoleName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualMachineName }}',
'{{ consoleName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: consoles
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the consoles resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the consoles resource.
    - name: virtualMachineName
      value: string
      description: Required parameter for the consoles resource.
    - name: consoleName
      value: string
      description: Required parameter for the consoles resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster manager associated with the cluster this virtual machine is created on.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patch the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.

UPDATE azure.nexus.consoles
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualMachineName = '{{ virtualMachineName }}' --required
AND consoleName = '{{ consoleName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the provided virtual machine console.

DELETE FROM azure.nexus.consoles
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualMachineName = '{{ virtualMachineName }}' --required
AND consoleName = '{{ consoleName }}' --required
;