StorageTargets Interface

public interface StorageTargets

Resource collection API of StorageTargets.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new StorageTarget resource.

abstract void delete(String resourceGroupName, String cacheName, String storageTargetName)

Removes a Storage Target from a cache.

abstract void delete(String resourceGroupName, String cacheName, String storageTargetName, String force, Context context)

Removes a Storage Target from a cache.

abstract void deleteById(String id)

Removes a Storage Target from a cache.

abstract void deleteByIdWithResponse(String id, String force, Context context)

Removes a Storage Target from a cache.

abstract void dnsRefresh(String resourceGroupName, String cacheName, String storageTargetName)

Tells a storage target to refresh its DNS information.

abstract void dnsRefresh(String resourceGroupName, String cacheName, String storageTargetName, Context context)

Tells a storage target to refresh its DNS information.

abstract StorageTarget get(String resourceGroupName, String cacheName, String storageTargetName)

Returns a Storage Target from a cache.

abstract StorageTarget getById(String id)

Returns a Storage Target from a cache.

abstract Response<StorageTarget> getByIdWithResponse(String id, Context context)

Returns a Storage Target from a cache.

abstract Response<StorageTarget> getWithResponse(String resourceGroupName, String cacheName, String storageTargetName, Context context)

Returns a Storage Target from a cache.

abstract PagedIterable<StorageTarget> listByCache(String resourceGroupName, String cacheName)

Returns a list of Storage Targets for the specified cache.

abstract PagedIterable<StorageTarget> listByCache(String resourceGroupName, String cacheName, Context context)

Returns a list of Storage Targets for the specified cache.

abstract void restoreDefaults(String resourceGroupName, String cacheName, String storageTargetName)

Tells a storage target to restore its settings to their default values.

abstract void restoreDefaults(String resourceGroupName, String cacheName, String storageTargetName, Context context)

Tells a storage target to restore its settings to their default values.

Method Details

define

public abstract 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.

delete

public abstract 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 - The name of the resource group. The name is case insensitive.
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.

delete

public abstract void delete(String resourceGroupName, String cacheName, String storageTargetName, String force, 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 - The name of the resource group. The name is case insensitive.
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.

deleteById

public abstract 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.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, String force, 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.

dnsRefresh

public abstract void dnsRefresh(String resourceGroupName, String cacheName, String storageTargetName)

Tells a storage target to refresh its DNS information.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

dnsRefresh

public abstract void dnsRefresh(String resourceGroupName, String cacheName, String storageTargetName, Context context)

Tells a storage target to refresh its DNS information.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

get

public abstract StorageTarget get(String resourceGroupName, String cacheName, String storageTargetName)

Returns a Storage Target from a cache.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

getById

public abstract 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<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, 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<T>.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String cacheName, String storageTargetName, Context context)

Returns a Storage Target from a cache.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

listByCache

public abstract PagedIterable listByCache(String resourceGroupName, String cacheName)

Returns a list of Storage Targets for the specified cache.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

listByCache

public abstract PagedIterable listByCache(String resourceGroupName, String cacheName, Context context)

Returns a list of Storage Targets for the specified cache.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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<T>.

restoreDefaults

public abstract void restoreDefaults(String resourceGroupName, String cacheName, String storageTargetName)

Tells a storage target to restore its settings to their default values.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

restoreDefaults

public abstract void restoreDefaults(String resourceGroupName, String cacheName, String storageTargetName, Context context)

Tells a storage target to restore its settings to their default values.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
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.

Applies to

Azure SDK for Java

Preview