mgtm, compute, support disk IOPS and throughput (#45339)

Author: weidongxu-microsoft

sdk/resourcemanager/azure-resourcemanager-compute/CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Features Added
 
+- Supported setting disk IOPS and throughput for `Disk`.
+- Supported setting maximum shares for `Disk`.
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/resourcemanager/azure-resourcemanager-compute/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/resourcemanager/azure-resourcemanager-compute",
-  "Tag": "java/resourcemanager/azure-resourcemanager-compute_78176bbe81"
+  "Tag": "java/resourcemanager/azure-resourcemanager-compute_db05ab8f85"
 }

sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/implementation/DiskImpl.java

@@ -35,6 +35,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
 import reactor.core.publisher.Flux;
@@ -70,6 +71,17 @@ public String virtualMachineId() {
         return this.innerModel().managedBy();
     }
 
+    @Override
+    public List<String> virtualMachineIds() {
+        if (innerModel().managedByExtended() != null) {
+            return Collections.unmodifiableList(innerModel().managedByExtended());
+        } else if (this.virtualMachineId() != null) {
+            return Collections.singletonList(this.virtualMachineId());
+        } else {
+            return Collections.emptyList();
+        }
+    }
+
     @Override
     public int sizeInGB() {
         return ResourceManagerUtils.toPrimitiveInt(this.innerModel().diskSizeGB());
@@ -158,6 +170,31 @@ public PublicNetworkAccess publicNetworkAccess() {
         return this.innerModel().publicNetworkAccess();
     }
 
+    @Override
+    public Long diskIopsReadWrite() {
+        return innerModel().diskIopsReadWrite();
+    }
+
+    @Override
+    public Long diskMBpsReadWrite() {
+        return innerModel().diskMBpsReadWrite();
+    }
+
+    @Override
+    public Long diskIopsReadOnly() {
+        return innerModel().diskIopsReadOnly();
+    }
+
+    @Override
+    public Long diskMBpsReadOnly() {
+        return innerModel().diskMBpsReadOnly();
+    }
+
+    @Override
+    public int maximumShares() {
+        return innerModel().maxShares() == null ? 1 : innerModel().maxShares();
+    }
+
     @Override
     public DiskImpl withLinuxFromVhd(String vhdUrl) {
         this.innerModel()
@@ -464,4 +501,34 @@ public DiskImpl disablePublicNetworkAccess() {
         this.innerModel().withPublicNetworkAccess(PublicNetworkAccess.DISABLED);
         return this;
     }
+
+    @Override
+    public DiskImpl withIopsReadWrite(long diskIopsReadWrite) {
+        this.innerModel().withDiskIopsReadWrite(diskIopsReadWrite);
+        return this;
+    }
+
+    @Override
+    public DiskImpl withMBpsReadWrite(long diskMBpsReadWrite) {
+        this.innerModel().withDiskMBpsReadWrite(diskMBpsReadWrite);
+        return this;
+    }
+
+    @Override
+    public DiskImpl withIopsReadOnly(long diskIopsReadOnly) {
+        this.innerModel().withDiskIopsReadOnly(diskIopsReadOnly);
+        return this;
+    }
+
+    @Override
+    public DiskImpl withMBpsReadOnly(long diskMBpsReadOnly) {
+        this.innerModel().withDiskMBpsReadOnly(diskMBpsReadOnly);
+        return this;
+    }
+
+    @Override
+    public DiskImpl withMaximumShares(int maximumShares) {
+        this.innerModel().withMaxShares(maximumShares);
+        return this;
+    }
 }

sdk/resourcemanager/azure-resourcemanager-compute/src/main/java/com/azure/resourcemanager/compute/models/Disk.java

@@ -15,6 +15,8 @@
 import com.azure.resourcemanager.resources.fluentcore.model.Refreshable;
 import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
 import com.azure.resourcemanager.storage.models.StorageAccount;
+
+import java.util.List;
 import java.util.Set;
 import reactor.core.publisher.Mono;
 
@@ -44,12 +46,23 @@ public interface Disk extends GroupableResource<ComputeManager, DiskInner>, Refr
 
     /**
      * Gets the resource ID of the virtual machine this disk is attached to.
+     * <p>
+     * If the disk can be shared, use {@link #virtualMachineIds()} to get the list of all virtual machines.
      *
      * @return the resource ID of the virtual machine this disk is attached to, or null if the disk is in a detached
      *     state
      */
     String virtualMachineId();
 
+    /**
+     * Gets the list of the virtual machines that this disk is attached to.
+     * <p>
+     * A disk could be attached to multiple virtual machines.
+     *
+     * @return the resource ID of the virtual machines this disk is attached to
+     */
+    List<String> virtualMachineIds();
+
     /**
      * Gets disk size in GB.
      *
@@ -153,6 +166,41 @@ public interface Disk extends GroupableResource<ComputeManager, DiskInner>, Refr
      */
     PublicNetworkAccess publicNetworkAccess();
 
+    /**
+     * Gets the number of IOPS allowed for this disk.
+     *
+     * @return the number of IOPS allowed for this disk.
+     */
+    Long diskIopsReadWrite();
+
+    /**
+     * Gets the throughput (MBps) allowed for this disk.
+     *
+     * @return the throughput (MBps) allowed for this disk.
+     */
+    Long diskMBpsReadWrite();
+
+    /**
+     * Gets the total number of IOPS allowed across all VMs mounting this shared disk as read-only.
+     *
+     * @return the total number of IOPS allowed for this shared read-only disk.
+     */
+    Long diskIopsReadOnly();
+
+    /**
+     * Gets the total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.
+     *
+     * @return the total throughput (MBps) allowed for this shared read-only disk.
+     */
+    Long diskMBpsReadOnly();
+
+    /**
+     * Gets the maximum number of VMs that can attach to the disk at the same time.
+     *
+     * @return the maximum number of VMs that can attach to the disk at the same time.
+     */
+    int maximumShares();
+
     /** The entirety of the managed disk definition. */
     interface Definition extends DefinitionStages.Blank, DefinitionStages.WithGroup, DefinitionStages.WithDiskSource,
         DefinitionStages.WithWindowsDiskSource, DefinitionStages.WithLinuxDiskSource, DefinitionStages.WithData,
@@ -521,13 +569,63 @@ interface WithPublicNetworkAccess {
             WithCreate disablePublicNetworkAccess();
         }
 
+        /** The stage of disk definition allowing to configure IOPS and throughput settings. */
+        interface WithIopsThroughput {
+            /**
+             * Sets the number of IOPS allowed for this disk.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskIopsReadWrite The number of IOPS allowed for this disk. One operation can transfer between 4k and 256k bytes.
+             * @return the next stage of the definition
+             */
+            WithCreate withIopsReadWrite(long diskIopsReadWrite);
+
+            /**
+             * Sets the throughput (MBps) allowed for this disk.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskMBpsReadWrite The bandwidth allowed for this disk.
+             * @return the next stage of the definition
+             */
+            WithCreate withMBpsReadWrite(long diskMBpsReadWrite);
+
+            /**
+             * Sets the total number of IOPS allowed across all VMs mounting this shared disk as read-only.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskIopsReadOnly The total number of IOPS allowed across all VMs mounting this shared disk as read-only. One operation can transfer between 4k and 256k bytes.
+             * @return the next stage of the definition
+             */
+            WithCreate withIopsReadOnly(long diskIopsReadOnly);
+
+            /**
+             * Sets the total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskMBpsReadOnly The total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.
+             * @return the next stage of the definition
+             */
+            WithCreate withMBpsReadOnly(long diskMBpsReadOnly);
+        }
+
+        /** The stage of disk definition allowing to configure managed disk sharing settings. */
+        interface WithDiskSharing {
+            /**
+             * Sets the maximum number of VMs that can attach to the disk at the same time.
+             *
+             * @param maximumShares the maximum number of VMs that can attach to the disk at the same time
+             * @return the next stage of the definition
+             */
+            WithCreate withMaximumShares(int maximumShares);
+        }
+
         /**
          * The stage of the definition which contains all the minimum required inputs for the resource to be created,
          * but also allows for any other optional settings to be specified.
          */
         interface WithCreate extends Creatable<Disk>, Resource.DefinitionWithTags<Disk.DefinitionStages.WithCreate>,
             WithSku, WithAvailabilityZone, WithDiskEncryption, WithHibernationSupport, WithLogicalSectorSize,
-            WithHyperVGeneration, WithPublicNetworkAccess {
+            WithHyperVGeneration, WithPublicNetworkAccess, WithIopsThroughput, WithDiskSharing {
 
             /**
              * Begins creating the disk resource.
@@ -628,11 +726,62 @@ interface WithPublicNetworkAccess {
              */
             Update disablePublicNetworkAccess();
         }
+
+        /** The stage of disk update allowing to configure IOPS and throughput settings. */
+        interface WithIopsThroughput {
+            /**
+             * Sets the number of IOPS allowed for this disk.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskIopsReadWrite The number of IOPS allowed for this disk. One operation can transfer between 4k and 256k bytes.
+             * @return the next stage of the definition
+             */
+            Update withIopsReadWrite(long diskIopsReadWrite);
+
+            /**
+             * Sets the throughput (MBps) allowed for this disk.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskMBpsReadWrite The bandwidth allowed for this disk.
+             * @return the next stage of the definition
+             */
+            Update withMBpsReadWrite(long diskMBpsReadWrite);
+
+            /**
+             * Sets the total number of IOPS allowed across all VMs mounting this shared disk as read-only.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskIopsReadOnly The total number of IOPS allowed across all VMs mounting this shared disk as read-only. One operation can transfer between 4k and 256k bytes.
+             * @return the next stage of the definition
+             */
+            Update withIopsReadOnly(long diskIopsReadOnly);
+
+            /**
+             * Sets the total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.
+             * It is only settable for UltraSSD disks or Premium SSD v2 disks.
+             *
+             * @param diskMBpsReadOnly The total throughput (MBps) allowed across all VMs mounting this shared disk as read-only.
+             * @return the next stage of the definition
+             */
+            Update withMBpsReadOnly(long diskMBpsReadOnly);
+        }
+
+        /** The stage of disk update allowing to configure managed disk sharing settings. */
+        interface WithDiskSharing {
+            /**
+             * Sets the maximum number of VMs that can attach to the disk at the same time.
+             *
+             * @param maximumShares the maximum number of VMs that can attach to the disk at the same time
+             * @return the next stage of the update
+             */
+            Update withMaximumShares(int maximumShares);
+        }
     }
 
     /** The template for an update operation, containing all the settings that can be modified. */
     interface Update extends Appliable<Disk>, Resource.UpdateWithTags<Disk.Update>, UpdateStages.WithSku,
         UpdateStages.WithSize, UpdateStages.WithOSSettings, UpdateStages.WithDiskEncryption,
-        UpdateStages.WithHibernationSupport, UpdateStages.WithHyperVGeneration, UpdateStages.WithPublicNetworkAccess {
+        UpdateStages.WithHibernationSupport, UpdateStages.WithHyperVGeneration, UpdateStages.WithPublicNetworkAccess,
+        UpdateStages.WithIopsThroughput, UpdateStages.WithDiskSharing {
     }
 }