ConsoleProperties interface
ConsoleProperties represents the properties of the virtual machine console.
Properties
| detailed |
The more detailed status of the console. |
| detailed |
The descriptive message about the current detailed status. |
| enabled | The indicator of whether the console access is enabled. |
| expiration | The date and time after which the key will be disallowed access. |
| private |
The resource ID of the private link service that is used to provide virtual machine console access. |
| provisioning |
The provisioning state of the virtual machine console. |
| ssh |
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. |
| virtual |
The unique identifier for the virtual machine that is used to access the console. |
Property Details
detailedStatus
The more detailed status of the console.
detailedStatus?: stringProperty Value
string
detailedStatusMessage
The descriptive message about the current detailed status.
detailedStatusMessage?: stringProperty Value
string
enabled
The indicator of whether the console access is enabled.
enabled: stringProperty Value
string
expiration
The date and time after which the key will be disallowed access.
expiration?: DateProperty Value
Date
privateLinkServiceId
The resource ID of the private link service that is used to provide virtual machine console access.
privateLinkServiceId?: stringProperty Value
string
provisioningState
The provisioning state of the virtual machine console.
provisioningState?: stringProperty 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: SshPublicKeyProperty Value
virtualMachineAccessId
The unique identifier for the virtual machine that is used to access the console.
virtualMachineAccessId?: stringProperty Value
string
