Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Cache

Package version

Interface representing a Cache.

Hierarchy

  • Cache

Implemented by

Index

Methods

Methods

createOrUpdate

  • 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>

  • 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

  • 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

  • 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

update

  • 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>

Generated using TypeDoc