Partager via

Cache interface

  • Référence
Paquet:
@azure/arm-apimanagement

Interface représentant un cache.

Méthodes

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

Crée ou met à jour un cache externe à utiliser dans une instance de gestion des API.
delete(string, string, string, string, CacheDeleteOptionalParams)

Supprime un cache spécifique.
get(string, string, string, CacheGetOptionalParams)

Obtient les détails du cache spécifié par son identificateur.
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) du cache spécifié par son identificateur.
listByService(string, string, CacheListByServiceOptionalParams)

Répertorie une collection de tous les caches externes de l’instance de service spécifiée.
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)

Mises à jour les détails du cache spécifiés par son identificateur.

Détails de la méthode

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

Crée ou met à jour un cache externe à utiliser dans une instance de gestion des API.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

cacheId

string

Identificateur de l’entité Cache. Identificateur de cache (doit être « par défaut » ou identificateur de région Azure valide).

parameters
CacheContract

Créer ou mettre à jour des paramètres.

options
CacheCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<CacheCreateOrUpdateResponse>

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

Supprime un cache spécifique.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

cacheId

string

Identificateur de l’entité Cache. Identificateur de cache (doit être « par défaut » ou identificateur de région Azure valide).

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options
CacheDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, CacheGetOptionalParams)

Obtient les détails du cache spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

cacheId

string

Identificateur de l’entité Cache. Identificateur de cache (doit être « par défaut » ou identificateur de région Azure valide).

options
CacheGetOptionalParams

Paramètres d’options.

Retours

Promise<CacheGetResponse>

getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) du cache spécifié par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

cacheId

string

Identificateur de l’entité Cache. Identificateur de cache (doit être « par défaut » ou identificateur de région Azure valide).

options
CacheGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<CacheGetEntityTagHeaders>

listByService(string, string, CacheListByServiceOptionalParams)

Répertorie une collection de tous les caches externes de l’instance de service spécifiée.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

options
CacheListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

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

Mises à jour les détails du cache spécifiés par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

cacheId

string

Identificateur de l’entité Cache. Identificateur de cache (doit être « par défaut » ou identificateur de région Azure valide).

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

parameters
CacheUpdateParameters

Mettre à jour les paramètres.

options
CacheUpdateOptionalParams

Paramètres d’options.

Retours

Promise<CacheUpdateResponse>