CachesOperations interface

Package:

@azure/arm-storagecache

Interface representing a Caches operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDebugInfo
beginDebugInfoAndWait
beginDelete
beginDeleteAndWait
beginFlush
beginFlushAndWait
beginPausePrimingJob
beginPausePrimingJobAndWait
beginResumePrimingJob
beginResumePrimingJobAndWait
beginSpaceAllocation
beginSpaceAllocationAndWait
beginStart
beginStartAndWait
beginStartPrimingJob
beginStartPrimingJobAndWait
beginStop
beginStopAndWait
beginStopPrimingJob
beginStopPrimingJobAndWait
beginUpdate
beginUpdateAndWait
beginUpgradeFirmware
beginUpgradeFirmwareAndWait
createOrUpdate	Create or update a cache.
debugInfo	Tells a cache to write generate debug info for support to process.
delete	Schedules a cache for deletion.
flush	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.
get	Returns a cache.
list	Returns all caches the user has access to under a subscription.
listByResourceGroup	Returns all caches the user has access to under a resource group.
pausePrimingJob	Schedule a priming job to be paused.
resumePrimingJob	Resumes a paused priming job.
spaceAllocation	Update cache space allocation.
start	Tells a Stopped state cache to transition to Active state.
startPrimingJob	Create a priming job. This operation is only allowed when the cache is healthy.
stop	Tells an Active cache to transition to Stopped state.
stopPrimingJob	Schedule a priming job for deletion.
update	Update a cache instance.
upgradeFirmware	Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, cacheName: string, cache: Cache, options?: CachesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cache>, Cache>>

Property Value

(resourceGroupName: string, cacheName: string, cache: Cache, options?: CachesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cache>, Cache>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, cacheName: string, cache: Cache, options?: CachesCreateOrUpdateOptionalParams) => Promise<Cache>

Property Value

(resourceGroupName: string, cacheName: string, cache: Cache, options?: CachesCreateOrUpdateOptionalParams) => Promise<Cache>

beginDebugInfo

Warning

This API is now deprecated.

use debugInfo instead

beginDebugInfo: (resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDebugInfoAndWait

Warning

This API is now deprecated.

use debugInfo instead

beginDebugInfoAndWait: (resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams) => Promise<void>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams) => Promise<void>

beginFlush

Warning

This API is now deprecated.

use flush instead

beginFlush: (resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFlushAndWait

Warning

This API is now deprecated.

use flush instead

beginFlushAndWait: (resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams) => Promise<void>

beginPausePrimingJob

Warning

This API is now deprecated.

use pausePrimingJob instead

beginPausePrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPausePrimingJobAndWait

Warning

This API is now deprecated.

use pausePrimingJob instead

beginPausePrimingJobAndWait: (resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams) => Promise<void>

beginResumePrimingJob

Warning

This API is now deprecated.

use resumePrimingJob instead

beginResumePrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginResumePrimingJobAndWait

Warning

This API is now deprecated.

use resumePrimingJob instead

beginResumePrimingJobAndWait: (resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams) => Promise<void>

beginSpaceAllocation

Warning

This API is now deprecated.

use spaceAllocation instead

beginSpaceAllocation: (resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginSpaceAllocationAndWait

Warning

This API is now deprecated.

use spaceAllocation instead

beginSpaceAllocationAndWait: (resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams) => Promise<void>

beginStartPrimingJob

Warning

This API is now deprecated.

use startPrimingJob instead

beginStartPrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartPrimingJobAndWait

Warning

This API is now deprecated.

use startPrimingJob instead

beginStartPrimingJobAndWait: (resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams) => Promise<void>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams) => Promise<void>

beginStopPrimingJob

Warning

This API is now deprecated.

use stopPrimingJob instead

beginStopPrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopPrimingJobAndWait

Warning

This API is now deprecated.

use stopPrimingJob instead

beginStopPrimingJobAndWait: (resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cache>, Cache>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cache>, Cache>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams) => Promise<Cache>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams) => Promise<Cache>

beginUpgradeFirmware

Warning

This API is now deprecated.

use upgradeFirmware instead

beginUpgradeFirmware: (resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginUpgradeFirmwareAndWait

Warning

This API is now deprecated.

use upgradeFirmware instead

beginUpgradeFirmwareAndWait: (resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams) => Promise<void>

createOrUpdate

Create or update a cache.

createOrUpdate: (resourceGroupName: string, cacheName: string, cache: Cache, options?: CachesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cache>, Cache>

Property Value

(resourceGroupName: string, cacheName: string, cache: Cache, options?: CachesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Cache>, Cache>

debugInfo

Tells a cache to write generate debug info for support to process.

debugInfo: (resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesDebugInfoOptionalParams) => PollerLike<OperationState<void>, void>

delete

Schedules a cache for deletion.

delete: (resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

flush

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.

flush: (resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesFlushOptionalParams) => PollerLike<OperationState<void>, void>

get

Returns a cache.

get: (resourceGroupName: string, cacheName: string, options?: CachesGetOptionalParams) => Promise<Cache>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesGetOptionalParams) => Promise<Cache>

list

Returns all caches the user has access to under a subscription.

list: (options?: CachesListOptionalParams) => PagedAsyncIterableIterator<Cache, Cache[], PageSettings>

Property Value

(options?: CachesListOptionalParams) => PagedAsyncIterableIterator<Cache, Cache[], PageSettings>

listByResourceGroup

Returns all caches the user has access to under a resource group.

listByResourceGroup: (resourceGroupName: string, options?: CachesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cache, Cache[], PageSettings>

Property Value

(resourceGroupName: string, options?: CachesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cache, Cache[], PageSettings>

pausePrimingJob

Schedule a priming job to be paused.

pausePrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesPausePrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

resumePrimingJob

Resumes a paused priming job.

resumePrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesResumePrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

spaceAllocation

Update cache space allocation.

spaceAllocation: (resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesSpaceAllocationOptionalParams) => PollerLike<OperationState<void>, void>

start

Tells a Stopped state cache to transition to Active state.

start: (resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStartOptionalParams) => PollerLike<OperationState<void>, void>

startPrimingJob

Create a priming job. This operation is only allowed when the cache is healthy.

startPrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStartPrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

stop

Tells an Active cache to transition to Stopped state.

stop: (resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStopOptionalParams) => PollerLike<OperationState<void>, void>

stopPrimingJob

Schedule a priming job for deletion.

stopPrimingJob: (resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesStopPrimingJobOptionalParams) => PollerLike<OperationState<void>, void>

update

Update a cache instance.

update: (resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams) => PollerLike<OperationState<Cache>, Cache>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesUpdateOptionalParams) => PollerLike<OperationState<Cache>, Cache>

upgradeFirmware

Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.

upgradeFirmware: (resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, cacheName: string, options?: CachesUpgradeFirmwareOptionalParams) => PollerLike<OperationState<void>, void>