StorageTargets interface

Interface representing a StorageTargets.

Methods

beginCreateOrUpdate(string, string, string, StorageTarget, StorageTargetsCreateOrUpdateOptionalParams)

Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.

beginCreateOrUpdateAndWait(string, string, string, StorageTarget, StorageTargetsCreateOrUpdateOptionalParams)

Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.

beginDelete(string, string, string, StorageTargetsDeleteOptionalParams)

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.

beginDeleteAndWait(string, string, string, StorageTargetsDeleteOptionalParams)

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.

beginDnsRefresh(string, string, string, StorageTargetsDnsRefreshOptionalParams)

Tells a storage target to refresh its DNS information.

beginDnsRefreshAndWait(string, string, string, StorageTargetsDnsRefreshOptionalParams)

Tells a storage target to refresh its DNS information.

beginRestoreDefaults(string, string, string, StorageTargetsRestoreDefaultsOptionalParams)

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

beginRestoreDefaultsAndWait(string, string, string, StorageTargetsRestoreDefaultsOptionalParams)

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

get(string, string, string, StorageTargetsGetOptionalParams)

Returns a Storage Target from a cache.

listByCache(string, string, StorageTargetsListByCacheOptionalParams)

Returns a list of Storage Targets for the specified cache.

Method Details

beginCreateOrUpdate(string, string, string, StorageTarget, StorageTargetsCreateOrUpdateOptionalParams)

Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.

function beginCreateOrUpdate(resourceGroupName: string, cacheName: string, storageTargetName: string, storagetarget: StorageTarget, options?: StorageTargetsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StorageTarget>, StorageTarget>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

storagetarget
StorageTarget

Object containing the definition of a Storage Target.

options
StorageTargetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageTarget>, StorageTarget>>

beginCreateOrUpdateAndWait(string, string, string, StorageTarget, StorageTargetsCreateOrUpdateOptionalParams)

Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.

function beginCreateOrUpdateAndWait(resourceGroupName: string, cacheName: string, storageTargetName: string, storagetarget: StorageTarget, options?: StorageTargetsCreateOrUpdateOptionalParams): Promise<StorageTarget>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

storagetarget
StorageTarget

Object containing the definition of a Storage Target.

options
StorageTargetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<StorageTarget>

beginDelete(string, string, string, StorageTargetsDeleteOptionalParams)

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.

function beginDelete(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, StorageTargetsDeleteOptionalParams)

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.

function beginDeleteAndWait(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDnsRefresh(string, string, string, StorageTargetsDnsRefreshOptionalParams)

Tells a storage target to refresh its DNS information.

function beginDnsRefresh(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsDnsRefreshOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsDnsRefreshOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDnsRefreshAndWait(string, string, string, StorageTargetsDnsRefreshOptionalParams)

Tells a storage target to refresh its DNS information.

function beginDnsRefreshAndWait(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsDnsRefreshOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsDnsRefreshOptionalParams

The options parameters.

Returns

Promise<void>

beginRestoreDefaults(string, string, string, StorageTargetsRestoreDefaultsOptionalParams)

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

function beginRestoreDefaults(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsRestoreDefaultsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsRestoreDefaultsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestoreDefaultsAndWait(string, string, string, StorageTargetsRestoreDefaultsOptionalParams)

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

function beginRestoreDefaultsAndWait(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsRestoreDefaultsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsRestoreDefaultsOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, StorageTargetsGetOptionalParams)

Returns a Storage Target from a cache.

function get(resourceGroupName: string, cacheName: string, storageTargetName: string, options?: StorageTargetsGetOptionalParams): Promise<StorageTarget>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

storageTargetName

string

Name of Storage Target.

options
StorageTargetsGetOptionalParams

The options parameters.

Returns

Promise<StorageTarget>

listByCache(string, string, StorageTargetsListByCacheOptionalParams)

Returns a list of Storage Targets for the specified cache.

function listByCache(resourceGroupName: string, cacheName: string, options?: StorageTargetsListByCacheOptionalParams): PagedAsyncIterableIterator<StorageTarget, StorageTarget[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

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.

options
StorageTargetsListByCacheOptionalParams

The options parameters.

Returns