DiskInner Class
- java.
lang. Object - com.
azure. core. management. ProxyResource - com.
azure. core. management. Resource - com.
azure. resourcemanager. compute. fluent. models. DiskInner
- com.
- com.
- com.
public final class DiskInner
extends Resource
Disk resource.
Constructor Summary
Constructor | Description |
---|---|
DiskInner() |
Creates an instance of Disk |
Method Summary
Modifier and Type | Method and Description |
---|---|
Boolean |
burstingEnabled()
Get the bursting |
Offset |
burstingEnabledTime()
Get the bursting |
Float |
completionPercent()
Get the completion |
Creation |
creationData()
Get the creation |
Data |
dataAccessAuthMode()
Get the data |
String |
diskAccessId()
Get the disk |
Long |
diskIopsReadOnly()
Get the disk |
Long |
diskIopsReadWrite()
Get the disk |
Long |
diskMBpsReadOnly()
Get the disk |
Long |
diskMBpsReadWrite()
Get the disk |
Long |
diskSizeBytes()
Get the disk |
Integer |
diskSizeGB()
Get the disk |
Disk |
diskState()
Get 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. |
Encryption |
encryptionSettingsCollection()
Get the encryption |
Extended |
extendedLocation()
Get the extended |
static
Disk |
fromJson(JsonReader jsonReader)
Reads an instance of Disk |
Hyper |
hyperVGeneration()
Get the hyper |
String |
id()
Get the id property: Fully qualified resource Id for the resource. |
Offset |
lastOwnershipUpdateTime()
Get the last |
String |
managedBy()
Get the managed |
List<String> |
managedByExtended()
Get the managed |
Integer |
maxShares()
Get the max |
String |
name()
Get the name property: The name of the resource. |
Network |
networkAccessPolicy()
Get the network |
Boolean |
optimizedForFrequentAttach()
Get the optimized |
Operating |
osType()
Get the os |
Property |
propertyUpdatesInProgress()
Get the property |
String |
provisioningState()
Get the provisioning |
Public |
publicNetworkAccess()
Get the public |
Purchase |
purchasePlan()
Get the purchase |
Disk |
securityProfile()
Get the security |
List<Share |
shareInfo()
Get the share |
Disk |
sku()
Get the sku property: The disks sku name. |
Supported |
supportedCapabilities()
Get the supported |
Boolean |
supportsHibernation()
Get the supports |
String |
tier()
Get the tier property: Performance tier of the disk (e. |
Offset |
timeCreated()
Get the time |
Json |
toJson(JsonWriter jsonWriter) |
String |
type()
Get the type property: The type of the resource. |
String |
uniqueId()
Get the unique |
void |
validate()
Validates the instance. |
Disk |
withBurstingEnabled(Boolean burstingEnabled)
Set the bursting |
Disk |
withCompletionPercent(Float completionPercent)
Set the completion |
Disk |
withCreationData(CreationData creationData)
Set the creation |
Disk |
withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)
Set the data |
Disk |
withDiskAccessId(String diskAccessId)
Set the disk |
Disk |
withDiskIopsReadOnly(Long diskIopsReadOnly)
Set the disk |
Disk |
withDiskIopsReadWrite(Long diskIopsReadWrite)
Set the disk |
Disk |
withDiskMBpsReadOnly(Long diskMBpsReadOnly)
Set the disk |
Disk |
withDiskMBpsReadWrite(Long diskMBpsReadWrite)
Set the disk |
Disk |
withDiskSizeGB(Integer diskSizeGB)
Set the disk |
Disk |
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. |
Disk |
withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)
Set the encryption |
Disk |
withExtendedLocation(ExtendedLocation extendedLocation)
Set the extended |
Disk |
withHyperVGeneration(HyperVGeneration hyperVGeneration)
Set the hyper |
Disk |
withLocation(String location) |
Disk |
withMaxShares(Integer maxShares)
Set the max |
Disk |
withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)
Set the network |
Disk |
withOptimizedForFrequentAttach(Boolean optimizedForFrequentAttach)
Set the optimized |
Disk |
withOsType(OperatingSystemTypes osType)
Set the os |
Disk |
withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the public |
Disk |
withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)
Set the purchase |
Disk |
withSecurityProfile(DiskSecurityProfile securityProfile)
Set the security |
Disk |
withSku(DiskSku sku)
Set the sku property: The disks sku name. |
Disk |
withSupportedCapabilities(SupportedCapabilities supportedCapabilities)
Set the supported |
Disk |
withSupportsHibernation(Boolean supportsHibernation)
Set the supports |
Disk |
withTags(Map<String,String> tags) |
Disk |
withTier(String tier)
Set the tier property: Performance tier of the disk (e. |
Disk |
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 ProxyResource
Methods inherited from Resource
Methods inherited from java.lang.Object
Constructor Details
DiskInner
public DiskInner()
Creates an instance of DiskInner class.
Method Details
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:
burstingEnabledTime
public OffsetDateTime burstingEnabledTime()
Get the burstingEnabledTime property: Latest time when bursting was last enabled on a disk.
Returns:
completionPercent
public Float completionPercent()
Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.
Returns:
creationData
public CreationData creationData()
Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.
Returns:
dataAccessAuthMode
public DataAccessAuthMode dataAccessAuthMode()
Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.
Returns:
diskAccessId
public String diskAccessId()
Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
Returns:
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:
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:
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:
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:
diskSizeBytes
public Long diskSizeBytes()
Get the diskSizeBytes property: The size of the disk in bytes. This field is read only.
Returns:
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:
diskState
public DiskState diskState()
Get the diskState property: The state of the disk.
Returns:
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:
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:
extendedLocation
public ExtendedLocation extendedLocation()
Get the extendedLocation property: The extended location where the disk will be created. Extended location cannot be changed.
Returns:
fromJson
public static DiskInner fromJson(JsonReader jsonReader)
Reads an instance of DiskInner from the JsonReader.
Parameters:
Returns:
Throws:
hyperVGeneration
public HyperVGeneration hyperVGeneration()
Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
Returns:
id
public String id()
Get the id property: Fully qualified resource Id for the resource.
Overrides:
DiskInner.id()Returns:
lastOwnershipUpdateTime
public OffsetDateTime lastOwnershipUpdateTime()
Get the lastOwnershipUpdateTime property: The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started.
Returns:
managedBy
public String managedBy()
Get the managedBy property: A relative URI containing the ID of the VM that has the disk attached.
Returns:
managedByExtended
public List
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:
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:
name
public String name()
Get the name property: The name of the resource.
Overrides:
DiskInner.name()Returns:
networkAccessPolicy
public NetworkAccessPolicy networkAccessPolicy()
Get the networkAccessPolicy property: Policy for accessing the disk via network.
Returns:
optimizedForFrequentAttach
public Boolean optimizedForFrequentAttach()
Get the optimizedForFrequentAttach property: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.
Returns:
osType
public OperatingSystemTypes osType()
Get the osType property: The Operating System type.
Returns:
propertyUpdatesInProgress
public PropertyUpdatesInProgress propertyUpdatesInProgress()
Get the propertyUpdatesInProgress property: Properties of the disk for which update is pending.
Returns:
provisioningState
public String provisioningState()
Get the provisioningState property: The disk provisioning state.
Returns:
publicNetworkAccess
public PublicNetworkAccess publicNetworkAccess()
Get the publicNetworkAccess property: Policy for controlling export on the disk.
Returns:
purchasePlan
public PurchasePlanAutoGenerated 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:
securityProfile
public DiskSecurityProfile securityProfile()
Get the securityProfile property: Contains the security related information for the resource.
Returns:
shareInfo
public List
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:
sku
public DiskSku 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:
supportedCapabilities
public SupportedCapabilities supportedCapabilities()
Get the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created.
Returns:
supportsHibernation
public Boolean supportsHibernation()
Get the supportsHibernation property: Indicates the OS on a disk supports hibernation.
Returns:
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:
timeCreated
public OffsetDateTime timeCreated()
Get the timeCreated property: The time when the disk was created.
Returns:
toJson
public JsonWriter toJson(JsonWriter jsonWriter)
Overrides:
DiskInner.toJson(JsonWriter jsonWriter)Parameters:
Throws:
type
public String type()
Get the type property: The type of the resource.
Overrides:
DiskInner.type()Returns:
uniqueId
public String uniqueId()
Get the uniqueId property: Unique Guid identifying the resource.
Returns:
validate
public void validate()
Validates the instance.
withBurstingEnabled
public DiskInner 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:
Returns:
withCompletionPercent
public DiskInner withCompletionPercent(Float completionPercent)
Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.
Parameters:
Returns:
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:
Returns:
withDataAccessAuthMode
public DiskInner withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)
Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.
Parameters:
Returns:
withDiskAccessId
public DiskInner withDiskAccessId(String diskAccessId)
Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
withExtendedLocation
public DiskInner withExtendedLocation(ExtendedLocation extendedLocation)
Set the extendedLocation property: The extended location where the disk will be created. Extended location cannot be changed.
Parameters:
Returns:
withHyperVGeneration
public DiskInner withHyperVGeneration(HyperVGeneration hyperVGeneration)
Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
Parameters:
Returns:
withLocation
public DiskInner withLocation(String location)
Overrides:
DiskInner.withLocation(String location)Parameters:
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:
Returns:
withNetworkAccessPolicy
public DiskInner withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)
Set the networkAccessPolicy property: Policy for accessing the disk via network.
Parameters:
Returns:
withOptimizedForFrequentAttach
public DiskInner withOptimizedForFrequentAttach(Boolean optimizedForFrequentAttach)
Set the optimizedForFrequentAttach property: Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.
Parameters:
Returns:
withOsType
public DiskInner withOsType(OperatingSystemTypes osType)
Set the osType property: The Operating System type.
Parameters:
Returns:
withPublicNetworkAccess
public DiskInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Policy for controlling export on the disk.
Parameters:
Returns:
withPurchasePlan
public DiskInner withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)
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:
Returns:
withSecurityProfile
public DiskInner withSecurityProfile(DiskSecurityProfile securityProfile)
Set the securityProfile property: Contains the security related information for the resource.
Parameters:
Returns:
withSku
public DiskInner withSku(DiskSku sku)
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:
Returns:
withSupportedCapabilities
public DiskInner withSupportedCapabilities(SupportedCapabilities supportedCapabilities)
Set the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created.
Parameters:
Returns:
withSupportsHibernation
public DiskInner withSupportsHibernation(Boolean supportsHibernation)
Set the supportsHibernation property: Indicates the OS on a disk supports hibernation.
Parameters:
Returns:
withTags
public DiskInner withTags(Map
Overrides:
DiskInner.withTags(Map<String,String> tags)Parameters:
withTier
public DiskInner 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:
Returns:
withZones
public DiskInner withZones(List
Set the zones property: The Logical zone list for Disk.
Parameters:
Returns:
zones
public List
Get the zones property: The Logical zone list for Disk.
Returns:
Applies to
Azure SDK for Java