Package com.azure.resourcemanager.storagecache.models

Interface StorageTargets

public interface StorageTargets
Resource collection API of StorageTargets.

  • Method Details

    • dnsRefresh

      void dnsRefresh(String resourceGroupName, String cacheName, String storageTargetName)
      Tells a storage target to refresh its DNS information.
      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.
      storageTargetName - Name of Storage Target.
      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.

    • dnsRefresh

      void dnsRefresh(String resourceGroupName, String cacheName, String storageTargetName, com.azure.core.util.Context context)
      Tells a storage target to refresh its DNS information.
      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.
      storageTargetName - Name of Storage Target.
      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.

    • listByCache

      com.azure.core.http.rest.PagedIterable<StorageTarget> listByCache(String resourceGroupName, String cacheName)
      Returns a list of Storage Targets for the specified 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 list of Storage Targets 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.

    • listByCache

      com.azure.core.http.rest.PagedIterable<StorageTarget> listByCache(String resourceGroupName, String cacheName, com.azure.core.util.Context context)
      Returns a list of Storage Targets for the specified 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 list of Storage Targets 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.

    • delete

      void delete(String resourceGroupName, String cacheName, String storageTargetName, String force)
      Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
      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.
      storageTargetName - Name of Storage Target.
      force - Boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage.
      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, String storageTargetName)
      Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
      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.
      storageTargetName - Name of Storage Target.
      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, String storageTargetName, String force, com.azure.core.util.Context context)
      Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
      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.
      storageTargetName - Name of Storage Target.
      force - Boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage.
      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.

    • get

      StorageTarget get(String resourceGroupName, String cacheName, String storageTargetName)
      Returns a Storage Target from 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.
      storageTargetName - Name of Storage Target.
      Returns:
      type of the Storage Target.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<StorageTarget> getWithResponse(String resourceGroupName, String cacheName, String storageTargetName, com.azure.core.util.Context context)
      Returns a Storage Target from 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.
      storageTargetName - Name of Storage Target.
      context - The context to associate with this operation.
      Returns:
      type of the Storage Target 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.

    • getById

      StorageTarget getById(String id)
      Returns a Storage Target from a Cache.
      Parameters:
      id - the resource ID.
      Returns:
      type of the Storage Target 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<StorageTarget> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns a Storage Target from a Cache.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      type of the Storage Target 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)
      Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
      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, String force, com.azure.core.util.Context context)
      Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.
      Parameters:
      id - the resource ID.
      force - Boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage.
      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

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