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

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.

Observação

Atualmente, esse recurso não está disponível em workspaces.

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. No menu do portal, selecione Criar um recurso.

    Captura de tela mostrando a opção Criar um recurso realçada no painel de navegação à esquerda no portal do Azure.

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

    Captura de tela mostrando o Azure Marketplace com o Cache do Azure para Redis na caixa de pesquisa, e o botão Criar realçado.

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

    Configuração Ação Descrição
    Assinatura Selecione sua assinatura do Azure. A assinatura a ser usada para criar a 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 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 ser uma cadeia de caracteres de 1 a 63 caracteres que contenha apenas números, letras e hifens. O nome deve 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 é \<DNS name>.redis.cache.windows.net.
    Localidade Selecione uma localização. Uma região do Azure próxima de outros serviços que utilizem o seu cache.
    Cache SKU Selecione um SKU. O SKU determina o tamanho, desempenho e parâmetros de recursos disponíveis para o cache. Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.
    Tamanho do cache Selecione o tamanho do 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 informações a seguir:

    Captura de tela mostrando o painel

    • 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 Básico ou Standard, é possível escolher a seleção de uma porta não TLS.
    • Para caches Standard e Premium, é possível optar por habilitar zonas de disponibilidade. Não é possível desabilitar 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 obter a segurança ideal, recomendamos que você use o Microsoft Entra ID com identidades gerenciadas para autorizar solicitações no seu cache, se possível. A autorização usando o Microsoft Entra ID e identidades gerenciadas oferece maior segurança e facilidade de uso em comparação com a autorização por chave de acesso compartilhada. Para mais informações sobre como usar identidades gerenciadas com seu cache, consulte Usar o Microsoft Entra ID para autenticação de cache.

  8. (Opcional) Selecione a guia Marcas ou selecione Avançar: Marcas.

  9. (Opcional) Na guia Marcas, insira um nome e valor da marca caso deseje categorizar seu recurso de cache.

  10. Selecione o botão Revisar + criar.

    Na guia Revisar + criar, o Azure valida automaticamente sua configuração.

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

Uma nova implantação de cache é realizada em vários minutos. Você pode monitorar o progresso da implantação no painel "Visão geral" do Cache do Azure para Redis. Quando o Status exibir 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