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
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.
connectionState	string	Specifies whether the port is currently active. Known values are: "active" and "inactive". (active, inactive)
state	string	Specifies whether the port is enabled for a serial console connection. Known values are: "enabled" and "disabled". (enabled, disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
connectionState	string	Specifies whether the port is currently active. Known values are: "active" and "inactive". (active, inactive)
state	string	Specifies whether the port is enabled for a serial console connection. Known values are: "enabled" and "disabled". (enabled, disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscriptions

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.
connectionState	string	Specifies whether the port is currently active. Known values are: "active" and "inactive". (active, inactive)
state	string	Specifies whether the port is enabled for a serial console connection. Known values are: "enabled" and "disabled". (enabled, disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_provider_namespace, parent_resource_type, parent_resource, serial_port, subscription_id		Gets the configured settings for a serial port.
list	select	resource_group_name, resource_provider_namespace, parent_resource_type, parent_resource, subscription_id		Lists all of the configured serial ports for a parent resource.
list_by_subscriptions	select	subscription_id		Handles requests to list all SerialPort resources in a subscription.
create	insert	resource_group_name, resource_provider_namespace, parent_resource_type, parent_resource, serial_port, subscription_id		Creates or updates a serial port.
connect	exec	resource_group_name, resource_provider_namespace, parent_resource_type, parent_resource, serial_port, subscription_id		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
parent_resource	string	The name of the parent resource. Required.
parent_resource_type	string	The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'. Required.
resource_group_name	string	The name of the resource group. Required.
resource_provider_namespace	string	The resource provider namespace of the parent resource. Required.
serial_port	string	The name of the serial port to connect to. Required.
subscription_id	string

SELECT examples

get

Gets the configured settings for a serial port.

SELECT
id,
name,
connectionState,
state,
systemData,
type
FROM azure.serial_console.serial_ports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_provider_namespace = '{{ resource_provider_namespace }}' -- required
AND parent_resource_type = '{{ parent_resource_type }}' -- required
AND parent_resource = '{{ parent_resource }}' -- required
AND serial_port = '{{ serial_port }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all of the configured serial ports for a parent resource.

SELECT
id,
name,
connectionState,
state,
systemData,
type
FROM azure.serial_console.serial_ports
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_provider_namespace = '{{ resource_provider_namespace }}' -- required
AND parent_resource_type = '{{ parent_resource_type }}' -- required
AND parent_resource = '{{ parent_resource }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscriptions

Handles requests to list all SerialPort resources in a subscription.

SELECT
id,
name,
connectionState,
state,
systemData,
type
FROM azure.serial_console.serial_ports
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or updates a serial port.

INSERT INTO azure.serial_console.serial_ports (
properties,
resource_group_name,
resource_provider_namespace,
parent_resource_type,
parent_resource,
serial_port,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_provider_namespace }}',
'{{ parent_resource_type }}',
'{{ parent_resource }}',
'{{ serial_port }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: serial_ports
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the serial_ports resource.
  - name: resource_provider_namespace
    value: "{{ resource_provider_namespace }}"
    description: Required parameter for the serial_ports resource.
  - name: parent_resource_type
    value: "{{ parent_resource_type }}"
    description: Required parameter for the serial_ports resource.
  - name: parent_resource
    value: "{{ parent_resource }}"
    description: Required parameter for the serial_ports resource.
  - name: serial_port
    value: "{{ serial_port }}"
    description: Required parameter for the serial_ports resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the serial_ports resource.
  - name: properties
    description: |
      The properties of the serial port.
    value:
      state: "{{ state }}"
      connectionState: "{{ connectionState }}"

Lifecycle Methods

connect

Connect to serial port of the target resource.

EXEC azure.serial_console.serial_ports.connect 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_provider_namespace='{{ resource_provider_namespace }}' --required, 
@parent_resource_type='{{ parent_resource_type }}' --required, 
@parent_resource='{{ parent_resource }}' --required, 
@serial_port='{{ serial_port }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;