consoles

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

Overview

Name	consoles
Type	Resource
Id	azure.nexus.consoles

Fields

vw_consoles

Name	Datatype	Description
consoleName	text	field from the properties object
detailed_status	text	field from the properties object
detailed_status_message	text	field from the properties object
enabled	text	field from the properties object
expiration	text	field from the properties object
extended_location	text	field from the properties object
location	text	The geo-location where the resource lives
private_link_service_id	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
ssh_public_key	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
virtualMachineName	text	field from the properties object
virtual_machine_access_id	text	field from the properties object

consoles

Name	Datatype	Description
extendedLocation	object
location	string	The geo-location where the resource lives
properties	object
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	consoleName, resourceGroupName, subscriptionId, virtualMachineName	Get properties of the provided virtual machine console.
list_by_virtual_machine	SELECT	resourceGroupName, subscriptionId, virtualMachineName	Get a list of consoles for the provided virtual machine.
create_or_update	INSERT	consoleName, resourceGroupName, subscriptionId, virtualMachineName, data__extendedLocation, data__properties	Create a new virtual machine console or update the properties of the existing virtual machine console.
delete	DELETE	consoleName, resourceGroupName, subscriptionId, virtualMachineName	Delete the provided virtual machine console.
update	UPDATE	consoleName, resourceGroupName, subscriptionId, virtualMachineName	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.

SELECT examples

Get a list of consoles for the provided virtual machine.

vw_consoles

SELECT
consoleName,
detailed_status,
detailed_status_message,
enabled,
expiration,
extended_location,
location,
private_link_service_id,
provisioning_state,
resourceGroupName,
ssh_public_key,
subscriptionId,
tags,
virtualMachineName,
virtual_machine_access_id
FROM azure.nexus.vw_consoles
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualMachineName = '{{ virtualMachineName }}';

consoles

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

INSERT example

Use the following StackQL query and manifest file to create a new consoles resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: detailedStatus
          value: string
        - name: detailedStatusMessage
          value: string
        - name: enabled
          value: string
        - name: expiration
          value: string
        - name: privateLinkServiceId
          value: string
        - name: provisioningState
          value: string
        - name: sshPublicKey
          value:
            - name: keyData
              value: string
        - name: virtualMachineAccessId
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a consoles resource.

/*+ update */
UPDATE azure.nexus.consoles
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
consoleName = '{{ consoleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualMachineName = '{{ virtualMachineName }}';

DELETE example

Deletes the specified consoles resource.

/*+ delete */
DELETE FROM azure.nexus.consoles
WHERE consoleName = '{{ consoleName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualMachineName = '{{ virtualMachineName }}';