consoles

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

Overview

Name	consoles
Type	Resource
Id	azure_extras.network_cloud.consoles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
detailedStatus	string	The more detailed status of the console. Known values are: "Ready" and "Error". (Ready, Error)
detailedStatusMessage	string	The descriptive message about the current detailed status.
enabled	string	The indicator of whether the console access is enabled. Required. Known values are: "True" and "False". (True, False)
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
expiration	string (date-time)	The date and time after which the key will be disallowed access.
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
privateLinkServiceId	string	The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState	string	The provisioning state of the virtual machine console. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Provisioning". (Succeeded, Failed, Canceled, Accepted, Provisioning)
sshPublicKey	object	SshPublicKey represents the public key used to authenticate with a resource through SSH.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineAccessId	string	The unique identifier for the virtual machine that is used to access the console.

list_by_virtual_machine

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
detailedStatus	string	The more detailed status of the console. Known values are: "Ready" and "Error". (Ready, Error)
detailedStatusMessage	string	The descriptive message about the current detailed status.
enabled	string	The indicator of whether the console access is enabled. Required. Known values are: "True" and "False". (True, False)
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
expiration	string (date-time)	The date and time after which the key will be disallowed access.
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
privateLinkServiceId	string	The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState	string	The provisioning state of the virtual machine console. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Provisioning". (Succeeded, Failed, Canceled, Accepted, Provisioning)
sshPublicKey	object	SshPublicKey represents the public key used to authenticate with a resource through SSH.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineAccessId	string	The unique identifier for the virtual machine that is used to access the console.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_machine_name, console_name, subscription_id		Get properties of the provided virtual machine console.
list_by_virtual_machine	select	resource_group_name, virtual_machine_name, subscription_id	$top, $skipToken	Get a list of consoles for the provided virtual machine.
create_or_update	insert	resource_group_name, virtual_machine_name, console_name, subscription_id, location, properties, extendedLocation		Create a new virtual machine console or update the properties of the existing virtual machine console.
update	update	resource_group_name, virtual_machine_name, console_name, subscription_id		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.
create_or_update	replace	resource_group_name, virtual_machine_name, console_name, subscription_id, location, properties, extendedLocation		Create a new virtual machine console or update the properties of the existing virtual machine console.
delete	delete	resource_group_name, virtual_machine_name, console_name, subscription_id		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
console_name	string	The name of the virtual machine console. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_machine_name	string	The name of the virtual machine. Required.
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get properties of the provided virtual machine console.

SELECT
id,
name,
detailedStatus,
detailedStatusMessage,
enabled,
etag,
expiration,
extendedLocation,
location,
privateLinkServiceId,
provisioningState,
sshPublicKey,
systemData,
tags,
type,
virtualMachineAccessId
FROM azure_extras.network_cloud.consoles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_name = '{{ virtual_machine_name }}' -- required
AND console_name = '{{ console_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_virtual_machine

Get a list of consoles for the provided virtual machine.

SELECT
id,
name,
detailedStatus,
detailedStatusMessage,
enabled,
etag,
expiration,
extendedLocation,
location,
privateLinkServiceId,
provisioningState,
sshPublicKey,
systemData,
tags,
type,
virtualMachineAccessId
FROM azure_extras.network_cloud.consoles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_name = '{{ virtual_machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.network_cloud.consoles (
tags,
location,
properties,
extendedLocation,
resource_group_name,
virtual_machine_name,
console_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ virtual_machine_name }}',
'{{ console_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: consoles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the consoles resource.
  - name: virtual_machine_name
    value: "{{ virtual_machine_name }}"
    description: Required parameter for the consoles resource.
  - name: console_name
    value: "{{ console_name }}"
    description: Required parameter for the consoles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the consoles resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      enabled: "{{ enabled }}"
      expiration: "{{ expiration }}"
      sshPublicKey:
        keyData: "{{ keyData }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      privateLinkServiceId: "{{ privateLinkServiceId }}"
      virtualMachineAccessId: "{{ virtualMachineAccessId }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

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_extras.network_cloud.consoles
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_machine_name = '{{ virtual_machine_name }}' --required
AND console_name = '{{ console_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.network_cloud.consoles
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_machine_name = '{{ virtual_machine_name }}' --required
AND console_name = '{{ console_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided virtual machine console.

DELETE FROM azure_extras.network_cloud.consoles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_machine_name = '{{ virtual_machine_name }}' --required
AND console_name = '{{ console_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;