com.azure.resourcemanager.compute.fluent.models

Class DiskInner

java.lang.Object

com.azure.core.management.ProxyResource

com.azure.core.management.Resource

com.azure.resourcemanager.compute.fluent.models.DiskInner

public class DiskInner
extends com.azure.core.management.Resource

Disk resource.

Constructor Summary

Constructors

Constructor and Description
DiskInner()

Method Summary

Modifier and Type	Method and Description
CreationData	creationData() Get the creationData property: Disk source information.
Long	diskIopsReadOnly() Get the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly.
Long	diskIopsReadWrite() Get the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks.
Long	diskMBpsReadOnly() Get the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.
Long	diskMBpsReadWrite() Get the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks.
Long	diskSizeBytes() Get the diskSizeBytes property: The size of the disk in bytes.
Integer	diskSizeGB() Get the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create.
DiskState	diskState() Get the diskState property: The state of the disk.
Encryption	encryption() Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
EncryptionSettingsCollection	encryptionSettingsCollection() Get the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
HyperVGeneration	hyperVGeneration() Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine.
String	managedBy() Get the managedBy property: A relative URI containing the ID of the VM that has the disk attached.
List<String>	managedByExtended() Get the managedByExtended property: List of relative URIs containing the IDs of the VMs that have the disk attached.
Integer	maxShares() Get the maxShares property: The maximum number of VMs that can attach to the disk at the same time.
OperatingSystemTypes	osType() Get the osType property: The Operating System type.
String	provisioningState() Get the provisioningState property: The disk provisioning state.
List<ShareInfoElement>	shareInfo() Get the shareInfo property: Details of the list of all VMs that have the disk attached.
DiskSku	sku() Get the sku property: The disks sku name.
OffsetDateTime	timeCreated() Get the timeCreated property: The time when the disk was created.
String	uniqueId() Get the uniqueId property: Unique Guid identifying the resource.
void	validate() Validates the instance.
DiskInner	withCreationData(CreationData creationData) Set the creationData property: Disk source information.
DiskInner	withDiskIopsReadOnly(Long diskIopsReadOnly) Set the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly.
DiskInner	withDiskIopsReadWrite(Long diskIopsReadWrite) Set the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks.
DiskInner	withDiskMBpsReadOnly(Long diskMBpsReadOnly) Set the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.
DiskInner	withDiskMBpsReadWrite(Long diskMBpsReadWrite) Set the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks.
DiskInner	withDiskSizeGB(Integer diskSizeGB) Set the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create.
DiskInner	withEncryption(Encryption encryption) Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
DiskInner	withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection) Set the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
DiskInner	withHyperVGeneration(HyperVGeneration hyperVGeneration) Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine.
DiskInner	withMaxShares(Integer maxShares) Set the maxShares property: The maximum number of VMs that can attach to the disk at the same time.
DiskInner	withOsType(OperatingSystemTypes osType) Set the osType property: The Operating System type.
DiskInner	withSku(DiskSku sku) Set the sku property: The disks sku name.
DiskInner	withZones(List<String> zones) Set the zones property: The Logical zone list for Disk.
List<String>	zones() Get the zones property: The Logical zone list for Disk.

Methods inherited from class com.azure.core.management.Resource

location, tags, withLocation, withTags

Methods inherited from class com.azure.core.management.ProxyResource

id, name, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiskInner

public DiskInner()

Method Detail

managedBy

public String managedBy()

Get the managedBy property: A relative URI containing the ID of the VM that has the disk attached.

Returns:

the managedBy value.

managedByExtended

public List<String> managedByExtended()

Get the managedByExtended property: List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

Returns:

the managedByExtended value.

sku

public DiskSku sku()

Get the sku property: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.

Returns:

the sku value.

withSku

public DiskInner withSku(DiskSku sku)

Set the sku property: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.

Parameters:

sku - the sku value to set.

Returns:

the DiskInner object itself.

zones

public List<String> zones()

Get the zones property: The Logical zone list for Disk.

Returns:

the zones value.

withZones

public DiskInner withZones(List<String> zones)

Set the zones property: The Logical zone list for Disk.

Parameters:

zones - the zones value to set.

Returns:

the DiskInner object itself.

timeCreated

public OffsetDateTime timeCreated()

Get the timeCreated property: The time when the disk was created.

Returns:

the timeCreated value.

