Cache interface

Пакет:

@azure/arm-apimanagement

Интерфейс, представляющий кэш.

Методы

createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)	Создает или обновляет внешний кэш для использования в экземпляре управления API.
delete(string, string, string, string, CacheDeleteOptionalParams)	Удаляет конкретный кэш.
get(string, string, string, CacheGetOptionalParams)	Возвращает сведения о кэше, заданном его идентификатором.
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)	Возвращает версию состояния сущности (Etag) кэша, заданного его идентификатором.
listByService(string, string, CacheListByServiceOptionalParams)	Возвращает коллекцию всех внешних кэшей в указанном экземпляре службы.
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)	Обновления сведения о кэше, указанные его идентификатором.

Сведения о методе

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

Создает или обновляет внешний кэш для использования в экземпляре управления API.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

cacheId

string

Идентификатор сущности Cache. Идентификатор кэша (должен быть "по умолчанию" или допустимый идентификатор региона Azure).

parameters

CacheContract

Создание или обновление параметров.

options

CacheCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CacheCreateOrUpdateResponse>

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

Удаляет конкретный кэш.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

cacheId

string

Идентификатор сущности Cache. Идентификатор кэша (должен быть "по умолчанию" или допустимый идентификатор региона Azure).

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

options

CacheDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, string, string, CacheGetOptionalParams)

Возвращает сведения о кэше, заданном его идентификатором.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

cacheId

string

Идентификатор сущности Cache. Идентификатор кэша (должен быть "по умолчанию" или допустимый идентификатор региона Azure).

options

CacheGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CacheGetResponse>

getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Возвращает версию состояния сущности (Etag) кэша, заданного его идентификатором.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

cacheId

string

Идентификатор сущности Cache. Идентификатор кэша (должен быть "по умолчанию" или допустимый идентификатор региона Azure).

options

CacheGetEntityTagOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CacheGetEntityTagHeaders>

listByService(string, string, CacheListByServiceOptionalParams)

Возвращает коллекцию всех внешних кэшей в указанном экземпляре службы.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

options

CacheListByServiceOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

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

Обновления сведения о кэше, указанные его идентификатором.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

cacheId

string

Идентификатор сущности Cache. Идентификатор кэша (должен быть "по умолчанию" или допустимый идентификатор региона Azure).

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

parameters

CacheUpdateParameters

Обновление параметров.

options

CacheUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<CacheUpdateResponse>