Package com.azure.resourcemanager.storagecache.models

Interface Caches

public interface Caches
Resource collection API of Caches.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Cache> list()
      Returns all Caches the user has access to under a subscription.
      Returns:
      result of the request to list Caches as paginated response with PagedIterable.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<Cache> list(com.azure.core.util.Context context)
      Returns all Caches the user has access to under a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      result of the request to list Caches as paginated response with PagedIterable.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Cache> listByResourceGroup(String resourceGroupName)
      Returns all Caches the user has access to under a resource group.
      Parameters:
      resourceGroupName - Target resource group.
      Returns:
      result of the request to list Caches as paginated response with PagedIterable.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Cache> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Returns all Caches the user has access to under a resource group.
      Parameters:
      resourceGroupName - Target resource group.
      context - The context to associate with this operation.
      Returns:
      result of the request to list Caches as paginated response with PagedIterable.
      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.

    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String cacheName)
      Schedules a Cache for deletion.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • delete

      void delete(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Schedules a Cache for deletion.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • getByResourceGroup

      Cache getByResourceGroup(String resourceGroupName, String cacheName)
      Returns a Cache.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      Returns:
      a Cache instance.
      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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Cache> getByResourceGroupWithResponse(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Returns a Cache.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      context - The context to associate with this operation.
      Returns:
      a Cache instance along with Response.
      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.

    • debugInfo

      void debugInfo(String resourceGroupName, String cacheName)
      Tells a Cache to write generate debug info for support to process.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • debugInfo

      void debugInfo(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Tells a Cache to write generate debug info for support to process.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • flush

      void flush(String resourceGroupName, String cacheName)
      Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • flush

      void flush(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • start

      void start(String resourceGroupName, String cacheName)
      Tells a Stopped state Cache to transition to Active state.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • start

      void start(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Tells a Stopped state Cache to transition to Active state.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • stop

      void stop(String resourceGroupName, String cacheName)
      Tells an Active Cache to transition to Stopped state.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • stop

      void stop(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Tells an Active Cache to transition to Stopped state.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • startPrimingJob

      void startPrimingJob(String resourceGroupName, String cacheName, PrimingJob primingjob)
      Create a priming job. This operation is only allowed when the cache is healthy.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingjob - Object containing the definition of a priming job.
      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.

    • startPrimingJob

      void startPrimingJob(String resourceGroupName, String cacheName)
      Create a priming job. This operation is only allowed when the cache is healthy.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • startPrimingJob

      void startPrimingJob(String resourceGroupName, String cacheName, PrimingJob primingjob, com.azure.core.util.Context context)
      Create a priming job. This operation is only allowed when the cache is healthy.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingjob - Object containing the definition of a priming job.
      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.

    • stopPrimingJob

      void stopPrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId)
      Schedule a priming job for deletion.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingJobId - Object containing the priming job ID.
      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.

    • stopPrimingJob

      void stopPrimingJob(String resourceGroupName, String cacheName)
      Schedule a priming job for deletion.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • stopPrimingJob

      void stopPrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
      Schedule a priming job for deletion.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingJobId - Object containing the priming job ID.
      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.

    • pausePrimingJob

      void pausePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId)
      Schedule a priming job to be paused.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingJobId - Object containing the priming job ID.
      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.

    • pausePrimingJob

      void pausePrimingJob(String resourceGroupName, String cacheName)
      Schedule a priming job to be paused.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • pausePrimingJob

      void pausePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
      Schedule a priming job to be paused.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingJobId - Object containing the priming job ID.
      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.

    • resumePrimingJob

      void resumePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId)
      Resumes a paused priming job.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingJobId - Object containing the priming job ID.
      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.

    • resumePrimingJob

      void resumePrimingJob(String resourceGroupName, String cacheName)
      Resumes a paused priming job.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • resumePrimingJob

      void resumePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
      Resumes a paused priming job.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      primingJobId - Object containing the priming job ID.
      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.

    • upgradeFirmware

      void upgradeFirmware(String resourceGroupName, String cacheName)
      Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • upgradeFirmware

      void upgradeFirmware(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • spaceAllocation

      void spaceAllocation(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation)
      Update cache space allocation.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      spaceAllocation - List containing storage target cache space percentage allocations.
      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.

    • spaceAllocation

      void spaceAllocation(String resourceGroupName, String cacheName)
      Update cache space allocation.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      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.

    • spaceAllocation

      void spaceAllocation(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation, com.azure.core.util.Context context)
      Update cache space allocation.
      Parameters:
      resourceGroupName - Target resource group.
      cacheName - Name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.
      spaceAllocation - List containing storage target cache space percentage allocations.
      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.

    • getById

      Cache getById(String id)
      Returns a Cache.
      Parameters:
      id - the resource ID.
      Returns:
      a Cache instance along with Response.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Cache> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns a Cache.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a Cache instance along with Response.
      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.

    • deleteById

      void deleteById(String id)
      Schedules a Cache for deletion.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Schedules a Cache for deletion.
      Parameters:
      id - the resource ID.
      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.

    • define

      Cache.DefinitionStages.Blank define(String name)
      Begins definition for a new Cache resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Cache definition.