Share via

Console interface

  • Reference
Package:
@azure/arm-networkcloud

Console represents the console of an on-premises Network Cloud virtual machine.

Extends
TrackedResource

Properties

detailedStatus

The more detailed status of the console. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
enabled

The indicator of whether the console access is enabled.
expiration

The date and time after which the key will be disallowed access.
extendedLocation

The extended location of the cluster manager associated with the cluster this virtual machine is created on.
privateLinkServiceId

The resource ID of the private link service that is used to provide virtual machine console access. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the virtual machine console. NOTE: This property will not be serialized. It can only be populated by the server.
sshPublicKey

The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
virtualMachineAccessId

The unique identifier for the virtual machine that is used to access the console. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

detailedStatus

The more detailed status of the console. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

enabled

The indicator of whether the console access is enabled.

enabled: string

Property Value

string

expiration

The date and time after which the key will be disallowed access.

expiration?: Date

Property Value

Date

extendedLocation

The extended location of the cluster manager associated with the cluster this virtual machine is created on.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

privateLinkServiceId

The resource ID of the private link service that is used to provide virtual machine console access. NOTE: This property will not be serialized. It can only be populated by the server.

privateLinkServiceId?: string

Property Value

string

provisioningState

The provisioning state of the virtual machine console. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sshPublicKey

The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.

sshPublicKey: SshPublicKey

Property Value

SshPublicKey

virtualMachineAccessId

The unique identifier for the virtual machine that is used to access the console. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachineAccessId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type