azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

720 строки
61 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties"
name: "DiskProperties"
nameWithType: "DiskProperties"
summary: "Disk resource properties."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **DiskProperties**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.DiskProperties()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.DiskProperties()"
name: "DiskProperties()"
nameWithType: "DiskProperties.DiskProperties()"
summary: "Creates an instance of Disk<wbr>Properties class."
syntax: "public DiskProperties()"
desc: "Creates an instance of DiskProperties class."
methods:
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.burstingEnabled()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.burstingEnabled()"
name: "burstingEnabled()"
nameWithType: "DiskProperties.burstingEnabled()"
summary: "Get the bursting<wbr>Enabled property: Set to true to enable bursting beyond the provisioned performance target of the disk."
syntax: "public Boolean burstingEnabled()"
desc: "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:
description: "the burstingEnabled value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.burstingEnabledTime()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.burstingEnabledTime()"
name: "burstingEnabledTime()"
nameWithType: "DiskProperties.burstingEnabledTime()"
summary: "Get the bursting<wbr>Enabled<wbr>Time property: Latest time when bursting was last enabled on a disk."
syntax: "public OffsetDateTime burstingEnabledTime()"
desc: "Get the burstingEnabledTime property: Latest time when bursting was last enabled on a disk."
returns:
description: "the burstingEnabledTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.completionPercent()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.completionPercent()"
name: "completionPercent()"
nameWithType: "DiskProperties.completionPercent()"
summary: "Get the completion<wbr>Percent property: Percentage complete for the background copy when a resource is created via the Copy<wbr>Start operation."
syntax: "public Float completionPercent()"
desc: "Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation."
returns:
description: "the completionPercent value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.creationData()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.creationData()"
name: "creationData()"
nameWithType: "DiskProperties.creationData()"
summary: "Get the creation<wbr>Data property: Disk source information."
syntax: "public CreationData creationData()"
desc: "Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created."
returns:
description: "the creationData value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.CreationData?alt=com.azure.resourcemanager.compute.models.CreationData&text=CreationData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.dataAccessAuthMode()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.dataAccessAuthMode()"
name: "dataAccessAuthMode()"
nameWithType: "DiskProperties.dataAccessAuthMode()"
summary: "Get the data<wbr>Access<wbr>Auth<wbr>Mode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
syntax: "public DataAccessAuthMode dataAccessAuthMode()"
desc: "Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
returns:
description: "the dataAccessAuthMode value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DataAccessAuthMode?alt=com.azure.resourcemanager.compute.models.DataAccessAuthMode&text=DataAccessAuthMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskAccessId()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskAccessId()"
name: "diskAccessId()"
nameWithType: "DiskProperties.diskAccessId()"
summary: "Get the disk<wbr>Access<wbr>Id property: ARM id of the Disk<wbr>Access resource for using private endpoints on disks."
syntax: "public String diskAccessId()"
desc: "Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks."
returns:
description: "the diskAccessId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskIopsReadOnly()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskIopsReadOnly()"
name: "diskIopsReadOnly()"
nameWithType: "DiskProperties.diskIopsReadOnly()"
summary: "Get the disk<wbr>Iops<wbr>Read<wbr>Only property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as Read<wbr>Only."
syntax: "public Long diskIopsReadOnly()"
desc: "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:
description: "the diskIopsReadOnly value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskIopsReadWrite()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskIopsReadWrite()"
name: "diskIopsReadWrite()"
nameWithType: "DiskProperties.diskIopsReadWrite()"
summary: "Get the disk<wbr>Iops<wbr>Read<wbr>Write property: The number of IOPS allowed for this disk; only settable for UltraSSD disks."
syntax: "public Long diskIopsReadWrite()"
desc: "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:
description: "the diskIopsReadWrite value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskMBpsReadOnly()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskMBpsReadOnly()"
name: "diskMBpsReadOnly()"
nameWithType: "DiskProperties.diskMBpsReadOnly()"
summary: "Get the disk<wbr>MBps<wbr>Read<wbr>Only property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as Read<wbr>Only."
syntax: "public Long diskMBpsReadOnly()"
desc: "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:
description: "the diskMBpsReadOnly value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskMBpsReadWrite()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskMBpsReadWrite()"
name: "diskMBpsReadWrite()"
nameWithType: "DiskProperties.diskMBpsReadWrite()"
summary: "Get the disk<wbr>MBps<wbr>Read<wbr>Write property: The bandwidth allowed for this disk; only settable for UltraSSD disks."
syntax: "public Long diskMBpsReadWrite()"
desc: "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:
description: "the diskMBpsReadWrite value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskSizeBytes()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskSizeBytes()"
name: "diskSizeBytes()"
nameWithType: "DiskProperties.diskSizeBytes()"
summary: "Get the disk<wbr>Size<wbr>Bytes property: The size of the disk in bytes."
syntax: "public Long diskSizeBytes()"
desc: "Get the diskSizeBytes property: The size of the disk in bytes. This field is read only."
returns:
description: "the diskSizeBytes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskSizeGB()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskSizeGB()"
name: "diskSizeGB()"
nameWithType: "DiskProperties.diskSizeGB()"
summary: "Get the disk<wbr>SizeGB property: If creation<wbr>Data.<wbr>create<wbr>Option is Empty, this field is mandatory and it indicates the size of the disk to create."
syntax: "public Integer diskSizeGB()"
desc: "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:
description: "the diskSizeGB value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskState()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.diskState()"
name: "diskState()"
nameWithType: "DiskProperties.diskState()"
summary: "Get the disk<wbr>State property: The state of the disk."
syntax: "public DiskState diskState()"
desc: "Get the diskState property: The state of the disk."
returns:
description: "the diskState value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskState?alt=com.azure.resourcemanager.compute.models.DiskState&text=DiskState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.encryption()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.encryption()"
name: "encryption()"
nameWithType: "DiskProperties.encryption()"
summary: "Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
syntax: "public Encryption encryption()"
desc: "Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
returns:
description: "the encryption value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.Encryption?alt=com.azure.resourcemanager.compute.models.Encryption&text=Encryption\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.encryptionSettingsCollection()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.encryptionSettingsCollection()"
name: "encryptionSettingsCollection()"
nameWithType: "DiskProperties.encryptionSettingsCollection()"
summary: "Get the encryption<wbr>Settings<wbr>Collection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
syntax: "public EncryptionSettingsCollection encryptionSettingsCollection()"
desc: "Get the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
returns:
description: "the encryptionSettingsCollection value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.EncryptionSettingsCollection?alt=com.azure.resourcemanager.compute.models.EncryptionSettingsCollection&text=EncryptionSettingsCollection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "DiskProperties.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Disk<wbr>Properties from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static DiskProperties fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of DiskProperties from the JsonReader."
returns:
description: "An instance of DiskProperties if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.hyperVGeneration()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.hyperVGeneration()"
name: "hyperVGeneration()"
nameWithType: "DiskProperties.hyperVGeneration()"
summary: "Get the hyper<wbr>VGeneration property: The hypervisor generation of the Virtual Machine."
syntax: "public HyperVGeneration hyperVGeneration()"
desc: "Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only."
returns:
description: "the hyperVGeneration value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.HyperVGeneration?alt=com.azure.resourcemanager.compute.models.HyperVGeneration&text=HyperVGeneration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.lastOwnershipUpdateTime()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.lastOwnershipUpdateTime()"
name: "lastOwnershipUpdateTime()"
nameWithType: "DiskProperties.lastOwnershipUpdateTime()"
summary: "Get the last<wbr>Ownership<wbr>Update<wbr>Time property: The UTC time when the ownership state of the disk was last changed i.<wbr>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."
syntax: "public OffsetDateTime lastOwnershipUpdateTime()"
desc: "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:
description: "the lastOwnershipUpdateTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.maxShares()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.maxShares()"
name: "maxShares()"
nameWithType: "DiskProperties.maxShares()"
summary: "Get the max<wbr>Shares property: The maximum number of VMs that can attach to the disk at the same time."
syntax: "public Integer maxShares()"
desc: "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:
description: "the maxShares value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.networkAccessPolicy()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.networkAccessPolicy()"
name: "networkAccessPolicy()"
nameWithType: "DiskProperties.networkAccessPolicy()"
summary: "Get the network<wbr>Access<wbr>Policy property: Policy for accessing the disk via network."
syntax: "public NetworkAccessPolicy networkAccessPolicy()"
desc: "Get the networkAccessPolicy property: Policy for accessing the disk via network."
returns:
description: "the networkAccessPolicy value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.NetworkAccessPolicy?alt=com.azure.resourcemanager.compute.models.NetworkAccessPolicy&text=NetworkAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.optimizedForFrequentAttach()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.optimizedForFrequentAttach()"
name: "optimizedForFrequentAttach()"
nameWithType: "DiskProperties.optimizedForFrequentAttach()"
summary: "Get the optimized<wbr>For<wbr>Frequent<wbr>Attach 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."
syntax: "public Boolean optimizedForFrequentAttach()"
desc: "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:
description: "the optimizedForFrequentAttach value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.osType()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.osType()"
name: "osType()"
nameWithType: "DiskProperties.osType()"
summary: "Get the os<wbr>Type property: The Operating System type."
syntax: "public OperatingSystemTypes osType()"
desc: "Get the osType property: The Operating System type."
returns:
description: "the osType value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.OperatingSystemTypes?alt=com.azure.resourcemanager.compute.models.OperatingSystemTypes&text=OperatingSystemTypes\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.propertyUpdatesInProgress()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.propertyUpdatesInProgress()"
name: "propertyUpdatesInProgress()"
nameWithType: "DiskProperties.propertyUpdatesInProgress()"
summary: "Get the property<wbr>Updates<wbr>InProgress property: Properties of the disk for which update is pending."
syntax: "public PropertyUpdatesInProgress propertyUpdatesInProgress()"
desc: "Get the propertyUpdatesInProgress property: Properties of the disk for which update is pending."
returns:
description: "the propertyUpdatesInProgress value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PropertyUpdatesInProgress?alt=com.azure.resourcemanager.compute.models.PropertyUpdatesInProgress&text=PropertyUpdatesInProgress\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.provisioningState()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.provisioningState()"
name: "provisioningState()"
nameWithType: "DiskProperties.provisioningState()"
summary: "Get the provisioning<wbr>State property: The disk provisioning state."
syntax: "public String provisioningState()"
desc: "Get the provisioningState property: The disk provisioning state."
returns:
description: "the provisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.publicNetworkAccess()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.publicNetworkAccess()"
name: "publicNetworkAccess()"
nameWithType: "DiskProperties.publicNetworkAccess()"
summary: "Get the public<wbr>Network<wbr>Access property: Policy for controlling export on the disk."
syntax: "public PublicNetworkAccess publicNetworkAccess()"
desc: "Get the publicNetworkAccess property: Policy for controlling export on the disk."
returns:
description: "the publicNetworkAccess value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PublicNetworkAccess?alt=com.azure.resourcemanager.compute.models.PublicNetworkAccess&text=PublicNetworkAccess\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.purchasePlan()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.purchasePlan()"
name: "purchasePlan()"
nameWithType: "DiskProperties.purchasePlan()"
summary: "Get the purchase<wbr>Plan property: Purchase plan information for the the image from which the OS disk was created."
syntax: "public PurchasePlanAutoGenerated purchasePlan()"
desc: "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:
description: "the purchasePlan value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated?alt=com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated&text=PurchasePlanAutoGenerated\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.securityProfile()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.securityProfile()"
name: "securityProfile()"
nameWithType: "DiskProperties.securityProfile()"
summary: "Get the security<wbr>Profile property: Contains the security related information for the resource."
syntax: "public DiskSecurityProfile securityProfile()"
desc: "Get the securityProfile property: Contains the security related information for the resource."
returns:
description: "the securityProfile value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskSecurityProfile?alt=com.azure.resourcemanager.compute.models.DiskSecurityProfile&text=DiskSecurityProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.shareInfo()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.shareInfo()"
name: "shareInfo()"
nameWithType: "DiskProperties.shareInfo()"
summary: "Get the share<wbr>Info property: Details of the list of all VMs that have the disk attached."
syntax: "public List<ShareInfoElement> shareInfo()"
desc: "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:
description: "the shareInfo value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.compute.models.ShareInfoElement?alt=com.azure.resourcemanager.compute.models.ShareInfoElement&text=ShareInfoElement\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.supportedCapabilities()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.supportedCapabilities()"
name: "supportedCapabilities()"
nameWithType: "DiskProperties.supportedCapabilities()"
summary: "Get the supported<wbr>Capabilities property: List of supported capabilities for the image from which the OS disk was created."
syntax: "public SupportedCapabilities supportedCapabilities()"
desc: "Get the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created."
returns:
description: "the supportedCapabilities value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.SupportedCapabilities?alt=com.azure.resourcemanager.compute.models.SupportedCapabilities&text=SupportedCapabilities\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.supportsHibernation()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.supportsHibernation()"
name: "supportsHibernation()"
nameWithType: "DiskProperties.supportsHibernation()"
summary: "Get the supports<wbr>Hibernation property: Indicates the OS on a disk supports hibernation."
syntax: "public Boolean supportsHibernation()"
desc: "Get the supportsHibernation property: Indicates the OS on a disk supports hibernation."
returns:
description: "the supportsHibernation value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.tier()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.tier()"
name: "tier()"
nameWithType: "DiskProperties.tier()"
summary: "Get the tier property: Performance tier of the disk (e.<wbr>g, P4, S10) as described here: https://azure.<wbr>microsoft.<wbr>com/en-us/pricing/details/managed-disks/."
syntax: "public String tier()"
desc: "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:
description: "the tier value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.timeCreated()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.timeCreated()"
name: "timeCreated()"
nameWithType: "DiskProperties.timeCreated()"
summary: "Get the time<wbr>Created property: The time when the disk was created."
syntax: "public OffsetDateTime timeCreated()"
desc: "Get the timeCreated property: The time when the disk was created."
returns:
description: "the timeCreated value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "DiskProperties.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.uniqueId()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.uniqueId()"
name: "uniqueId()"
nameWithType: "DiskProperties.uniqueId()"
summary: "Get the unique<wbr>Id property: Unique Guid identifying the resource."
syntax: "public String uniqueId()"
desc: "Get the uniqueId property: Unique Guid identifying the resource."
returns:
description: "the uniqueId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.validate()"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.validate()"
name: "validate()"
nameWithType: "DiskProperties.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withBurstingEnabled(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withBurstingEnabled(Boolean burstingEnabled)"
name: "withBurstingEnabled(Boolean burstingEnabled)"
nameWithType: "DiskProperties.withBurstingEnabled(Boolean burstingEnabled)"
summary: "Set the bursting<wbr>Enabled property: Set to true to enable bursting beyond the provisioned performance target of the disk."
parameters:
- description: "the burstingEnabled value to set."
name: "burstingEnabled"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public DiskProperties withBurstingEnabled(Boolean burstingEnabled)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withCompletionPercent(java.lang.Float)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withCompletionPercent(Float completionPercent)"
name: "withCompletionPercent(Float completionPercent)"
nameWithType: "DiskProperties.withCompletionPercent(Float completionPercent)"
summary: "Set the completion<wbr>Percent property: Percentage complete for the background copy when a resource is created via the Copy<wbr>Start operation."
parameters:
- description: "the completionPercent value to set."
name: "completionPercent"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
syntax: "public DiskProperties withCompletionPercent(Float completionPercent)"
desc: "Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withCreationData(com.azure.resourcemanager.compute.models.CreationData)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withCreationData(CreationData creationData)"
name: "withCreationData(CreationData creationData)"
nameWithType: "DiskProperties.withCreationData(CreationData creationData)"
summary: "Set the creation<wbr>Data property: Disk source information."
parameters:
- description: "the creationData value to set."
name: "creationData"
type: "<xref href=\"com.azure.resourcemanager.compute.models.CreationData?alt=com.azure.resourcemanager.compute.models.CreationData&text=CreationData\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withCreationData(CreationData creationData)"
desc: "Set the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDataAccessAuthMode(com.azure.resourcemanager.compute.models.DataAccessAuthMode)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
name: "withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
nameWithType: "DiskProperties.withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
summary: "Set the data<wbr>Access<wbr>Auth<wbr>Mode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
parameters:
- description: "the dataAccessAuthMode value to set."
name: "dataAccessAuthMode"
type: "<xref href=\"com.azure.resourcemanager.compute.models.DataAccessAuthMode?alt=com.azure.resourcemanager.compute.models.DataAccessAuthMode&text=DataAccessAuthMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode)"
desc: "Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskAccessId(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskAccessId(String diskAccessId)"
name: "withDiskAccessId(String diskAccessId)"
nameWithType: "DiskProperties.withDiskAccessId(String diskAccessId)"
summary: "Set the disk<wbr>Access<wbr>Id property: ARM id of the Disk<wbr>Access resource for using private endpoints on disks."
parameters:
- description: "the diskAccessId value to set."
name: "diskAccessId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DiskProperties withDiskAccessId(String diskAccessId)"
desc: "Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskIopsReadOnly(java.lang.Long)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskIopsReadOnly(Long diskIopsReadOnly)"
name: "withDiskIopsReadOnly(Long diskIopsReadOnly)"
nameWithType: "DiskProperties.withDiskIopsReadOnly(Long diskIopsReadOnly)"
summary: "Set the disk<wbr>Iops<wbr>Read<wbr>Only property: The total number of IOPS that will be allowed across all VMs mounting the shared disk as Read<wbr>Only."
parameters:
- description: "the diskIopsReadOnly value to set."
name: "diskIopsReadOnly"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public DiskProperties withDiskIopsReadOnly(Long diskIopsReadOnly)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskIopsReadWrite(java.lang.Long)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskIopsReadWrite(Long diskIopsReadWrite)"
name: "withDiskIopsReadWrite(Long diskIopsReadWrite)"
nameWithType: "DiskProperties.withDiskIopsReadWrite(Long diskIopsReadWrite)"
summary: "Set the disk<wbr>Iops<wbr>Read<wbr>Write property: The number of IOPS allowed for this disk; only settable for UltraSSD disks."
parameters:
- description: "the diskIopsReadWrite value to set."
name: "diskIopsReadWrite"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public DiskProperties withDiskIopsReadWrite(Long diskIopsReadWrite)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskMBpsReadOnly(java.lang.Long)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskMBpsReadOnly(Long diskMBpsReadOnly)"
name: "withDiskMBpsReadOnly(Long diskMBpsReadOnly)"
nameWithType: "DiskProperties.withDiskMBpsReadOnly(Long diskMBpsReadOnly)"
summary: "Set the disk<wbr>MBps<wbr>Read<wbr>Only property: The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as Read<wbr>Only."
parameters:
- description: "the diskMBpsReadOnly value to set."
name: "diskMBpsReadOnly"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public DiskProperties withDiskMBpsReadOnly(Long diskMBpsReadOnly)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskMBpsReadWrite(java.lang.Long)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskMBpsReadWrite(Long diskMBpsReadWrite)"
name: "withDiskMBpsReadWrite(Long diskMBpsReadWrite)"
nameWithType: "DiskProperties.withDiskMBpsReadWrite(Long diskMBpsReadWrite)"
summary: "Set the disk<wbr>MBps<wbr>Read<wbr>Write property: The bandwidth allowed for this disk; only settable for UltraSSD disks."
parameters:
- description: "the diskMBpsReadWrite value to set."
name: "diskMBpsReadWrite"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public DiskProperties withDiskMBpsReadWrite(Long diskMBpsReadWrite)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskSizeGB(java.lang.Integer)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withDiskSizeGB(Integer diskSizeGB)"
name: "withDiskSizeGB(Integer diskSizeGB)"
nameWithType: "DiskProperties.withDiskSizeGB(Integer diskSizeGB)"
summary: "Set the disk<wbr>SizeGB property: If creation<wbr>Data.<wbr>create<wbr>Option is Empty, this field is mandatory and it indicates the size of the disk to create."
parameters:
- description: "the diskSizeGB value to set."
name: "diskSizeGB"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public DiskProperties withDiskSizeGB(Integer diskSizeGB)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withEncryption(com.azure.resourcemanager.compute.models.Encryption)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withEncryption(Encryption encryption)"
name: "withEncryption(Encryption encryption)"
nameWithType: "DiskProperties.withEncryption(Encryption encryption)"
summary: "Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
parameters:
- description: "the encryption value to set."
name: "encryption"
type: "<xref href=\"com.azure.resourcemanager.compute.models.Encryption?alt=com.azure.resourcemanager.compute.models.Encryption&text=Encryption\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withEncryption(Encryption encryption)"
desc: "Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withEncryptionSettingsCollection(com.azure.resourcemanager.compute.models.EncryptionSettingsCollection)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
name: "withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
nameWithType: "DiskProperties.withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
summary: "Set the encryption<wbr>Settings<wbr>Collection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
parameters:
- description: "the encryptionSettingsCollection value to set."
name: "encryptionSettingsCollection"
type: "<xref href=\"com.azure.resourcemanager.compute.models.EncryptionSettingsCollection?alt=com.azure.resourcemanager.compute.models.EncryptionSettingsCollection&text=EncryptionSettingsCollection\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection)"
desc: "Set the encryptionSettingsCollection property: Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withHyperVGeneration(com.azure.resourcemanager.compute.models.HyperVGeneration)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withHyperVGeneration(HyperVGeneration hyperVGeneration)"
name: "withHyperVGeneration(HyperVGeneration hyperVGeneration)"
nameWithType: "DiskProperties.withHyperVGeneration(HyperVGeneration hyperVGeneration)"
summary: "Set the hyper<wbr>VGeneration property: The hypervisor generation of the Virtual Machine."
parameters:
- description: "the hyperVGeneration value to set."
name: "hyperVGeneration"
type: "<xref href=\"com.azure.resourcemanager.compute.models.HyperVGeneration?alt=com.azure.resourcemanager.compute.models.HyperVGeneration&text=HyperVGeneration\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withHyperVGeneration(HyperVGeneration hyperVGeneration)"
desc: "Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withMaxShares(java.lang.Integer)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withMaxShares(Integer maxShares)"
name: "withMaxShares(Integer maxShares)"
nameWithType: "DiskProperties.withMaxShares(Integer maxShares)"
summary: "Set the max<wbr>Shares property: The maximum number of VMs that can attach to the disk at the same time."
parameters:
- description: "the maxShares value to set."
name: "maxShares"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public DiskProperties withMaxShares(Integer maxShares)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withNetworkAccessPolicy(com.azure.resourcemanager.compute.models.NetworkAccessPolicy)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
name: "withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
nameWithType: "DiskProperties.withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
summary: "Set the network<wbr>Access<wbr>Policy property: Policy for accessing the disk via network."
parameters:
- description: "the networkAccessPolicy value to set."
name: "networkAccessPolicy"
type: "<xref href=\"com.azure.resourcemanager.compute.models.NetworkAccessPolicy?alt=com.azure.resourcemanager.compute.models.NetworkAccessPolicy&text=NetworkAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy)"
desc: "Set the networkAccessPolicy property: Policy for accessing the disk via network."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withOptimizedForFrequentAttach(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withOptimizedForFrequentAttach(Boolean optimizedForFrequentAttach)"
name: "withOptimizedForFrequentAttach(Boolean optimizedForFrequentAttach)"
nameWithType: "DiskProperties.withOptimizedForFrequentAttach(Boolean optimizedForFrequentAttach)"
summary: "Set the optimized<wbr>For<wbr>Frequent<wbr>Attach 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."
parameters:
- description: "the optimizedForFrequentAttach value to set."
name: "optimizedForFrequentAttach"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public DiskProperties withOptimizedForFrequentAttach(Boolean optimizedForFrequentAttach)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withOsType(com.azure.resourcemanager.compute.models.OperatingSystemTypes)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withOsType(OperatingSystemTypes osType)"
name: "withOsType(OperatingSystemTypes osType)"
nameWithType: "DiskProperties.withOsType(OperatingSystemTypes osType)"
summary: "Set the os<wbr>Type property: The Operating System type."
parameters:
- description: "the osType value to set."
name: "osType"
type: "<xref href=\"com.azure.resourcemanager.compute.models.OperatingSystemTypes?alt=com.azure.resourcemanager.compute.models.OperatingSystemTypes&text=OperatingSystemTypes\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withOsType(OperatingSystemTypes osType)"
desc: "Set the osType property: The Operating System type."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withPublicNetworkAccess(com.azure.resourcemanager.compute.models.PublicNetworkAccess)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
name: "withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
nameWithType: "DiskProperties.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
summary: "Set the public<wbr>Network<wbr>Access property: Policy for controlling export on the disk."
parameters:
- description: "the publicNetworkAccess value to set."
name: "publicNetworkAccess"
type: "<xref href=\"com.azure.resourcemanager.compute.models.PublicNetworkAccess?alt=com.azure.resourcemanager.compute.models.PublicNetworkAccess&text=PublicNetworkAccess\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)"
desc: "Set the publicNetworkAccess property: Policy for controlling export on the disk."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withPurchasePlan(com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
name: "withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
nameWithType: "DiskProperties.withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
summary: "Set the purchase<wbr>Plan property: Purchase plan information for the the image from which the OS disk was created."
parameters:
- description: "the purchasePlan value to set."
name: "purchasePlan"
type: "<xref href=\"com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated?alt=com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated&text=PurchasePlanAutoGenerated\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withPurchasePlan(PurchasePlanAutoGenerated purchasePlan)"
desc: "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\\}."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withSecurityProfile(com.azure.resourcemanager.compute.models.DiskSecurityProfile)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withSecurityProfile(DiskSecurityProfile securityProfile)"
name: "withSecurityProfile(DiskSecurityProfile securityProfile)"
nameWithType: "DiskProperties.withSecurityProfile(DiskSecurityProfile securityProfile)"
summary: "Set the security<wbr>Profile property: Contains the security related information for the resource."
parameters:
- description: "the securityProfile value to set."
name: "securityProfile"
type: "<xref href=\"com.azure.resourcemanager.compute.models.DiskSecurityProfile?alt=com.azure.resourcemanager.compute.models.DiskSecurityProfile&text=DiskSecurityProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withSecurityProfile(DiskSecurityProfile securityProfile)"
desc: "Set the securityProfile property: Contains the security related information for the resource."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withSupportedCapabilities(com.azure.resourcemanager.compute.models.SupportedCapabilities)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
name: "withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
nameWithType: "DiskProperties.withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
summary: "Set the supported<wbr>Capabilities property: List of supported capabilities for the image from which the OS disk was created."
parameters:
- description: "the supportedCapabilities value to set."
name: "supportedCapabilities"
type: "<xref href=\"com.azure.resourcemanager.compute.models.SupportedCapabilities?alt=com.azure.resourcemanager.compute.models.SupportedCapabilities&text=SupportedCapabilities\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DiskProperties withSupportedCapabilities(SupportedCapabilities supportedCapabilities)"
desc: "Set the supportedCapabilities property: List of supported capabilities for the image from which the OS disk was created."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withSupportsHibernation(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withSupportsHibernation(Boolean supportsHibernation)"
name: "withSupportsHibernation(Boolean supportsHibernation)"
nameWithType: "DiskProperties.withSupportsHibernation(Boolean supportsHibernation)"
summary: "Set the supports<wbr>Hibernation property: Indicates the OS on a disk supports hibernation."
parameters:
- description: "the supportsHibernation value to set."
name: "supportsHibernation"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public DiskProperties withSupportsHibernation(Boolean supportsHibernation)"
desc: "Set the supportsHibernation property: Indicates the OS on a disk supports hibernation."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withTier(java.lang.String)"
fullName: "com.azure.resourcemanager.compute.fluent.models.DiskProperties.withTier(String tier)"
name: "withTier(String tier)"
nameWithType: "DiskProperties.withTier(String tier)"
summary: "Set the tier property: Performance tier of the disk (e.<wbr>g, P4, S10) as described here: https://azure.<wbr>microsoft.<wbr>com/en-us/pricing/details/managed-disks/."
parameters:
- description: "the tier value to set."
name: "tier"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DiskProperties withTier(String tier)"
desc: "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."
returns:
description: "the DiskProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Disk resource properties."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.fluent.models.DiskProperties?alt=com.azure.resourcemanager.compute.fluent.models.DiskProperties&text=DiskProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.compute.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.42.0