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

  • Artigo

APLICA-SE A: todas as camadas do Gerenciamento de API

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

Usar um cache externo permite a você superar algumas limitações do cache interno:

  • Evitar que o cache fique periodicamente desmarcado durante as atualizações de Gerenciamento de API
  • Ter mais controle sobre sua configuração de cache
  • Armazenar mais dados do que sua camada de Gerenciamento de API permite
  • Usar o armazenamento em cache com a camada Consumo do Gerenciamento de API
  • Habilitar o cache nos gateways de Gerenciamento de API auto-hospedados

Para saber mais sobre o cache, veja Políticas de armazenamento em cache do Gerenciamento de API e Armazenamento em cache personalizado no Gerenciamento de API do Azure.

Traga seu próprio cache para o APIM

O que você aprenderá:

  • Adicionar um cache externo no Gerenciamento de API

Pré-requisitos

Para concluir este tutorial, você precisará:

Criar um 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, ignore esta seção e siga para a próxima.

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

    Criar um recurso está realçado no painel de navegação esquerdo.

  2. Na página Novo, selecione Bancos de dados e, em seguida, Cache do Azure para Redis.

    Em Novo, os Bancos de Dados e o Cache do Azure para Redis estão realçados.

  3. Na página Novo Cache Redis, defina as configurações para o novo cache.

    Configuração Escolher um valor Descrição
    Assinatura Clique na lista suspensa e selecione sua assinatura. A assinatura na qual essa nova instância do Cache do Azure para Redis será criada.
    Grupo de recursos Clique na lista suspensa e selecione um grupo de recursos ou selecione Criar e insira um novo nome de grupo de recursos. Nome do grupo de recursos no qual o cache e outros recursos serão criados. Ao colocar todos os seus recursos de aplicativos em um só grupo de recursos, você pode gerenciá-los ou excluí-los juntos com facilidade.
    Nome DNS Insira um nome exclusivo. O nome do cache deve conter de 1 a 63 caracteres e incluir somente números, letras ou hifens. O nome precisa começar e terminar com um número ou uma letra e não pode conter hifens consecutivos. O nome do host da instância de cache será <nome DNS>.redis.cache.windows.net.
    Localidade Clique na lista suspensa e selecione uma localização. Selecione uma região perto de outros serviços que usam o seu cache.
    Tipo de cache Clique na lista suspensa e selecione uma camada. A camada determina o tamanho, o desempenho e os recursos disponíveis para o cache. Para obter mais informações, confira Visão geral do Cache do Azure para Redis.

  4. Selecione a guia Rede ou o botão Rede na parte inferior da página.

  5. Na guia Rede, escolha o método de conectividade.

  6. Selecione a guia Próximo: Avançado ou o botão Próximo: Avançado na parte inferior da página para ver a guia Avançado.

    Captura de tela mostrando a guia Avançado no painel de trabalho e a opção disponível para seleção.

    • Para caches Básico ou Standard, alterne a seleção para uma porta não TLS. Você também pode selecionar se deseja habilitar a Autenticação do Microsoft Entra.
    • Para um cache Premium, defina as configurações para porta não TLS, clustering, identidade gerenciada e persistência de dados. Você também pode selecionar se deseja habilitar a Autenticação do Microsoft Entra.

  7. Selecione a guia Próximo: Marcas ou o botão Próximo: Marcas na parte inferior da página.

  8. Opcionalmente, na guia Marcas, insira o nome e o valor caso deseje categorizar o recurso.

  9. Selecione Examinar + criar. Você será levado para a guia Examinar + criar, na qual o Azure valida sua configuração.

  10. Depois que a mensagem em verde Validação aprovada for exibida, selecione Criar.

A criação do cache demora um pouco. Monitore o progresso na página Visão Geral do Cache do Azure para Redis. Quando o Status for mostrado como Em execução, o cache estará pronto para uso.

Implantar o 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 do qual eles dependem devem estar localizados próximos um do outro para minimizar as latências de pesquisa e armazenamento. As melhores opções são implantar um cache Redis no mesmo cluster de Kubernetes ou em um cluster separado próximo. Saiba mais como implantar o cache Redis em um cluster de 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 do Azure para Redis externo no Gerenciamento de API do Azure.

Configuração "Usar de"

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

  • A região do Azure em que 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 do gateway auto-hospedado

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

    Um cache usado como Padrão será substituído por um cache usado para uma região ou local de correspondência específica.

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

Observação

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 em regiões iguais ou diferentes. Ao compartilhar o cache para mais de uma instância, você deve selecionar Padrão na configuração Usar de.

Adicionar um Cache do Azure para Redis da mesma assinatura

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

Adicione 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. Escolha a guia Cache externo no menu à esquerda.
  3. Selecione o botão +Adicionar.
  4. Escolha Personalizar no campo suspenso Instância de cache.
  5. Escolha Padrão ou especifique a região desejada no campo suspenso Usar de.
  6. Forneça a cadeia de conexão do Cache do Azure para Redis no campo Cadeia de conexão.
  7. Selecione Save.

Adicionar um cache Redis a um gateway auto-hospedado

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

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 um exemplo detalhado, confira Adicionar cache para melhorar o desempenho no Gerenciamento de API do Azure.

Próximas etapas