Compartilhar via

Desativações de versão da API (junho de 2024)

  • Artigo

APLICA-SE A: Consumo | Desenvolvedor | Básico | Standard | Premium

O Gerenciamento de API do Azure usa o ARM (Azure Resource Manager) para configurar as instâncias de Gerenciamento de API. A versão da API é inserida no uso de modelos que descrevem a infraestrutura, as ferramentas usadas para configurar o serviço e os programas que você grava para gerenciar os serviços de Gerenciamento de API do Azure.

A partir de 1º de junho de 2024, todas as versões de API para o serviço de Gerenciamento de API do Azure anteriores a 01/08/2021 serão desativadas (desabilitadas). A data de aposentadoria comunicada anteriormente era 30 de setembro de 2023. A qualquer momento após 1º de junho de 2024, as chamadas de API usando uma versão de API anterior a 01/08/2021 podem falhar sem aviso prévio. Você não poderá mais criar ou gerenciar seus serviços de Gerenciamento de API com modelos, ferramentas, scripts e programas existentes usando uma versão de API desativada até que eles tenham sido atualizados para usar a versão de API 2021-08-01 ou posterior. As operações do plano de dados (como mediar solicitações de API no gateway) não serão afetadas por esta atualização, inclusive após 1º de junho de 2024.

Meu serviço é afetado por essa alteração?

Embora seu serviço não seja afetado por essa alteração, qualquer ferramenta, script ou programa que use o Gerenciador de Recursos do Azure (como a CLI do Azure, o Azure PowerShell, o Azure API Management DevOps Resource Kit ou o Terraform) para interagir com o serviço de Gerenciamento de API e chamar uma versão da API de Gerenciamento de API anterior a 01/08/2021 é afetado por essa alteração. Depois que uma versão da API for desativada, você não poderá executar nenhuma ferramenta afetada com êxito, a menos que atualize as ferramentas.

Qual é o prezo para a mudança?

As versões de API afetadas serão desativadas gradualmente a partir de 1º de junho de 2024.

Depois que uma versão da API for desativada, se você preferir não atualizar suas ferramentas, scripts e programas afetados, seus serviços continuarão a ser executados. No entanto, você não poderá adicionar ou remover APIs, alterar a política de API ou configurar seu serviço de Gerenciamento de API com ferramentas afetadas.

Ação necessária

Atualize suas ferramentas, scripts e programas usando os detalhes da seção a seguir.

Também recomendamos definir a versão mínima da API em sua instância de Gerenciamento de API.

Atualize suas ferramentas, scripts e programas

  • Modelos do ARM, Bicep ou Terraform – Atualize o modelo para usar a API versão 2021-08-01 ou posterior.

  • CLI do Azure – Execute az version para verificar a versão. Se você estiver executando a versão 2.42.0 ou posterior, nenhuma ação será necessária. Use o comando az upgrade para atualizar a CLI do Azure, se necessário. Para obter mais informações, confira Como atualizar a CLI do Azure.

  • Azure PowerShell – Execute Get-Module -ListAvailable -Name Az para verificar a versão. Se você estiver executando a versão 8.1.0 ou posterior, nenhuma ação será necessária. Use Update-Module -Name Az -Repository PSGallery para atualizar o módulo, se necessário. Para saber mais, confira Instalar o módulo Az PowerShell do Azure.

  • Outras ferramentas – Use as seguintes versões (ou posteriores):

    • Kit de Recursos de DevOps do Gerenciamento de API: 1.0.0
    • Provedor terraform azurerm: 3.0.0

  • SDKs do Azure - Atualize os SDKs de Gerenciamento de API do Azure para as versões mais recentes ou, pelo menos, as seguintes versões:

    • .NET: v1.1.0
    • Go: 1.0.0
    • Python: 3.0.0
    • JavaScript: 8.0.1
    • Java: 1.0.0-beta3

Atualizar a configuração de versão mínima da API na instância de Gerenciamento de API

Recomendamos definir a versão mínima da API para sua instância de Gerenciamento de API usando o portal do Azure ou usando a API REST ou outras ferramentas. Essa configuração limita as chamadas de API do plano de controle para sua instância para uma versão de API igual ou mais recente que esse valor. Ao definir esse valor como 2021-08-01, você pode avaliar o impacto das desativações da versão da API em suas ferramentas.

Para definir a versão mínima da API no portal:

  1. No portal do Azure, navegue até a instância do Gerenciamento de API.
  2. No menu esquerdo, em Implantação + infraestrutura, selecione API de gerenciamento.
  3. Selecione a guia Configurações da API de gerenciamento.
  4. Em Impor versão mínima da API, selecione Sim. A versão mínima da API é exibida.
  5. Selecione Salvar.

Importante

Se a versão mínima da API no portal estiver esmaecida, você só poderá atualizar a configuração programaticamente, por exemplo, usando a API REST ou o comando az apim update na CLI do Azure.

Mais informações

Conteúdo relacionado

Confira todas as próximas alterações interruptivas e as desativações de recursos.