Console interface

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.
detailedStatusMessage

The descriptive message about the current detailed status.
enabled

The indicator of whether the console access is enabled.
etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
expiration

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

The extended location of the resource. This property is required when creating the resource.
privateLinkServiceId

The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState

The provisioning state of the virtual machine console.
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.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

detailedStatus

The more detailed status of the console.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status.

detailedStatusMessage?: string

Property Value

string

enabled

The indicator of whether the console access is enabled.

enabled: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: 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 resource. This property is required when creating the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

privateLinkServiceId

The resource ID of the private link service that is used to provide virtual machine console access.

privateLinkServiceId?: string

Property Value

string

provisioningState

The provisioning state of the virtual machine console.

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.

virtualMachineAccessId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type