Class DiskUpdate
- java.lang.Object
-
- com.azure.resourcemanager.compute.models.DiskUpdate
-
public final class DiskUpdate extends Object
Disk update resource.
-
-
Constructor Summary
Constructors Constructor Description DiskUpdate()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanburstingEnabled()Get the burstingEnabled property: Set to true to enable bursting beyond the provisioned performance target of the disk.DataAccessAuthModedataAccessAuthMode()Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.StringdiskAccessId()Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.LongdiskIopsReadOnly()Get the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly.LongdiskIopsReadWrite()Get the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks.LongdiskMBpsReadOnly()Get the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.LongdiskMBpsReadWrite()Get the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks.IntegerdiskSizeGB()Get the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create.Encryptionencryption()Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.EncryptionSettingsCollectionencryptionSettingsCollection()Get the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.IntegermaxShares()Get the maxShares property: The maximum number of VMs that can attach to the disk at the same time.NetworkAccessPolicynetworkAccessPolicy()Get the networkAccessPolicy property: Policy for accessing the disk via network.OperatingSystemTypesosType()Get the osType property: the Operating System type.PropertyUpdatesInProgresspropertyUpdatesInProgress()Get the propertyUpdatesInProgress property: Properties of the disk for which update is pending.PublicNetworkAccesspublicNetworkAccess()Get the publicNetworkAccess property: Policy for controlling export on the disk.PurchasePlanAutoGeneratedpurchasePlan()Get the purchasePlan property: Purchase plan information to be added on the OS disk.DiskSkusku()Get the sku property: The disks sku name.SupportedCapabilitiessupportedCapabilities()Get the supportedCapabilities property: List of supported capabilities to be added on the OS disk.BooleansupportsHibernation()Get the supportsHibernation property: Indicates the OS on a disk supports hibernation.Map<String,String>tags()Get the tags property: Resource tags.Stringtier()Get the tier property: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/.voidvalidate()Validates the instance.DiskUpdatewithBurstingEnabled(Boolean burstingEnabled)Set the burstingEnabled property: Set to true to enable bursting beyond the provisioned performance target of the disk.DiskUpdatewithDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.DiskUpdatewithDiskAccessId(String diskAccessId)Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.DiskUpdatewithDiskIopsReadOnly(Long diskIopsReadOnly)Set the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly.DiskUpdatewithDiskIopsReadWrite(Long diskIopsReadWrite)Set the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks.DiskUpdatewithDiskMBpsReadOnly(Long diskMBpsReadOnly)Set the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.DiskUpdatewithDiskMBpsReadWrite(Long diskMBpsReadWrite)Set the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks.DiskUpdatewithDiskSizeGB(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.DiskUpdatewithEncryption(Encryption encryption)Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.DiskUpdatewithEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)Set the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.DiskUpdatewithMaxShares(Integer maxShares)Set the maxShares property: The maximum number of VMs that can attach to the disk at the same time.DiskUpdatewithNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)Set the networkAccessPolicy property: Policy for accessing the disk via network.DiskUpdatewithOsType(OperatingSystemTypes osType)Set the osType property: the Operating System type.DiskUpdatewithPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)Set the publicNetworkAccess property: Policy for controlling export on the disk.DiskUpdatewithPurchasePlan(PurchasePlanAutoGenerated purchasePlan)Set the purchasePlan property: Purchase plan information to be added on the OS disk.DiskUpdatewithSku(DiskSku sku)Set the sku property: The disks sku name.DiskUpdatewithSupportedCapabilities(SupportedCapabilities supportedCapabilities)Set the supportedCapabilities property: List of supported capabilities to be added on the OS disk.DiskUpdatewithSupportsHibernation(Boolean supportsHibernation)Set the supportsHibernation property: Indicates the OS on a disk supports hibernation.DiskUpdatewithTags(Map<String,String> tags)Set the tags property: Resource tags.DiskUpdatewithTier(String tier)Set the tier property: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/.
-
-
-
Method Detail
-
tags
public Map<String,String> tags()
Get the tags property: Resource tags.- Returns:
- the tags value.
-
withTags
public DiskUpdate withTags(Map<String,String> tags)
Set the tags property: Resource tags.- Parameters:
tags- the tags value to set.- Returns:
- the DiskUpdate object itself.
-
sku
public DiskSku sku()
Get the sku property: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, or StandardSSD_ZRS.- Returns:
- the sku value.
-
withSku
public DiskUpdate withSku(DiskSku sku)
Set the sku property: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, or StandardSSD_ZRS.- Parameters:
sku- the sku value to set.- Returns:
- the DiskUpdate object itself.
-
osType
public OperatingSystemTypes osType()
Get the osType property: the Operating System type.- Returns:
- the osType value.
-
withOsType
public DiskUpdate withOsType(OperatingSystemTypes osType)
Set the osType property: the Operating System type.- Parameters:
osType- the osType value to set.- Returns:
- the DiskUpdate 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 DiskUpdate 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 DiskUpdate object itself.
-
encryptionSettingsCollection
public EncryptionSettingsCollection encryptionSettingsCollection()
Get the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.- Returns:
- the encryptionSettingsCollection value.
-
withEncryptionSettingsCollection
public DiskUpdate withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)
Set the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.- Parameters:
encryptionSettingsCollection- the encryptionSettingsCollection value to set.- Returns:
- the DiskUpdate object itself.
-
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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate 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 DiskUpdate object itself.
-
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 DiskUpdate 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 DiskUpdate object itself.
-
networkAccessPolicy
public NetworkAccessPolicy networkAccessPolicy()
Get the networkAccessPolicy property: Policy for accessing the disk via network.- Returns:
- the networkAccessPolicy value.
-
withNetworkAccessPolicy
public DiskUpdate withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)
Set the networkAccessPolicy property: Policy for accessing the disk via network.- Parameters:
networkAccessPolicy- the networkAccessPolicy value to set.- Returns:
- the DiskUpdate object itself.
-
diskAccessId
public String diskAccessId()
Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.- Returns:
- the diskAccessId value.
-
withDiskAccessId
public DiskUpdate withDiskAccessId(String diskAccessId)
Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.- Parameters:
diskAccessId- the diskAccessId value to set.- Returns:
- the DiskUpdate object itself.
-
tier
public String tier()
Get the tier property: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.- Returns:
- the tier value.
-
withTier
public DiskUpdate withTier(String tier)
Set the tier property: Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.- Parameters:
tier- the tier value to set.- Returns:
- the DiskUpdate object itself.
-
burstingEnabled
public Boolean burstingEnabled()
Get the burstingEnabled property: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.- Returns:
- the burstingEnabled value.
-
withBurstingEnabled
public DiskUpdate withBurstingEnabled(Boolean burstingEnabled)
Set the burstingEnabled property: Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.- Parameters:
burstingEnabled- the burstingEnabled value to set.- Returns:
- the DiskUpdate object itself.
-
purchasePlan
public PurchasePlanAutoGenerated purchasePlan()
Get the purchasePlan property: Purchase plan information to be added on the OS disk.- Returns:
- the purchasePlan value.
-
withPurchasePlan
public DiskUpdate withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)
Set the purchasePlan property: Purchase plan information to be added on the OS disk.- Parameters:
purchasePlan- the purchasePlan value to set.- Returns:
- the DiskUpdate object itself.
-
supportedCapabilities
public SupportedCapabilities supportedCapabilities()
Get the supportedCapabilities property: List of supported capabilities to be added on the OS disk.- Returns:
- the supportedCapabilities value.
-
withSupportedCapabilities
public DiskUpdate withSupportedCapabilities(SupportedCapabilities supportedCapabilities)
Set the supportedCapabilities property: List of supported capabilities to be added on the OS disk.- Parameters:
supportedCapabilities- the supportedCapabilities value to set.- Returns:
- the DiskUpdate object itself.
-
propertyUpdatesInProgress
public PropertyUpdatesInProgress propertyUpdatesInProgress()
Get the propertyUpdatesInProgress property: Properties of the disk for which update is pending.- Returns:
- the propertyUpdatesInProgress value.
-
supportsHibernation
public Boolean supportsHibernation()
Get the supportsHibernation property: Indicates the OS on a disk supports hibernation.- Returns:
- the supportsHibernation value.
-
withSupportsHibernation
public DiskUpdate withSupportsHibernation(Boolean supportsHibernation)
Set the supportsHibernation property: Indicates the OS on a disk supports hibernation.- Parameters:
supportsHibernation- the supportsHibernation value to set.- Returns:
- the DiskUpdate object itself.
-
publicNetworkAccess
public PublicNetworkAccess publicNetworkAccess()
Get the publicNetworkAccess property: Policy for controlling export on the disk.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
public DiskUpdate withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Policy for controlling export on the disk.- Parameters:
publicNetworkAccess- the publicNetworkAccess value to set.- Returns:
- the DiskUpdate object itself.
-
dataAccessAuthMode
public DataAccessAuthMode dataAccessAuthMode()
Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.- Returns:
- the dataAccessAuthMode value.
-
withDataAccessAuthMode
public DiskUpdate withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)
Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.- Parameters:
dataAccessAuthMode- the dataAccessAuthMode value to set.- Returns:
- the DiskUpdate object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
-