Freigeben über

Cache interface

  • Referenz
Paket:
@azure/arm-apimanagement

Schnittstelle, die einen Cache darstellt.

Methoden

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

Erstellt oder aktualisiert einen externen Cache, der in der API Management-Instanz verwendet werden soll
delete(string, string, string, string, CacheDeleteOptionalParams)

Löscht den angegebenen Cache
get(string, string, string, CacheGetOptionalParams)

Ruft die Details des Caches ab, der durch seinen Bezeichner angegeben wird.
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) des Caches ab, die durch den Bezeichner angegeben wird.
listByService(string, string, CacheListByServiceOptionalParams)

Listet eine Auflistung aller externen Caches in der angegebenen Dienstinstanz auf
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)

Updates die Details des Caches, der durch den Bezeichner angegeben wird.

Details zur Methode

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

Erstellt oder aktualisiert einen externen Cache, der in der API Management-Instanz verwendet werden soll

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

cacheId

string

Bezeichner der Cacheentität. Cachebezeichner (sollte entweder "Standard" oder gültiger Azure-Regionsbezeichner sein).

parameters
CacheContract

Erstellen oder Aktualisieren von Parametern.

options
CacheCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CacheCreateOrUpdateResponse>

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

Löscht den angegebenen Cache

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

cacheId

string

Bezeichner der Cacheentität. Cachebezeichner (sollte entweder "Standard" oder gültiger Azure-Regionsbezeichner sein).

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

options
CacheDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, CacheGetOptionalParams)

Ruft die Details des Caches ab, der durch seinen Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

cacheId

string

Bezeichner der Cacheentität. Cachebezeichner (sollte entweder "Standard" oder gültiger Azure-Regionsbezeichner sein).

options
CacheGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CacheGetResponse>

getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) des Caches ab, die durch den Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

cacheId

string

Bezeichner der Cacheentität. Cachebezeichner (sollte entweder "Standard" oder gültiger Azure-Regionsbezeichner sein).

options
CacheGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CacheGetEntityTagHeaders>

listByService(string, string, CacheListByServiceOptionalParams)

Listet eine Auflistung aller externen Caches in der angegebenen Dienstinstanz auf

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

options
CacheListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

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

Updates die Details des Caches, der durch den Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

cacheId

string

Bezeichner der Cacheentität. Cachebezeichner (sollte entweder "Standard" oder gültiger Azure-Regionsbezeichner sein).

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

parameters
CacheUpdateParameters

Aktualisieren von Parametern.

options
CacheUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CacheUpdateResponse>