Package com.azure.resourcemanager.storagepool.models

Interface DiskPool

public interface DiskPool
An immutable client-side representation of DiskPool.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    DiskPool.Definition
    The entirety of the DiskPool definition.
    static interface 
    DiskPool.DefinitionStages
    The DiskPool definition stages.
    static interface 
    DiskPool.Update
    The template for DiskPool update.
    static interface 
    DiskPool.UpdateStages
    The DiskPool update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    additionalCapabilities()
    Gets the additionalCapabilities property: List of additional capabilities for Disk Pool.
    List<String>
    availabilityZones()
    Gets the availabilityZones property: Logical zone for Disk Pool resource; example: ["1"].
    void
    deallocate()
    Shuts down the Disk Pool and releases the compute resources.
    void
    deallocate(com.azure.core.util.Context context)
    Shuts down the Disk Pool and releases the compute resources.
    List<Disk>
    disks()
    Gets the disks property: List of Azure Managed Disks to attach to a Disk Pool.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    DiskPoolInner
    innerModel()
    Gets the inner com.azure.resourcemanager.storagepool.fluent.models.DiskPoolInner object.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    String
    managedBy()
    Gets the managedBy property: Azure resource id.
    List<String>
    managedByExtended()
    Gets the managedByExtended property: List of Azure resource ids that manage this resource.
    String
    name()
    Gets the name property: The name of the resource.
    String
    nameSkuName()
    Gets the nameSkuName property: Sku name.
    ProvisioningStates
    provisioningState()
    Gets the provisioningState property: State of the operation on the resource.
    DiskPool
    refresh()
    Refreshes the resource to sync with Azure.
    DiskPool
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    void
    start()
    The operation to start a Disk Pool.
    void
    start(com.azure.core.util.Context context)
    The operation to start a Disk Pool.
    OperationalStatus
    status()
    Gets the status property: Operational status of the Disk Pool.
    String
    subnetId()
    Gets the subnetId property: Azure Resource ID of a Subnet for the Disk Pool.
    SystemMetadata
    systemData()
    Gets the systemData property: Resource metadata required by ARM RPC.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    tier()
    Gets the tier property: Sku tier.
    String
    type()
    Gets the type property: The type of the resource.
    DiskPool.Update
    update()
    Begins update for the DiskPool resource.
    void
    upgrade()
    Upgrade replaces the underlying virtual machine hosts one at a time.
    void
    upgrade(com.azure.core.util.Context context)
    Upgrade replaces the underlying virtual machine hosts one at a time.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • managedBy

      String managedBy()
      Gets the managedBy property: Azure resource id. Indicates if this resource is managed by another Azure resource.
      Returns:
      the managedBy value.

    • managedByExtended

      List<String> managedByExtended()
      Gets the managedByExtended property: List of Azure resource ids that manage this resource.
      Returns:
      the managedByExtended value.

    • systemData

      SystemMetadata systemData()
      Gets the systemData property: Resource metadata required by ARM RPC.
      Returns:
      the systemData value.

    • nameSkuName

      String nameSkuName()
      Gets the nameSkuName property: Sku name.
      Returns:
      the nameSkuName value.

    • tier

      String tier()
      Gets the tier property: Sku tier.
      Returns:
      the tier value.

    • provisioningState

      ProvisioningStates provisioningState()
      Gets the provisioningState property: State of the operation on the resource.
      Returns:
      the provisioningState value.

    • availabilityZones

      List<String> availabilityZones()
      Gets the availabilityZones property: Logical zone for Disk Pool resource; example: ["1"].
      Returns:
      the availabilityZones value.

    • status

      OperationalStatus status()
      Gets the status property: Operational status of the Disk Pool.
      Returns:
      the status value.

    • disks

      List<Disk> disks()
      Gets the disks property: List of Azure Managed Disks to attach to a Disk Pool.
      Returns:
      the disks value.

    • subnetId

      String subnetId()
      Gets the subnetId property: Azure Resource ID of a Subnet for the Disk Pool.
      Returns:
      the subnetId value.

    • additionalCapabilities

      List<String> additionalCapabilities()
      Gets the additionalCapabilities property: List of additional capabilities for Disk Pool.
      Returns:
      the additionalCapabilities value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      DiskPoolInner innerModel()
      Gets the inner com.azure.resourcemanager.storagepool.fluent.models.DiskPoolInner object.
      Returns:
      the inner object.

    • update

      DiskPool.Update update()
      Begins update for the DiskPool resource.
      Returns:
      the stage of resource update.

    • refresh

      DiskPool refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      DiskPool refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • start

      void start()
      The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start(com.azure.core.util.Context context)
      The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deallocate

      void deallocate()
      Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deallocate

      void deallocate(com.azure.core.util.Context context)
      Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgrade

      void upgrade()
      Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgrade

      void upgrade(com.azure.core.util.Context context)
      Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.