Caches class
Class representing a Caches.
Constructors
| Caches(Storage |
Create a Caches. |
Methods
Constructor Details
Caches(StorageCacheManagementClientContext)
Create a Caches.
new Caches(client: StorageCacheManagementClientContext)Parameters
Reference to the service client.
Method Details
beginCreateOrUpdate(string, string, Models.CachesBeginCreateOrUpdateOptionalParams)
Create or update a Cache.
function beginCreateOrUpdate(resourceGroupName: string, cacheName: string, options?: Models.CachesBeginCreateOrUpdateOptionalParams)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- Models.CachesBeginCreateOrUpdateOptionalParams
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
beginDebugInfo(string, string, msRest.RequestOptionsBase)
Tells a Cache to write generate debug info for support to process.
function beginDebugInfo(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
beginDeleteMethod(string, string, msRest.RequestOptionsBase)
Schedules a Cache for deletion.
function beginDeleteMethod(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
beginFlush(string, string, msRest.RequestOptionsBase)
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?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
beginStart(string, string, msRest.RequestOptionsBase)
Tells a Stopped state Cache to transition to Active state.
function beginStart(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
beginStop(string, string, msRest.RequestOptionsBase)
Tells an Active Cache to transition to Stopped state.
function beginStop(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
beginUpgradeFirmware(string, string, msRest.RequestOptionsBase)
Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.
function beginUpgradeFirmware(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<LROPoller>
Promise<msRestAzure.LROPoller>
createOrUpdate(string, string, Models.CachesCreateOrUpdateOptionalParams)
Create or update a Cache.
function createOrUpdate(resourceGroupName: string, cacheName: string, options?: Models.CachesCreateOrUpdateOptionalParams)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- Models.CachesCreateOrUpdateOptionalParams
Returns
Promise<Models.CachesCreateOrUpdateResponse>
Promise<Models.CachesCreateOrUpdateResponse>
debugInfo(string, string, msRest.RequestOptionsBase)
Tells a Cache to write generate debug info for support to process.
function debugInfo(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, msRest.RequestOptionsBase)
Schedules a Cache for deletion.
function deleteMethod(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
flush(string, string, msRest.RequestOptionsBase)
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 flush(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
get(string, string, msRest.RequestOptionsBase)
Returns a Cache.
function get(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<Models.CachesGetResponse>
Promise<Models.CachesGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<Cache>)
function get(resourceGroupName: string, cacheName: string, options: RequestOptionsBase, callback: ServiceCallback<Cache>)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<Cache>
The callback
get(string, string, ServiceCallback<Cache>)
function get(resourceGroupName: string, cacheName: string, callback: ServiceCallback<Cache>)Parameters
- resourceGroupName
-
string
Target resource group.
- 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.
- callback
-
ServiceCallback<Cache>
The callback
list(msRest.RequestOptionsBase)
Returns all Caches the user has access to under a subscription.
function list(options?: msRest.RequestOptionsBase)Parameters
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.CachesListResponse>
Promise<Models.CachesListResponse>
list(RequestOptionsBase, ServiceCallback<CachesListResult>)
function list(options: RequestOptionsBase, callback: ServiceCallback<CachesListResult>)Parameters
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<CachesListResult>
The callback
list(ServiceCallback<CachesListResult>)
function list(callback: ServiceCallback<CachesListResult>)Parameters
- callback
-
ServiceCallback<CachesListResult>
The callback
listByResourceGroup(string, msRest.RequestOptionsBase)
Returns all Caches the user has access to under a resource group.
function listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.CachesListByResourceGroupResponse>
Promise<Models.CachesListByResourceGroupResponse>
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<CachesListResult>)
function listByResourceGroup(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<CachesListResult>)Parameters
- resourceGroupName
-
string
Target resource group.
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<CachesListResult>
The callback
listByResourceGroup(string, ServiceCallback<CachesListResult>)
function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<CachesListResult>)Parameters
- resourceGroupName
-
string
Target resource group.
- callback
-
ServiceCallback<CachesListResult>
The callback
listByResourceGroupNext(string, msRest.RequestOptionsBase)
Returns all Caches the user has access to under a resource group.
function listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.CachesListByResourceGroupNextResponse>
Promise<Models.CachesListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<CachesListResult>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<CachesListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<CachesListResult>
The callback
listByResourceGroupNext(string, ServiceCallback<CachesListResult>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<CachesListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
-
ServiceCallback<CachesListResult>
The callback
listNext(string, msRest.RequestOptionsBase)
Returns all Caches the user has access to under a subscription.
function listNext(nextPageLink: string, options?: msRest.RequestOptionsBase)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.CachesListNextResponse>
Promise<Models.CachesListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<CachesListResult>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<CachesListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<CachesListResult>
The callback
listNext(string, ServiceCallback<CachesListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CachesListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
-
ServiceCallback<CachesListResult>
The callback
start(string, string, msRest.RequestOptionsBase)
Tells a Stopped state Cache to transition to Active state.
function start(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
stop(string, string, msRest.RequestOptionsBase)
Tells an Active Cache to transition to Stopped state.
function stop(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
update(string, string, CachesUpdateOptionalParams, ServiceCallback<Cache>)
function update(resourceGroupName: string, cacheName: string, options: CachesUpdateOptionalParams, callback: ServiceCallback<Cache>)Parameters
- resourceGroupName
-
string
Target resource group.
- 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 optional parameters
- callback
-
ServiceCallback<Cache>
The callback
update(string, string, Models.CachesUpdateOptionalParams)
Update a Cache instance.
function update(resourceGroupName: string, cacheName: string, options?: Models.CachesUpdateOptionalParams)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- Models.CachesUpdateOptionalParams
Returns
Promise<Models.CachesUpdateResponse>
Promise<Models.CachesUpdateResponse>
update(string, string, ServiceCallback<Cache>)
function update(resourceGroupName: string, cacheName: string, callback: ServiceCallback<Cache>)Parameters
- resourceGroupName
-
string
Target resource group.
- 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.
- callback
-
ServiceCallback<Cache>
The callback
upgradeFirmware(string, string, msRest.RequestOptionsBase)
Upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect.
function upgradeFirmware(resourceGroupName: string, cacheName: string, options?: msRest.RequestOptionsBase)Parameters
- resourceGroupName
-
string
Target resource group.
- 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
- msRest.RequestOptionsBase
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
