Usar um cache externo compatível com Redis no Gerenciamento de API do Azure

APLICA-SE A: Todas as camadas de gerenciamento de API

Além de utilizar o cache interno, o Gerenciamento de API do Azure permite armazenar respostas em cache em um cache externo compatível com Redis, como o Cache do Azure para Redis.

O uso de um cache externo permite que você supere algumas limitações do cache interno:

  • Evite que seu cache seja limpo periodicamente durante as atualizações do Gerenciamento de API
  • Tenha mais controle sobre a configuração do cache
  • Armazene em cache mais dados do que a camada de Gerenciamento de API permite
  • Usar cache com a camada de consumo do Gerenciamento de API
  • Habilitar o cache no gateway auto-hospedado do Gerenciamento de API

Para obter informações mais detalhadas sobre a colocação em cache, veja Colocação em cache das políticas de Gestão de API e Colocação em cache personalizada na Gestão de API do Azure.

Nota

Atualmente, esse recurso não está disponível em espaços de trabalho.

Traga seu próprio cache para o APIM

O que irá aprender:

  • Adicionar um cache externo no Gerenciamento de API

Pré-requisitos

Para concluir este tutorial, precisa de:

Criar Cache do Azure para Redis

Esta seção explica como criar um Cache do Azure para Redis no Azure. Se você já tiver um Cache do Azure para Redis ou outro cache compatível com Redis dentro ou fora do Azure, poderá pular para a próxima seção.

  1. Para criar um cache, entre no portal do Azure. No menu do portal, selecione Criar um recurso.

    Sceenshot que mostra a opção Criar um recurso realçada no painel de navegação esquerdo no portal do Azure.

  2. No painel Introdução, insira Cache Redis do Azure na barra de pesquisa. Nos resultados da pesquisa, localize o Cache do Azure para Redis e selecione Criar.

    Captura de ecrã que mostra o Azure Marketplace com o Cache Redis do Azure na caixa de pesquisa e o botão Criar está realçado.

  3. No painel Novo Cache Redis, na guia Noções básicas, defina as seguintes configurações para o cache:

    Definição Ação Descrição
    Subscrição Selecione a subscrição do Azure. A assinatura a ser usada para criar a nova instância do Cache do Azure para Redis.
    Grupo de recursos Selecione um grupo de recursos ou selecione Criar novo e insira um novo nome de grupo de recursos. Um nome para o grupo de recursos no qual criar seu cache e outros recursos. Ao colocar todos os recursos do seu aplicativo em um grupo de recursos, você pode facilmente gerenciá-los ou excluí-los juntos.
    Nome DNS Introduza um nome exclusivo. O nome do cache deve ser uma cadeia de caracteres de 1 a 63 caracteres que contenha apenas números, letras e hífenes. O nome deve começar e terminar com um número ou letra, e não pode conter hífenes consecutivas. O nome de host da instância de cache é \<DNS name>.redis.cache.windows.net.
    Location Selecione uma localização. Uma região do Azure que está perto de outros serviços que usam seu cache.
    Cache SKU Selecione uma SKU. A SKU determina o tamanho, o desempenho e os parâmetros de recurso disponíveis para o cache. Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.
    Tamanho do cache Selecione um tamanho de cache. Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.
  4. Selecione a guia Rede ou selecione Avançar: Rede.

  5. Na guia Rede, selecione um método de conectividade a ser usado para o cache.

  6. Selecione a guia Avançado ou selecione Avançar: Avançado.

  7. No painel Avançado, verifique ou selecione um método de autenticação com base nas seguintes informações:

    Captura de ecrã a mostrar o painel Avançado e as opções disponíveis para selecionar.

    • Por padrão, para um novo cache Básico, Standard ou Premium, a Autenticação do Microsoft Entra está habilitada e a Autenticação de Chaves de Acesso está desabilitada.
    • Para caches Basic ou Standard, você pode escolher a seleção para uma porta não-TLS.
    • Para caches Standard e Premium, você pode optar por habilitar zonas de disponibilidade. Não é possível desativar as zonas de disponibilidade após a criação do cache.
    • Para um cache Premium, defina as configurações para porta não-TLS, clustering, identidade gerenciada e persistência de dados.

    Importante

    Para uma segurança ideal, recomendamos que você use o Microsoft Entra ID com identidades gerenciadas para autorizar solicitações em seu cache, se possível. A autorização usando o ID do Microsoft Entra e identidades gerenciadas oferece segurança superior e facilidade de uso em relação à autorização de chave de acesso compartilhado. Para obter mais informações sobre como usar identidades gerenciadas com seu cache, consulte Usar a ID do Microsoft Entra para autenticação de cache.

  8. (Opcional) Selecione a guia Tags ou selecione Next: Tags.

  9. (Opcional) Na guia Marcas , insira um nome e um valor de tag se quiser categorizar seu recurso de cache.

  10. Selecione o botão Rever + criar.

    Na guia Revisão + criação, o Azure valida automaticamente sua configuração.

  11. Depois que a mensagem verde Validação passada for exibida, selecione Criar.

