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
- vw_serial_ports
- serial_ports
Name | Datatype | Description |
---|---|---|
connection_state | text | field from the properties object |
parentResource | text | field from the properties object |
parentResourceType | text | field from the properties object |
resourceGroupName | text | field from the properties object |
resourceProviderNamespace | text | field from the properties object |
serialPort | text | field from the properties object |
state | text | field from the properties object |
subscriptionId | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
properties | object | The properties of the serial port. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | parentResource, parentResourceType, resourceGroupName, resourceProviderNamespace, serialPort, subscriptionId | Gets the configured settings for a serial port |
list | SELECT | parentResource, parentResourceType, resourceGroupName, resourceProviderNamespace, 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 | parentResource, parentResourceType, resourceGroupName, resourceProviderNamespace, serialPort, subscriptionId | Creates or updates a serial port |
connect | EXEC | parentResource, parentResourceType, resourceGroupName, resourceProviderNamespace, serialPort, subscriptionId | Connect to serial port of the target resource |
SELECT
examples
Handles requests to list all SerialPort resources in a subscription.
- vw_serial_ports
- serial_ports
SELECT
connection_state,
parentResource,
parentResourceType,
resourceGroupName,
resourceProviderNamespace,
serialPort,
state,
subscriptionId
FROM azure.serial_console.vw_serial_ports
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
properties
FROM azure.serial_console.serial_ports
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new serial_ports
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.serial_console.serial_ports (
parentResource,
parentResourceType,
resourceGroupName,
resourceProviderNamespace,
serialPort,
subscriptionId,
properties
)
SELECT
'{{ parentResource }}',
'{{ parentResourceType }}',
'{{ resourceGroupName }}',
'{{ resourceProviderNamespace }}',
'{{ serialPort }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: state
value: string
- name: connectionState
value: string