@azure/arm-serialconsole package

Classes

MicrosoftSerialConsoleClient

Interfaces

CloudError	An error response from the service.
CloudErrorBody	An error response from the Batch service.
DisableConsoleOptionalParams	Optional parameters.
DisableSerialConsoleResult	Returns whether or not Serial Console is disabled.
DisableSerialConsoleResultProperties	model interface DisableSerialConsoleResultProperties
EnableConsoleOptionalParams	Optional parameters.
EnableSerialConsoleResult	Returns whether or not Serial Console is disabled (enabled).
EnableSerialConsoleResultProperties	model interface EnableSerialConsoleResultProperties
GetConsoleStatusOptionalParams	Optional parameters.
GetSerialConsoleSubscriptionNotFound	Error saying that the provided subscription could not be found
ListOperationsOptionalParams	Optional parameters.
MicrosoftSerialConsoleClientOptionalParams	Optional parameters for the client.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SerialConsoleOperations	Serial Console operations
SerialConsoleOperationsValueItem	model interface SerialConsoleOperationsValueItem
SerialConsoleOperationsValueItemDisplay	model interface SerialConsoleOperationsValueItemDisplay
SerialConsoleStatus	Returns whether or not Serial Console is disabled.
SerialConsoleStatusProperties	model interface SerialConsoleStatusProperties
SerialPort	Represents the serial port of the parent resource.
SerialPortConnectResult	Returns a connection string to the serial port of the resource.
SerialPortListResult	The list serial ports operation response.
SerialPortProperties	The properties of the serial port.
SerialPortsConnectOptionalParams	Optional parameters.
SerialPortsCreateOptionalParams	Optional parameters.
SerialPortsGetOptionalParams	Optional parameters.
SerialPortsListBySubscriptionsOptionalParams	Optional parameters.
SerialPortsListOptionalParams	Optional parameters.
SerialPortsOperations	Interface representing a SerialPorts operations.
SystemData	Metadata pertaining to creation and last modification of the resource.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
SerialPortConnectionState	Specifies whether the port is currently active.
SerialPortState	Specifies whether the port is enabled for a serial console connection.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownVersions	The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor