Cache interface

Pacote:

@azure/arm-apimanagement

Interface que representa um Cache.

Métodos

createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)	Cria ou atualiza um cache externo a ser usado na instância do Gerenciamento de API.
delete(string, string, string, string, CacheDeleteOptionalParams)	Exclui o cache específico.
get(string, string, string, CacheGetOptionalParams)	Obtém os detalhes do Cache especificado por seu identificador.
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)	Obtém a versão de estado da entidade (Etag) do Cache especificado por seu identificador.
listByService(string, string, CacheListByServiceOptionalParams)	Lista uma coleção de todos os caches externos na instância de serviço especificada.
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)	Atualizações os detalhes do cache especificado por seu identificador.

Detalhes do método

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

Cria ou atualiza um cache externo a ser usado na instância do Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

cacheId

string

Identificador da entidade Cache. Identificador de cache (deve ser 'padrão' ou identificador de região do Azure válido).

parameters

CacheContract

Criar ou atualizar parâmetros.

options

CacheCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<CacheCreateOrUpdateResponse>

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

Exclui o cache específico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

cacheId

string

Identificador da entidade Cache. Identificador de cache (deve ser 'padrão' ou identificador de região do Azure válido).

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options

CacheDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, CacheGetOptionalParams)

Obtém os detalhes do Cache especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

cacheId

string

Identificador da entidade Cache. Identificador de cache (deve ser 'padrão' ou identificador de região do Azure válido).

options

CacheGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<CacheGetResponse>

getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) do Cache especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

cacheId

string

Identificador da entidade Cache. Identificador de cache (deve ser 'padrão' ou identificador de região do Azure válido).

options

CacheGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<CacheGetEntityTagHeaders>

listByService(string, string, CacheListByServiceOptionalParams)

Lista uma coleção de todos os caches externos na instância de serviço especificada.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

CacheListByServiceOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<CacheContract, CacheContract[], PageSettings>

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

Atualizações os detalhes do cache especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

cacheId

string

Identificador da entidade Cache. Identificador de cache (deve ser 'padrão' ou identificador de região do Azure válido).

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters

CacheUpdateParameters

Atualizar parâmetros.

options

CacheUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<CacheUpdateResponse>