ConsoleProperties Class

Package:
com.azure.resourcemanager.networkcloud.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-networkcloud:2.1.0
  • java.lang.Object
    • com.azure.resourcemanager.networkcloud.fluent.models.ConsoleProperties

Implements

JsonSerializable<ConsoleProperties>

public final class ConsoleProperties
implements JsonSerializable<ConsoleProperties>

ConsoleProperties represents the properties of the virtual machine console.

Constructor Summary

Constructor Description
ConsoleProperties()

Creates an instance of ConsoleProperties class.

Method Summary

Modifier and Type Method and Description
ConsoleDetailedStatus detailedStatus()

Get the detailedStatus property: The more detailed status of the console.
String detailedStatusMessage()

Get the detailedStatusMessage property: The descriptive message about the current detailed status.
ConsoleEnabled enabled()

Get the enabled property: The indicator of whether the console access is enabled.
OffsetDateTime expiration()

Get the expiration property: The date and time after which the key will be disallowed access.
static ConsoleProperties fromJson(JsonReader jsonReader)

Reads an instance of ConsoleProperties from the JsonReader.
String privateLinkServiceId()

Get the privateLinkServiceId property: The resource ID of the private link service that is used to provide virtual machine console access.
ConsoleProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the virtual machine console.
SshPublicKey sshPublicKey()

Get the sshPublicKey property: The SSH public key that will be provisioned for user access.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
String virtualMachineAccessId()

Get the virtualMachineAccessId property: The unique identifier for the virtual machine that is used to access the console.
ConsoleProperties withEnabled(ConsoleEnabled enabled)

Set the enabled property: The indicator of whether the console access is enabled.
ConsoleProperties withExpiration(OffsetDateTime expiration)

Set the expiration property: The date and time after which the key will be disallowed access.
ConsoleProperties withSshPublicKey(SshPublicKey sshPublicKey)

Set the sshPublicKey property: The SSH public key that will be provisioned for user access.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ConsoleProperties

public ConsoleProperties()

Creates an instance of ConsoleProperties class.

Method Details

detailedStatus

public ConsoleDetailedStatus detailedStatus()

Get the detailedStatus property: The more detailed status of the console.

Returns:

the detailedStatus value.

detailedStatusMessage

public String detailedStatusMessage()

Get the detailedStatusMessage property: The descriptive message about the current detailed status.

Returns:

the detailedStatusMessage value.

enabled

public ConsoleEnabled enabled()

Get the enabled property: The indicator of whether the console access is enabled.

Returns:

the enabled value.

expiration

public OffsetDateTime expiration()

Get the expiration property: The date and time after which the key will be disallowed access.

Returns:

the expiration value.

fromJson

public static ConsoleProperties fromJson(JsonReader jsonReader)

Reads an instance of ConsoleProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ConsoleProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

privateLinkServiceId

public String privateLinkServiceId()

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

Returns:

the privateLinkServiceId value.

provisioningState

public ConsoleProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the virtual machine console.

Returns:

the provisioningState value.

sshPublicKey

public SshPublicKey sshPublicKey()

Get the sshPublicKey property: 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.

Returns:

the sshPublicKey value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

virtualMachineAccessId

public String virtualMachineAccessId()

Get the virtualMachineAccessId property: The unique identifier for the virtual machine that is used to access the console.

Returns:

the virtualMachineAccessId value.

withEnabled

public ConsoleProperties withEnabled(ConsoleEnabled enabled)

Set the enabled property: The indicator of whether the console access is enabled.

Parameters:

enabled - the enabled value to set.

Returns:

the ConsoleProperties object itself.

withExpiration

public ConsoleProperties withExpiration(OffsetDateTime expiration)

Set the expiration property: The date and time after which the key will be disallowed access.

Parameters:

expiration - the expiration value to set.

Returns:

the ConsoleProperties object itself.

withSshPublicKey

public ConsoleProperties withSshPublicKey(SshPublicKey sshPublicKey)

Set the sshPublicKey property: 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.

Parameters:

sshPublicKey - the sshPublicKey value to set.

Returns:

the ConsoleProperties object itself.

Applies to