storage_target

Creates, updates, deletes, gets or lists a storage_target resource.

Overview

Name	storage_target
Type	Resource
Id	azure.storage_cache.storage_target

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
flush	exec	resource_group_name, cache_name, storage_target_name, subscription_id		Tells the cache to write all dirty data to the Storage Target's backend storage. Client requests to this storage target's namespace will return errors until the flush operation completes.
suspend	exec	resource_group_name, cache_name, storage_target_name, subscription_id		Suspends client access to a storage target.
resume	exec	resource_group_name, cache_name, storage_target_name, subscription_id		Resumes client access to a previously suspended storage target.
invalidate	exec	resource_group_name, cache_name, storage_target_name, subscription_id		Invalidate all cached data for a storage target. Cached files are discarded and fetched from the back end on the next request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cache_name	string	Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_target_name	string	Name of Storage Target. Required.
subscription_id	string

Lifecycle Methods

flush

Tells the cache to write all dirty data to the Storage Target's backend storage. Client requests to this storage target's namespace will return errors until the flush operation completes.

EXEC azure.storage_cache.storage_target.flush 
@resource_group_name='{{ resource_group_name }}' --required, 
@cache_name='{{ cache_name }}' --required, 
@storage_target_name='{{ storage_target_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

suspend

Suspends client access to a storage target.

EXEC azure.storage_cache.storage_target.suspend 
@resource_group_name='{{ resource_group_name }}' --required, 
@cache_name='{{ cache_name }}' --required, 
@storage_target_name='{{ storage_target_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resume

Resumes client access to a previously suspended storage target.

EXEC azure.storage_cache.storage_target.resume 
@resource_group_name='{{ resource_group_name }}' --required, 
@cache_name='{{ cache_name }}' --required, 
@storage_target_name='{{ storage_target_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

invalidate

Invalidate all cached data for a storage target. Cached files are discarded and fetched from the back end on the next request.

EXEC azure.storage_cache.storage_target.invalidate 
@resource_group_name='{{ resource_group_name }}' --required, 
@cache_name='{{ cache_name }}' --required, 
@storage_target_name='{{ storage_target_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;