Class DiskInner
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.compute.fluent.models.DiskInner
public final class DiskInner
extends com.azure.core.management.Resource
Disk resource.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the burstingEnabled property: Set to true to enable bursting beyond the provisioned performance target of the disk.Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.Get the creationData property: Disk source information.Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.Get the diskIopsReadOnly property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly.Get the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks.Get the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.Get the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks.Get the diskSizeBytes property: The size of the disk in bytes.Get the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create.Get the diskState property: The state of the disk.Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.Get the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.Get the extendedLocation property: The extended location where the disk will be created.Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine.Get the managedBy property: A relative URI containing the ID of the VM that has the disk attached.Get the managedByExtended property: List of relative URIs containing the IDs of the VMs that have the disk attached.Get the maxShares property: The maximum number of VMs that can attach to the disk at the same time.Get the networkAccessPolicy property: Policy for accessing the disk via network.osType()Get the osType property: The Operating System type.Get the propertyUpdatesInProgress property: Properties of the disk for which update is pending.Get the provisioningState property: The disk provisioning state.Get the publicNetworkAccess property: Policy for controlling export on the disk.Get the purchasePlan property: Purchase plan information for the the image from which the OS disk was created.Get the securityProfile property: Contains the security related information for the resource.Get the shareInfo property: Details of the list of all VMs that have the disk attached.sku()Get the sku property: The disks sku name.Get the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created.Get the supportsHibernation property: Indicates the OS on a disk supports hibernation.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/.Get the timeCreated property: The time when the disk was created.uniqueId()Get the uniqueId property: Unique Guid identifying the resource.voidvalidate()Validates the instance.withBurstingEnabled(Boolean burstingEnabled) Set the burstingEnabled property: Set to true to enable bursting beyond the provisioned performance target of the disk.withCompletionPercent(Float completionPercent) Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.withCreationData(CreationData creationData) Set the creationData property: Disk source information.withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode) Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.withDiskAccessId(String diskAccessId) Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.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.withDiskIopsReadWrite(Long diskIopsReadWrite) Set the diskIopsReadWrite property: The number of IOPS allowed for this disk; only settable for UltraSSD disks.withDiskMBpsReadOnly(Long diskMBpsReadOnly) Set the diskMBpsReadOnly property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly.withDiskMBpsReadWrite(Long diskMBpsReadWrite) Set the diskMBpsReadWrite property: The bandwidth allowed for this disk; only settable for UltraSSD disks.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.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.withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection) Set the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.withExtendedLocation(ExtendedLocation extendedLocation) Set the extendedLocation property: The extended location where the disk will be created.withHyperVGeneration(HyperVGeneration hyperVGeneration) Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine.withLocation(String location) withMaxShares(Integer maxShares) Set the maxShares property: The maximum number of VMs that can attach to the disk at the same time.withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy) Set the networkAccessPolicy property: Policy for accessing the disk via network.withOsType(OperatingSystemTypes osType) Set the osType property: The Operating System type.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Policy for controlling export on the disk.withPurchasePlan(PurchasePlanAutoGenerated purchasePlan) Set the purchasePlan property: Purchase plan information for the the image from which the OS disk was created.withSecurityProfile(DiskSecurityProfile securityProfile) Set the securityProfile property: Contains the security related information for the resource.Set the sku property: The disks sku name.withSupportedCapabilities(SupportedCapabilities supportedCapabilities) Set the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created.withSupportsHibernation(Boolean supportsHibernation) Set the supportsHibernation property: Indicates the OS on a disk supports hibernation.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/.Set the zones property: The Logical zone list for Disk.zones()Get the zones property: The Logical zone list for Disk.Methods inherited from class com.azure.core.management.Resource
location, tagsMethods inherited from class com.azure.core.management.ProxyResource
id, name, type
-
Constructor Details
-
DiskInner
public DiskInner()
-
-
Method Details
-
managedBy
Get the managedBy property: A relative URI containing the ID of the VM that has the disk attached.- Returns:
- the managedBy value.
-
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
Get the sku property: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.- Returns:
- the sku value.
-
withSku
Set the sku property: The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.- Parameters:
sku- the sku value to set.- Returns:
- the DiskInner object itself.
-
zones
Get the zones property: The Logical zone list for Disk.- Returns:
- the zones value.
-
withZones
Set the zones property: The Logical zone list for Disk.- Parameters:
zones- the zones value to set.- Returns:
- the DiskInner object itself.
-
extendedLocation
Get the extendedLocation property: The extended location where the disk will be created. Extended location cannot be changed.- Returns:
- the extendedLocation value.
-
withExtendedLocation
Set the extendedLocation property: The extended location where the disk will be created. Extended location cannot be changed.- Parameters:
extendedLocation- the extendedLocation value to set.- Returns:
- the DiskInner object itself.
-
withLocation
- Overrides:
withLocationin classcom.azure.core.management.Resource
-
withTags
- Overrides:
withTagsin classcom.azure.core.management.Resource
-
timeCreated
Get the timeCreated property: The time when the disk was created.- Returns:
- the timeCreated value.
-
osType
Get the osType property: The Operating System type.- Returns:
- the osType value.
-
withOsType
Set the osType property: The Operating System type.- Parameters:
osType- the osType value to set.- Returns:
- the DiskInner object itself.
-
hyperVGeneration
Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.- Returns:
- the hyperVGeneration value.
-
withHyperVGeneration
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.
-
purchasePlan
Get the purchasePlan property: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}.- Returns:
- the purchasePlan value.
-
withPurchasePlan
Set the purchasePlan property: Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}.- Parameters:
purchasePlan- the purchasePlan value to set.- Returns:
- the DiskInner object itself.
-
supportedCapabilities
Get the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created.- Returns:
- the supportedCapabilities value.
-
withSupportedCapabilities
Set the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created.- Parameters:
supportedCapabilities- the supportedCapabilities value to set.- Returns:
- the DiskInner object itself.
-
creationData
Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.- Returns:
- the creationData value.
-
withCreationData
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
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
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
Get the diskSizeBytes property: The size of the disk in bytes. This field is read only.- Returns:
- the diskSizeBytes value.
-
uniqueId
Get the uniqueId property: Unique Guid identifying the resource.- Returns:
- the uniqueId value.
-
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
Get the provisioningState property: The disk provisioning state.- Returns:
- the provisioningState value.
-
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
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
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
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
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
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
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
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
Get the diskState property: The state of the disk.- Returns:
- the diskState value.
-
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
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.
-
networkAccessPolicy
Get the networkAccessPolicy property: Policy for accessing the disk via network.- Returns:
- the networkAccessPolicy value.
-
withNetworkAccessPolicy
Set the networkAccessPolicy property: Policy for accessing the disk via network.- Parameters:
networkAccessPolicy- the networkAccessPolicy value to set.- Returns:
- the DiskInner object itself.
-
diskAccessId
Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.- Returns:
- the diskAccessId value.
-
withDiskAccessId
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 DiskInner object itself.
-
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
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 DiskInner object itself.
-
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
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 DiskInner object itself.
-
propertyUpdatesInProgress
Get the propertyUpdatesInProgress property: Properties of the disk for which update is pending.- Returns:
- the propertyUpdatesInProgress value.
-
supportsHibernation
Get the supportsHibernation property: Indicates the OS on a disk supports hibernation.- Returns:
- the supportsHibernation value.
-
withSupportsHibernation
Set the supportsHibernation property: Indicates the OS on a disk supports hibernation.- Parameters:
supportsHibernation- the supportsHibernation value to set.- Returns:
- the DiskInner object itself.
-
securityProfile
Get the securityProfile property: Contains the security related information for the resource.- Returns:
- the securityProfile value.
-
withSecurityProfile
Set the securityProfile property: Contains the security related information for the resource.- Parameters:
securityProfile- the securityProfile value to set.- Returns:
- the DiskInner object itself.
-
completionPercent
Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.- Returns:
- the completionPercent value.
-
withCompletionPercent
Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.- Parameters:
completionPercent- the completionPercent value to set.- Returns:
- the DiskInner object itself.
-
publicNetworkAccess
Get the publicNetworkAccess property: Policy for controlling export on the disk.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
Set the publicNetworkAccess property: Policy for controlling export on the disk.- Parameters:
publicNetworkAccess- the publicNetworkAccess value to set.- Returns:
- the DiskInner object itself.
-
dataAccessAuthMode
Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.- Returns:
- the dataAccessAuthMode value.
-
withDataAccessAuthMode
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 DiskInner object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-