ConsoleInner Class

public final class ConsoleInner
extends Resource

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

Constructor Summary

Constructor Description
ConsoleInner()

Creates an instance of ConsoleInner 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.

String etag()

Get the etag property: Resource ETag.

OffsetDateTime expiration()

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

ExtendedLocation extendedLocation()

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

static ConsoleInner fromJson(JsonReader jsonReader)

Reads an instance of ConsoleInner from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

String name()

Get the name property: The name of the resource.

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.

SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

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.

ConsoleInner withEnabled(ConsoleEnabled enabled)

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

ConsoleInner withExpiration(OffsetDateTime expiration)

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

ConsoleInner withExtendedLocation(ExtendedLocation extendedLocation)

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

ConsoleInner withLocation(String location)
ConsoleInner withSshPublicKey(SshPublicKey sshPublicKey)

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

ConsoleInner withTags(Map<String,String> tags)

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

ConsoleInner

public ConsoleInner()

Creates an instance of ConsoleInner 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.

etag

public String etag()

Get the etag property: Resource ETag.

Returns:

the etag 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.

extendedLocation

public ExtendedLocation extendedLocation()

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

Returns:

the extendedLocation value.

fromJson

public static ConsoleInner fromJson(JsonReader jsonReader)

Reads an instance of ConsoleInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ConsoleInner 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.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ConsoleInner.id()

Returns:

the id value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ConsoleInner.name()

Returns:

the name value.

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.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ConsoleInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ConsoleInner.type()

Returns:

the type value.

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 ConsoleInner 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 ConsoleInner object itself.

withExpiration

public ConsoleInner 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 ConsoleInner object itself.

withExtendedLocation

public ConsoleInner withExtendedLocation(ExtendedLocation extendedLocation)

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

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the ConsoleInner object itself.

withLocation

public ConsoleInner withLocation(String location)

Overrides:

ConsoleInner.withLocation(String location)

Parameters:

location

withSshPublicKey

public ConsoleInner 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 ConsoleInner object itself.

withTags

public ConsoleInner withTags(Map<String,String> tags)

Overrides:

ConsoleInner.withTags(Map<String,String> tags)

Parameters:

tags

Applies to