Interface Disk

All Superinterfaces:

com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<ComputeManager, DiskInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<DiskInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<ComputeManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<Disk>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.model.Updatable<Disk.Update>

public interface Disk
extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<ComputeManager, DiskInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<Disk>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<Disk.Update>

An immutable client-side representation of an Azure managed disk.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Disk.Definition	The entirety of the managed disk definition.
static interface	Disk.DefinitionStages	Grouping of managed disk definition stages.
static interface	Disk.Update	The template for an update operation, containing all the settings that can be modified.
static interface	Disk.UpdateStages	Grouping of managed disk update stages.

Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Field Summary

Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

DUMMY

Method Summary

Modifier and Type	Method	Description
Set<com.azure.resourcemanager.resources.fluentcore.arm.AvailabilityZoneId>	availabilityZones()	Gets the availability zones assigned to the disk.
DiskCreateOption	creationMethod()	Gets the disk creation method.
Long	diskIopsReadOnly()	Gets the total number of IOPS allowed across all VMs mounting this shared disk as read-only.
Long	diskIopsReadWrite()	Gets the number of IOPS allowed for this disk.
Long	diskMBpsReadOnly()	Gets the total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.
Long	diskMBpsReadWrite()	Gets the throughput (MBps) allowed for this disk.
Encryption	encryption()	Gets the disk encryption.
EncryptionSettingsCollection	encryptionSettings()	Gets the disk encryption settings.
String	grantAccess(int accessDurationInSeconds)	Grants access to the disk.
Mono<String>	grantAccessAsync(int accessDurationInSeconds)	Grants access to the disk asynchronously.
HyperVGeneration	hyperVGeneration()	Gets the hypervisor generation.
boolean	isAttachedToVirtualMachine()	Checks whether the disk is attached to a virtual machine.
boolean	isHibernationSupported()	Checks whether the OS on a disk supports hibernation.
Integer	logicalSectorSizeInBytes()	Gets logical sector size in bytes for Premium SSD v2 and Ultra disks.
int	maximumShares()	Gets the maximum number of VMs that can attach to the disk at the same time.
OperatingSystemTypes	osType()	Gets the type of the operating system on the disk.
PublicNetworkAccess	publicNetworkAccess()	Whether the disk can be accessed from public network.
void	revokeAccess()	Revokes access granted to the disk.
Mono<Void>	revokeAccessAsync()	Revokes access granted to the disk asynchronously.
long	sizeInByte()	Gets disk size in byte.
int	sizeInGB()	Gets disk size in GB.
DiskSkuTypes	sku()	Gets the disk SKU.
CreationSource	source()	Gets the details of the source from which the disk is created.
String	virtualMachineId()	Gets the resource ID of the virtual machine this disk is attached to.
List<String>	virtualMachineIds()	Gets the list of the virtual machines that this disk is attached to.

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Method Details

sku

DiskSkuTypes sku()

Gets the disk SKU.

Returns:

the disk SKU

creationMethod

DiskCreateOption creationMethod()

Gets the disk creation method.

Returns:

the disk creation method

isAttachedToVirtualMachine

boolean isAttachedToVirtualMachine()

Checks whether the disk is attached to a virtual machine.

Returns:

true if the disk is attached to a virtual machine, otherwise false

virtualMachineId

String virtualMachineId()

Gets the resource ID of the virtual machine this disk is attached to.

If the disk can be shared, use virtualMachineIds() to get the list of all virtual machines.

Returns:

the resource ID of the virtual machine this disk is attached to, or null if the disk is in a detached state

virtualMachineIds

List<String> virtualMachineIds()

Gets the list of the virtual machines that this disk is attached to.

A disk could be attached to multiple virtual machines.

Returns:

the resource ID of the virtual machines this disk is attached to

sizeInGB

int sizeInGB()

Gets disk size in GB.

Returns:

disk size in GB

sizeInByte

long sizeInByte()

Gets disk size in byte.

Returns:

disk size in byte

osType

OperatingSystemTypes osType()

Gets the type of the operating system on the disk.

Returns:

the type of the operating system on the disk

source

CreationSource source()

Gets the details of the source from which the disk is created.

Returns:

the details of the source from which the disk is created

availabilityZones

Set<com.azure.resourcemanager.resources.fluentcore.arm.AvailabilityZoneId> availabilityZones()

Gets the availability zones assigned to the disk.

Returns:

the availability zones assigned to the disk

encryptionSettings

EncryptionSettingsCollection encryptionSettings()

Gets the disk encryption settings.

Returns:

the disk encryption settings

encryption

Encryption encryption()

Gets the disk encryption.

Returns:

the disk encryption

grantAccess

String grantAccess(int accessDurationInSeconds)

Grants access to the disk.

Parameters:

accessDurationInSeconds - the access duration in seconds

Returns:

the read-only SAS URI to the disk

grantAccessAsync

Mono<String> grantAccessAsync(int accessDurationInSeconds)

Grants access to the disk asynchronously.

Parameters:

accessDurationInSeconds - the access duration in seconds

Returns:

a representation of the deferred computation of this call returning a read-only SAS URI to the disk

revokeAccess

void revokeAccess()

Revokes access granted to the disk.

revokeAccessAsync

Mono<Void> revokeAccessAsync()

Revokes access granted to the disk asynchronously.

Returns:

a representation of the deferred computation of this call

isHibernationSupported

boolean isHibernationSupported()

Checks whether the OS on a disk supports hibernation.

Returns:

whether the OS on a disk supports hibernation.

logicalSectorSizeInBytes

Integer logicalSectorSizeInBytes()

Gets logical sector size in bytes for Premium SSD v2 and Ultra disks.

Returns:

logical sector size in bytes for Premium SSD v2 and Ultra disks.

hyperVGeneration

HyperVGeneration hyperVGeneration()

Gets the hypervisor generation.

Returns:

the hypervisor generation.

publicNetworkAccess

PublicNetworkAccess publicNetworkAccess()

Whether the disk can be accessed from public network.

Returns:

whether the disk can be accessed from public network.

diskIopsReadWrite

Long diskIopsReadWrite()

Gets the number of IOPS allowed for this disk.

Returns:

the number of IOPS allowed for this disk.

diskMBpsReadWrite

Long diskMBpsReadWrite()

Gets the throughput (MBps) allowed for this disk.

Returns:

the throughput (MBps) allowed for this disk.

diskIopsReadOnly

Long diskIopsReadOnly()

Gets the total number of IOPS allowed across all VMs mounting this shared disk as read-only.

Returns:

the total number of IOPS allowed for this shared read-only disk.

diskMBpsReadOnly

Long diskMBpsReadOnly()

Gets the total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.

Returns:

the total throughput (MBps) allowed for this shared read-only disk.

maximumShares

int maximumShares()

Gets the maximum number of VMs that can attach to the disk at the same time.

Returns:

the maximum number of VMs that can attach to the disk at the same time.