Uma nova implantação de cache ocorre ao longo de vários minutos. Você pode monitorar o progresso da implantação no painel Visão Geral do Cache do Azure para Redis. Quando Status exibe Em execução, o cache está pronto para uso.

Implantar cache Redis no Kubernetes

Para um gateway auto-hospedado, o cache requer um cache externo. Para que o cache seja eficaz, um gateway auto-hospedado e o cache no qual ele depende devem estar localizados próximos um do outro para minimizar as latências de pesquisa e armazenamento. Implantar um cache Redis no mesmo cluster do Kubernetes ou em um cluster separado nas proximidades são as melhores opções. Saiba como implantar o cache Redis em um cluster Kubernetes.

Adicionar um cache externo

Siga as etapas abaixo para adicionar um cache externo compatível com Redis no Gerenciamento de API do Azure. Você pode limitar o cache a um gateway específico em sua instância de Gerenciamento de API.

Captura de tela que mostra como adicionar um Cache Redis do Azure externo no Gerenciamento de API do Azure.

Utilizar a partir da definição

A configuração Usar de na configuração especifica o local da instância de Gerenciamento de API que usará o cache. Seleccione uma das seguintes opções:

  • A região do Azure onde a instância de Gerenciamento de API está hospedada (ou um dos locais configurados, se você tiver uma implantação de várias regiões )

  • Um local de gateway auto-hospedado

  • Padrão, para configurar o cache como padrão para todos os locais de gateway na instância de Gerenciamento de API

    Um cache usado para Padrão será substituído por um cache usado para uma região ou local correspondente específico.

    Por exemplo, considere uma instância de Gerenciamento de API hospedada nas regiões Leste dos EUA, Sudeste Asiático e Europa Ocidental. Há dois caches configurados, um para Padrão e outro para o Sudeste Asiático. Neste exemplo, o Gerenciamento de API no Sudeste Asiático usará seu próprio cache, enquanto as outras duas regiões usarão a entrada de cache Padrão .

Nota

Você pode configurar o mesmo cache externo para mais de uma instância de Gerenciamento de API. As instâncias de Gerenciamento de API podem estar na mesma região ou em regiões diferentes. Ao compartilhar o cache para mais de uma instância, você deve selecionar Padrão na configuração Usar de .

Adicionar um Cache Redis do Azure a partir da mesma subscrição

  1. Navegue até sua instância de Gerenciamento de API no portal do Azure.
  2. Selecione a guia Cache externo no menu à esquerda.
  3. Selecione o botão + Adicionar .
  4. Selecione seu cache no campo suspenso Instância de cache.
  5. Selecione Padrão ou especifique a região desejada no campo suspenso Usar de.
  6. Selecione Guardar.

Adicionar um cache compatível com Redis hospedado fora da assinatura atual do Azure ou do Azure em geral

  1. Navegue até sua instância de Gerenciamento de API no portal do Azure.
  2. Selecione a guia Cache externo no menu à esquerda.
  3. Selecione o botão + Adicionar .
  4. Selecione Personalizar no campo suspenso Instância de cache.
  5. Selecione Padrão ou especifique a região desejada no campo suspenso Usar de.
  6. Forneça sua cadeia de conexão do Cache do Azure para Redis (ou cache compatível com Redis) no campo Cadeia de conexão .
  7. Selecione Guardar.

Adicionar um cache Redis a um gateway auto-hospedado

  1. Navegue até sua instância de Gerenciamento de API no portal do Azure.
  2. Selecione a guia Cache externo no menu à esquerda.
  3. Selecione o botão + Adicionar .
  4. Selecione Personalizar no campo suspenso Instância de cache.
  5. Especifique o local desejado do gateway auto-hospedado ou Padrão no campo suspenso Usar de .
  6. Forneça sua cadeia de conexão de cache Redis no campo Cadeia de conexão .
  7. Selecione Guardar.

Usar o cache externo

Depois de adicionar um cache compatível com Redis, configure as políticas de cache para habilitar o cache de resposta ou o cache de valores por chave no cache externo.

Para obter um exemplo detalhado, consulte Adicionar cache para melhorar o desempenho no Gerenciamento de API do Azure.

Passos seguintes