SerialPorts interface
Interface representing a SerialPorts.
Methods
| connect(string, string, string, string, string, Serial |
Connect to serial port of the target resource |
| create(string, string, string, string, string, Serial |
Creates or updates a serial port |
| delete(string, string, string, string, string, Serial |
Deletes a serial port |
| get(string, string, string, string, string, Serial |
Gets the configured settings for a serial port |
| list(string, string, string, string, Serial |
Lists all of the configured serial ports for a parent resource |
| list |
Handles requests to list all SerialPort resources in a subscription. |
Method Details
connect(string, string, string, string, string, SerialPortsConnectOptionalParams)
Connect to serial port of the target resource
function connect(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, options?: SerialPortsConnectOptionalParams): Promise<SerialPortConnectResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- resourceProviderNamespace
-
string
The namespace of the resource provider.
- parentResourceType
-
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
- parentResource
-
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
- serialPort
-
string
The name of the serial port to connect to.
- options
- SerialPortsConnectOptionalParams
The options parameters.
Returns
Promise<SerialPortConnectResult>
create(string, string, string, string, string, SerialPort, SerialPortsCreateOptionalParams)
Creates or updates a serial port
function create(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, parameters: SerialPort, options?: SerialPortsCreateOptionalParams): Promise<SerialPort>Parameters
- resourceGroupName
-
string
The name of the resource group.
- resourceProviderNamespace
-
string
The namespace of the resource provider.
- parentResourceType
-
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
- parentResource
-
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
- serialPort
-
string
The name of the serial port to create.
- parameters
- SerialPort
Parameters supplied to create the serial port.
- options
- SerialPortsCreateOptionalParams
The options parameters.
Returns
Promise<SerialPort>
delete(string, string, string, string, string, SerialPortsDeleteOptionalParams)
Deletes a serial port
function delete(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, options?: SerialPortsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- resourceProviderNamespace
-
string
The namespace of the resource provider.
- parentResourceType
-
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
- parentResource
-
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
- serialPort
-
string
The name of the serial port to delete.
- options
- SerialPortsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, SerialPortsGetOptionalParams)
Gets the configured settings for a serial port
function get(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, serialPort: string, options?: SerialPortsGetOptionalParams): Promise<SerialPort>Parameters
- resourceGroupName
-
string
The name of the resource group.
- resourceProviderNamespace
-
string
The namespace of the resource provider.
- parentResourceType
-
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
- parentResource
-
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
- serialPort
-
string
The name of the serial port to connect to.
- options
- SerialPortsGetOptionalParams
The options parameters.
Returns
Promise<SerialPort>
list(string, string, string, string, SerialPortsListOptionalParams)
Lists all of the configured serial ports for a parent resource
function list(resourceGroupName: string, resourceProviderNamespace: string, parentResourceType: string, parentResource: string, options?: SerialPortsListOptionalParams): Promise<SerialPortListResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- resourceProviderNamespace
-
string
The namespace of the resource provider.
- parentResourceType
-
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
- parentResource
-
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
- options
- SerialPortsListOptionalParams
The options parameters.
Returns
Promise<SerialPortListResult>
listBySubscriptions(SerialPortsListBySubscriptionsOptionalParams)
Handles requests to list all SerialPort resources in a subscription.
function listBySubscriptions(options?: SerialPortsListBySubscriptionsOptionalParams): Promise<SerialPortListResult>Parameters
The options parameters.
Returns
Promise<SerialPortListResult>