Partilhar via

Aposentadorias da versão da API (junho de 2024)

  • Artigo

APLICA-SE A: Consumo | Programador | Básico | Padrão | Prémio

A Gestão de API do Azure utiliza o Azure Resource Manager (ARM) para configurar as suas instâncias da Gestão de API. A versão de API está incorporada na utilização que faz dos modelos que descrevem a sua infraestrutura, das ferramentas utilizadas para configurar o serviço e dos programas que escreve para gerir os seus serviços da Gestão 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, chamadas de API usando uma versão de API anterior a 2021-08-01 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 a mediação de solicitações de API no gateway) não serão afetadas por esta atualização, inclusive após 1º de junho de 2024.

O meu serviço é afetado por isso?

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 Kit de Recursos de DevOps de Gerenciamento de API do Azure ou o Terraform) para interagir com o serviço de Gerenciamento de API e chame uma versão da API de Gerenciamento de API anterior a 01/08/2021 será 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 prazo para a mudança?

As versões da 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 as 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 as 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 ARM, Bíceps ou Terraform - Atualize o modelo para usar a versão da API 2021-08-01 ou posterior.

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

  • Azure PowerShell - Execute Get-Module -ListAvailable -Name Az para verificar sua 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 obter mais informações, veja Instalar o módulo Azure Az do PowerShell.

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

    • Kit de recursos de DevOps de gerenciamento de API: 1.0.0
    • Provedor de azurerm Terraform: 3.0.0

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

    • .NET: v1.1.0
    • Ir: 1.0.0
    • Píton: 3.0.0
    • JavaScript: 8.0.1
    • Java: 1.0.0-beta3

Atualizar a configuração de versão mínima da API em sua 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 a uma versão da 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é sua instância de Gerenciamento de API.
  2. No menu à esquerda, 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 Guardar.

Importante

Se a versão mínima da API no portal estiver acinzentada, 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údos relacionados

Veja todas as próximas mudanças e desativações de recursos.