Cache interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en cache.

Metoder

createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)	Skapar eller uppdaterar en extern cache som ska användas i Api Management-instansen.
delete(string, string, string, string, CacheDeleteOptionalParams)	Tar bort specifik cache.
get(string, string, string, CacheGetOptionalParams)	Hämtar information om cachen som anges av dess identifierare.
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) för cachen som anges av dess identifierare.
listByService(string, string, CacheListByServiceOptionalParams)	Visar en samling med alla externa cacheminnen i den angivna tjänstinstansen.
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)	Uppdateringar information om cachen som anges av dess identifierare.

Metodinformation

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

Skapar eller uppdaterar en extern cache som ska användas i Api Management-instansen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

cacheId

string

Identifierare för cacheentiteten. Cacheidentifierare (ska vara antingen "standard" eller giltig Identifierare för Azure-region).

parameters

CacheContract

Skapa eller uppdatera parametrar.

options

CacheCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<CacheCreateOrUpdateResponse>

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

Tar bort specifik cache.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

cacheId

string

Identifierare för cacheentiteten. Cacheidentifierare (ska vara antingen "standard" eller giltig Identifierare för Azure-region).

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

options

CacheDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, CacheGetOptionalParams)

Hämtar information om cachen som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

cacheId

string

Identifierare för cacheentiteten. Cacheidentifierare (ska vara antingen "standard" eller giltig Identifierare för Azure-region).

options

CacheGetOptionalParams

Alternativparametrarna.

Returer

Promise<CacheGetResponse>

getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) för cachen som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

cacheId

string

Identifierare för cacheentiteten. Cacheidentifierare (ska vara antingen "standard" eller giltig Identifierare för Azure-region).

options

CacheGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<CacheGetEntityTagHeaders>

listByService(string, string, CacheListByServiceOptionalParams)

Visar en samling med alla externa cacheminnen i den angivna tjänstinstansen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

CacheListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

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

Uppdateringar information om cachen som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

cacheId

string

Identifierare för cacheentiteten. Cacheidentifierare (ska vara antingen "standard" eller giltig Identifierare för Azure-region).

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

parameters

CacheUpdateParameters

Uppdatera parametrar.

options

CacheUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<CacheUpdateResponse>