CacheImpl | @azure/arm-apimanagement

Class containing Cache operations.

Hierarchy

CacheImpl

Implements

Cache

Index

Constructors

constructor

Methods

Constructors

constructor

new CacheImpl(client: ApiManagementClientContext): CacheImpl

- Defined in operations/cache.ts:36
Initialize a new instance of the class Cache class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns CacheImpl

Methods

createOrUpdate

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

Implementation of Cache.createOrUpdate
- Defined in operations/cache.ts:183
Creates or updates an External Cache to be used in Api Management instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CacheCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CacheCreateOrUpdateResponse>

delete

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

Implementation of Cache.delete
- Defined in operations/cache.ts:231
Deletes specific Cache.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CacheDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of Cache.get
- Defined in operations/cache.ts:162
Gets the details of the Cache specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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).
- Optional options: CacheGetOptionalParams
  
  The options parameters.
Returns Promise<CacheGetResponse>

getEntityTag

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

Implementation of Cache.getEntityTag
- Defined in operations/cache.ts:142
Gets the entity state (Etag) version of the Cache specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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).
- Optional options: CacheGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<CacheGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: CacheListByServiceOptionalParams): PagedAsyncIterableIterator<CacheContract>

Implementation of Cache.listByService
- Defined in operations/cache.ts:52
Lists a collection of all external Caches in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: CacheListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CacheContract>

update

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

Implementation of Cache.update
- Defined in operations/cache.ts:207
Updates the details of the cache specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: CacheUpdateOptionalParams
  
  The options parameters.
Returns Promise<CacheUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns CacheImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

cacheId: string

parameters: CacheContract

Optional options: CacheCreateOrUpdateOptionalParams

Returns Promise<CacheCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

cacheId: string

ifMatch: string

Optional options: CacheDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

cacheId: string

Optional options: CacheGetOptionalParams

Returns Promise<CacheGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

cacheId: string

Optional options: CacheGetEntityTagOptionalParams

Returns Promise<CacheGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: CacheListByServiceOptionalParams

Returns PagedAsyncIterableIterator<CacheContract>

update

Parameters

resourceGroupName: string

serviceName: string

cacheId: string

ifMatch: string

parameters: CacheUpdateParameters

Optional options: CacheUpdateOptionalParams

Returns Promise<CacheUpdateResponse>