serial_ports

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

Overview

Name	serial_ports
Type	Resource
Id	azure.serial_console.serial_ports

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of the serial port.

list

Name	Datatype	Description
properties	object	The properties of the serial port.

list_by_subscriptions

OK - Return a list of SerialPort resources

Name	Datatype	Description
properties	object	The properties of the serial port.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, resourceProviderNamespace, parentResourceType, parentResource, serialPort, subscriptionId		Gets the configured settings for a serial port
list	select	resourceGroupName, resourceProviderNamespace, parentResourceType, parentResource, subscriptionId		Lists all of the configured serial ports for a parent resource
list_by_subscriptions	select	subscriptionId		Handles requests to list all SerialPort resources in a subscription.
create	insert	resourceGroupName, resourceProviderNamespace, parentResourceType, parentResource, serialPort, subscriptionId		Creates or updates a serial port
connect	exec	resourceGroupName, resourceProviderNamespace, parentResourceType, parentResource, serialPort, subscriptionId		Connect to serial port of the target resource

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
parentResource	string	The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
parentResourceType	string	The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceProviderNamespace	string	The namespace of the resource provider.
serialPort	string	The name of the serial port to connect to.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the configured settings for a serial port

SELECT
properties
FROM azure.serial_console.serial_ports
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceProviderNamespace = '{{ resourceProviderNamespace }}' -- required
AND parentResourceType = '{{ parentResourceType }}' -- required
AND parentResource = '{{ parentResource }}' -- required
AND serialPort = '{{ serialPort }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all of the configured serial ports for a parent resource

SELECT
properties
FROM azure.serial_console.serial_ports
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceProviderNamespace = '{{ resourceProviderNamespace }}' -- required
AND parentResourceType = '{{ parentResourceType }}' -- required
AND parentResource = '{{ parentResource }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscriptions

Handles requests to list all SerialPort resources in a subscription.

SELECT
properties
FROM azure.serial_console.serial_ports
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates or updates a serial port

INSERT INTO azure.serial_console.serial_ports (
data__properties,
resourceGroupName,
resourceProviderNamespace,
parentResourceType,
parentResource,
serialPort,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ resourceProviderNamespace }}',
'{{ parentResourceType }}',
'{{ parentResource }}',
'{{ serialPort }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: serial_ports
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the serial_ports resource.
    - name: resourceProviderNamespace
      value: string
      description: Required parameter for the serial_ports resource.
    - name: parentResourceType
      value: string
      description: Required parameter for the serial_ports resource.
    - name: parentResource
      value: string
      description: Required parameter for the serial_ports resource.
    - name: serialPort
      value: string
      description: Required parameter for the serial_ports resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the serial_ports resource.
    - name: properties
      value: object
      description: |
        The properties of the serial port.

Lifecycle Methods

connect

Connect to serial port of the target resource

EXEC azure.serial_console.serial_ports.connect 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceProviderNamespace='{{ resourceProviderNamespace }}' --required, 
@parentResourceType='{{ parentResourceType }}' --required, 
@parentResource='{{ parentResource }}' --required, 
@serialPort='{{ serialPort }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;