Share via

Cache interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Cache.

Methods

createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)

Creates or updates an External Cache to be used in Api Management instance.
delete(string, string, string, string, CacheDeleteOptionalParams)

Deletes specific Cache.
get(string, string, string, CacheGetOptionalParams)

Gets the details of the Cache specified by its identifier.
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Cache specified by its identifier.
listByService(string, string, CacheListByServiceOptionalParams)

Lists a collection of all external Caches in the specified service instance.
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)

Updates the details of the cache specified by its identifier.

Method Details

createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)

Creates or updates an External Cache to be used in Api Management instance.

function createOrUpdate(resourceGroupName: string, serviceName: string, cacheId: string, parameters: CacheContract, options?: CacheCreateOrUpdateOptionalParams): Promise<CacheCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

cacheId

string

Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

parameters
CacheContract

Create or Update parameters.

options
CacheCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CacheCreateOrUpdateResponse>

delete(string, string, string, string, CacheDeleteOptionalParams)

Deletes specific Cache.

function delete(resourceGroupName: string, serviceName: string, cacheId: string, ifMatch: string, options?: CacheDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

cacheId

string

Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
CacheDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, CacheGetOptionalParams)

Gets the details of the Cache specified by its identifier.

function get(resourceGroupName: string, serviceName: string, cacheId: string, options?: CacheGetOptionalParams): Promise<CacheGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

cacheId

string

Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

options
CacheGetOptionalParams

The options parameters.

Returns

Promise<CacheGetResponse>

getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the Cache specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, cacheId: string, options?: CacheGetEntityTagOptionalParams): Promise<CacheGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

cacheId

string

Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

options
CacheGetEntityTagOptionalParams

The options parameters.

Returns

Promise<CacheGetEntityTagHeaders>

listByService(string, string, CacheListByServiceOptionalParams)

Lists a collection of all external Caches in the specified service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: CacheListByServiceOptionalParams): PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options
CacheListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)

Updates the details of the cache specified by its identifier.

function update(resourceGroupName: string, serviceName: string, cacheId: string, ifMatch: string, parameters: CacheUpdateParameters, options?: CacheUpdateOptionalParams): Promise<CacheUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

cacheId

string

Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters
CacheUpdateParameters

Update parameters.

options
CacheUpdateOptionalParams

The options parameters.

Returns

Promise<CacheUpdateResponse>