Cache interface
Interface que representa uma Cache.
Métodos
create |
Cria ou atualiza uma Cache Externa a ser utilizada na instância de Gestão de API. |
delete(string, string, string, string, Cache |
Elimina cache específica. |
get(string, string, string, Cache |
Obtém os detalhes da Cache especificados pelo identificador. |
get |
Obtém a versão de estado da entidade (Etag) da Cache especificada pelo identificador. |
list |
Lista uma coleção de todas as Caches externas na instância de serviço especificada. |
update(string, string, string, string, Cache |
Atualizações os detalhes da cache especificada pelo identificador. |
Detalhes de Método
createOrUpdate(string, string, string, CacheContract, CacheCreateOrUpdateOptionalParams)
Cria ou atualiza uma Cache Externa a ser utilizada na instância de Gestão 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- cacheId
-
string
Identificador da entidade Cache. Identificador de cache (deve ser "predefinido" ou identificador de região do Azure válido).
- parameters
- CacheContract
Criar ou Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<CacheCreateOrUpdateResponse>
delete(string, string, string, string, CacheDeleteOptionalParams)
Elimina cache específica.
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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- cacheId
-
string
Identificador da entidade Cache. Identificador de cache (deve ser "predefinido" ou identificador de região do Azure válido).
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- CacheDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, CacheGetOptionalParams)
Obtém os detalhes da Cache especificados pelo 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- cacheId
-
string
Identificador da entidade Cache. Identificador de cache (deve ser "predefinido" ou identificador de região do Azure válido).
- options
- CacheGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<CacheGetResponse>
getEntityTag(string, string, string, CacheGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) da Cache especificada pelo 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- cacheId
-
string
Identificador da entidade Cache. Identificador de cache (deve ser "predefinido" ou identificador de região do Azure válido).
- options
- CacheGetEntityTagOptionalParams
Os parâmetros de opções.
Devoluções
Promise<CacheGetEntityTagHeaders>
listByService(string, string, CacheListByServiceOptionalParams)
Lista uma coleção de todas as Caches externas 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- options
- CacheListByServiceOptionalParams
Os parâmetros de opções.
Devoluções
update(string, string, string, string, CacheUpdateParameters, CacheUpdateOptionalParams)
Atualizações os detalhes da cache especificada pelo 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- cacheId
-
string
Identificador da entidade Cache. Identificador de cache (deve ser "predefinido" ou identificador de região do Azure válido).
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- CacheUpdateParameters
Atualizar parâmetros.
- options
- CacheUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<CacheUpdateResponse>