Caches interface
Interface representing a Caches.
Methods
Method Details
beginCreateOrUpdate(string, string, Cache_2, CachesCreateOrUpdateOptionalParams)
Create or update a cache.
function beginCreateOrUpdate(resourceGroupName: string, cacheName: string, cache: Cache_2, options?: CachesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cache_2>, Cache_2>>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.
- cache
- Cache
Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cache>, Cache>>
beginCreateOrUpdateAndWait(string, string, Cache_2, CachesCreateOrUpdateOptionalParams)
Create or update a cache.
function beginCreateOrUpdateAndWait(resourceGroupName: string, cacheName: string, cache: Cache_2, options?: CachesCreateOrUpdateOptionalParams): Promise<Cache_2>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.
- cache
- Cache
Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.
The options parameters.
Returns
Promise<Cache>
beginDebugInfo(string, string, CachesDebugInfoOptionalParams)
Tells a cache to write generate debug info for support to process.
function beginDebugInfo(resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams): 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.
- options
- CachesDebugInfoOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDebugInfoAndWait(string, string, CachesDebugInfoOptionalParams)
Tells a cache to write generate debug info for support to process.
function beginDebugInfoAndWait(resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams): 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.
- options
- CachesDebugInfoOptionalParams
The options parameters.
Returns
Promise<void>
beginDelete(string, string, CachesDeleteOptionalParams)
Schedules a cache for deletion.
function beginDelete(resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams): 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.
- options
- CachesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, CachesDeleteOptionalParams)
Schedules a cache for deletion.
function beginDeleteAndWait(resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams): 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.
- options
- CachesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginFlush(string, string, CachesFlushOptionalParams)
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.
function beginFlush(resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams): 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.
- options
- CachesFlushOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFlushAndWait(string, string, CachesFlushOptionalParams)
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.
function beginFlushAndWait(resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams): 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.
- options
- CachesFlushOptionalParams
The options parameters.
Returns
Promise<void>
beginPausePrimingJob(string, string, CachesPausePrimingJobOptionalParams)
Schedule a priming job to be paused.
function beginPausePrimingJob(resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams): Promise<SimplePollerLike<OperationState<CachesPausePrimingJobHeaders>, CachesPausePrimingJobHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CachesPausePrimingJobHeaders>, CachesPausePrimingJobHeaders>>
beginPausePrimingJobAndWait(string, string, CachesPausePrimingJobOptionalParams)
Schedule a priming job to be paused.
function beginPausePrimingJobAndWait(resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams): Promise<CachesPausePrimingJobHeaders>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.
The options parameters.
Returns
Promise<CachesPausePrimingJobHeaders>
beginResumePrimingJob(string, string, CachesResumePrimingJobOptionalParams)
Resumes a paused priming job.
function beginResumePrimingJob(resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams): Promise<SimplePollerLike<OperationState<CachesResumePrimingJobHeaders>, CachesResumePrimingJobHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CachesResumePrimingJobHeaders>, CachesResumePrimingJobHeaders>>
beginResumePrimingJobAndWait(string, string, CachesResumePrimingJobOptionalParams)
Resumes a paused priming job.
function beginResumePrimingJobAndWait(resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams): Promise<CachesResumePrimingJobHeaders>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.
The options parameters.
Returns
Promise<CachesResumePrimingJobHeaders>
beginSpaceAllocation(string, string, CachesSpaceAllocationOptionalParams)
Update cache space allocation.
function beginSpaceAllocation(resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams): Promise<SimplePollerLike<OperationState<CachesSpaceAllocationHeaders>, CachesSpaceAllocationHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CachesSpaceAllocationHeaders>, CachesSpaceAllocationHeaders>>
beginSpaceAllocationAndWait(string, string, CachesSpaceAllocationOptionalParams)
Update cache space allocation.
function beginSpaceAllocationAndWait(resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams): Promise<CachesSpaceAllocationHeaders>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.
The options parameters.
Returns
Promise<CachesSpaceAllocationHeaders>
beginStart(string, string, CachesStartOptionalParams)
Tells a Stopped state cache to transition to Active state.
function beginStart(resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams): 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.
- options
- CachesStartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStartAndWait(string, string, CachesStartOptionalParams)
Tells a Stopped state cache to transition to Active state.
function beginStartAndWait(resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams): 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.
- options
- CachesStartOptionalParams
The options parameters.
Returns
Promise<void>
beginStartPrimingJob(string, string, CachesStartPrimingJobOptionalParams)
Create a priming job. This operation is only allowed when the cache is healthy.
function beginStartPrimingJob(resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams): Promise<SimplePollerLike<OperationState<CachesStartPrimingJobHeaders>, CachesStartPrimingJobHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CachesStartPrimingJobHeaders>, CachesStartPrimingJobHeaders>>
beginStartPrimingJobAndWait(string, string, CachesStartPrimingJobOptionalParams)
Create a priming job. This operation is only allowed when the cache is healthy.
function beginStartPrimingJobAndWait(resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams): Promise<CachesStartPrimingJobHeaders>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.
The options parameters.
Returns
Promise<CachesStartPrimingJobHeaders>
beginStop(string, string, CachesStopOptionalParams)
Tells an Active cache to transition to Stopped state.
function beginStop(resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams): 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.
- options
- CachesStopOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStopAndWait(string, string, CachesStopOptionalParams)
Tells an Active cache to transition to Stopped state.
function beginStopAndWait(resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams): 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.
- options
- CachesStopOptionalParams
The options parameters.
Returns
Promise<void>
beginStopPrimingJob(string, string, CachesStopPrimingJobOptionalParams)
Schedule a priming job for deletion.
function beginStopPrimingJob(resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams): Promise<SimplePollerLike<OperationState<CachesStopPrimingJobHeaders>, CachesStopPrimingJobHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CachesStopPrimingJobHeaders>, CachesStopPrimingJobHeaders>>
beginStopPrimingJobAndWait(string, string, CachesStopPrimingJobOptionalParams)
Schedule a priming job for deletion.
function beginStopPrimingJobAndWait(resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams): Promise<CachesStopPrimingJobHeaders>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.
The options parameters.
Returns
Promise<CachesStopPrimingJobHeaders>
beginUpdate(string, string, CachesUpdateOptionalParams)
Update a cache instance.
function beginUpdate(resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cache_2>, Cache_2>>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
- CachesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cache>, Cache>>
beginUpdateAndWait(string, string, CachesUpdateOptionalParams)
Update a cache instance.
function beginUpdateAndWait(resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams): Promise<Cache_2>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
- CachesUpdateOptionalParams
The options parameters.
Returns
Promise<Cache>
beginUpgradeFirmware(string, string, CachesUpgradeFirmwareOptionalParams)
Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
function beginUpgradeFirmware(resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams): 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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginUpgradeFirmwareAndWait(string, string, CachesUpgradeFirmwareOptionalParams)
Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
function beginUpgradeFirmwareAndWait(resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams): 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.
The options parameters.
Returns
Promise<void>
get(string, string, CachesGetOptionalParams)
Returns a cache.
function get(resourceGroupName: string, cacheName: string, options?: CachesGetOptionalParams): Promise<Cache_2>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
- CachesGetOptionalParams
The options parameters.
Returns
Promise<Cache>
list(CachesListOptionalParams)
Returns all caches the user has access to under a subscription.
function list(options?: CachesListOptionalParams): PagedAsyncIterableIterator<Cache_2, Cache_2[], PageSettings>Parameters
- options
- CachesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, CachesListByResourceGroupOptionalParams)
Returns all caches the user has access to under a resource group.
function listByResourceGroup(resourceGroupName: string, options?: CachesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cache_2, Cache_2[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.