Console Interface

public interface Console

An immutable client-side representation of Console.

Method Summary

Modifier and Type Method and Description
abstract ConsoleDetailedStatus detailedStatus()

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

abstract String detailedStatusMessage()

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

abstract ConsoleEnabled enabled()

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

abstract String etag()

Gets the etag property: Resource ETag.

abstract OffsetDateTime expiration()

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

abstract ExtendedLocation extendedLocation()

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

abstract String id()

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

abstract ConsoleInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.ConsoleInner object.

abstract String location()

Gets the location property: The geo-location where the resource lives.

abstract String name()

Gets the name property: The name of the resource.

abstract String privateLinkServiceId()

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

abstract ConsoleProvisioningState provisioningState()

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

abstract Console refresh()

Refreshes the resource to sync with Azure.

abstract Console refresh(Context context)

Refreshes the resource to sync with Azure.

abstract Region region()

Gets the region of the resource.

abstract String regionName()

Gets the name of the resource region.

abstract String resourceGroupName()

Gets the name of the resource group.

abstract SshPublicKey sshPublicKey()

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

abstract SystemData systemData()

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

abstract Map<String,String> tags()

Gets the tags property: Resource tags.

abstract String type()

Gets the type property: The type of the resource.

abstract Update update()

Begins update for the Console resource.

abstract String virtualMachineAccessId()

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

Method Details

detailedStatus

public abstract ConsoleDetailedStatus detailedStatus()

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

Returns:

the detailedStatus value.

detailedStatusMessage

public abstract String detailedStatusMessage()

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

Returns:

the detailedStatusMessage value.

enabled

public abstract ConsoleEnabled enabled()

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

Returns:

the enabled value.

etag

public abstract String etag()

Gets the etag property: Resource ETag.

Returns:

the etag value.

expiration

public abstract OffsetDateTime expiration()

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

Returns:

the expiration value.

extendedLocation

public abstract ExtendedLocation extendedLocation()

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

Returns:

the extendedLocation value.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract ConsoleInner innerModel()

Gets the inner com.azure.resourcemanager.networkcloud.fluent.models.ConsoleInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

privateLinkServiceId

public abstract String privateLinkServiceId()

Gets 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 abstract ConsoleProvisioningState provisioningState()

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

Returns:

the provisioningState value.

refresh

public abstract Console refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Console refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

sshPublicKey

public abstract SshPublicKey sshPublicKey()

Gets 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 abstract SystemData systemData()

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

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Console.Update update()

Begins update for the Console resource.

Returns:

the stage of resource update.

virtualMachineAccessId

public abstract String virtualMachineAccessId()

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

Returns:

the virtualMachineAccessId value.

Applies to