osType

public OperatingSystemTypes osType()

Get the osType property: The Operating System type.

Returns:

the osType value.

withOsType

public DiskInner withOsType(OperatingSystemTypes osType)

Set the osType property: The Operating System type.

Parameters:

osType - the osType value to set.

Returns:

the DiskInner object itself.

hyperVGeneration

public HyperVGeneration hyperVGeneration()

Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

Returns:

the hyperVGeneration value.

withHyperVGeneration

public DiskInner withHyperVGeneration(HyperVGeneration hyperVGeneration)

Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

Parameters:

hyperVGeneration - the hyperVGeneration value to set.

Returns:

the DiskInner object itself.

creationData

public CreationData creationData()

Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.

Returns:

the creationData value.

withCreationData

public DiskInner withCreationData(CreationData creationData)

Set the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.

Parameters:

creationData - the creationData value to set.

Returns:

the DiskInner object itself.

diskSizeGB

public Integer diskSizeGB()

Get the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

Returns:

the diskSizeGB value.

withDiskSizeGB

public DiskInner withDiskSizeGB(Integer diskSizeGB)

Set the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

Parameters:

diskSizeGB - the diskSizeGB value to set.

Returns:

the DiskInner object itself.

diskSizeBytes

public Long diskSizeBytes()

Get the diskSizeBytes property: The size of the disk in bytes. This field is read only.

Returns:

the diskSizeBytes value.

uniqueId

public String uniqueId()

Get the uniqueId property: Unique Guid identifying the resource.

Returns:

the uniqueId value.

encryptionSettingsCollection

public EncryptionSettingsCollection encryptionSettingsCollection()

Get the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

Returns:

the encryptionSettingsCollection value.

withEncryptionSettingsCollection

public DiskInner withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)

Set the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

Parameters:

encryptionSettingsCollection - the encryptionSettingsCollection value to set.

Returns:

the DiskInner object itself.

provisioningState

public String provisioningState()

Get the provisioningState property: The disk provisioning state.

Returns:

the provisioningState value.

diskIopsReadWrite

public Long diskIopsReadWrite()

Get the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

Returns:

the diskIopsReadWrite value.

withDiskIopsReadWrite

public DiskInner withDiskIopsReadWrite(Long diskIopsReadWrite)

Set the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

Parameters:

diskIopsReadWrite - the diskIopsReadWrite value to set.

Returns:

the DiskInner object itself.

diskMBpsReadWrite

public Long diskMBpsReadWrite()

Get the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Returns:

the diskMBpsReadWrite value.

withDiskMBpsReadWrite

public DiskInner withDiskMBpsReadWrite(Long diskMBpsReadWrite)

Set the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Parameters:

diskMBpsReadWrite - the diskMBpsReadWrite value to set.

Returns:

the DiskInner object itself.

diskIopsReadOnly

public Long diskIopsReadOnly()

Get the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.

Returns:

the diskIopsReadOnly value.

withDiskIopsReadOnly

public DiskInner withDiskIopsReadOnly(Long diskIopsReadOnly)

Set the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.

Parameters:

diskIopsReadOnly - the diskIopsReadOnly value to set.

Returns:

the DiskInner object itself.

diskMBpsReadOnly

public Long diskMBpsReadOnly()

Get the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Returns:

the diskMBpsReadOnly value.

withDiskMBpsReadOnly

public DiskInner withDiskMBpsReadOnly(Long diskMBpsReadOnly)

Set the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

Parameters:

diskMBpsReadOnly - the diskMBpsReadOnly value to set.

Returns:

the DiskInner object itself.

diskState

public DiskState diskState()

Get the diskState property: The state of the disk.

Returns:

the diskState value.

encryption

public Encryption encryption()

Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

Returns:

the encryption value.

withEncryption

public DiskInner withEncryption(Encryption encryption)

Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

Parameters:

encryption - the encryption value to set.

Returns:

the DiskInner object itself.

maxShares

public Integer maxShares()

Get the maxShares property: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.

Returns:

the maxShares value.

withMaxShares

public DiskInner withMaxShares(Integer maxShares)

Set the maxShares property: The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.

Parameters:

maxShares - the maxShares value to set.

Returns:

the DiskInner object itself.

shareInfo

public List<ShareInfoElement> shareInfo()

Get the shareInfo property: Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

Returns:

the shareInfo value.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.