Desativações de versão da API (setembro de 2023)

  • Artigo

APLICA-SE A: Consumo | Desenvolvedor | Básico | Padrão | Prêmio

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.

Em 30 de setembro de 2023, todas as versões de API do serviço de Gerenciamento de API do Azure anteriores a 2021-08-01 serão desativadas e as chamadas de API que usam essas versões de API falharão. Isso significa que você não poderá mais criar ou gerenciar os serviços de Gerenciamento de API usando os modelos, as ferramentas, os scripts e os programas existentes até que sejam atualizados. As operações de dados (por exemplo, acessar as APIs ou os produtos configurados no Gerenciamento de API do Azure) não serão afetadas por essa atualização, incluindo depois de 30 de setembro de 2023.

A partir de agora até 30 de setembro de 2023, você pode continuar a usar os modelos, as ferramentas e os programas, sem impacto. Você pode fazer a transição para a API versão 2021-08-01 ou posterior a qualquer momento, antes de 30 de setembro de 2023.

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

Embora o seu serviço não seja afetado por essa alteração, as ferramentas, os scripts ou os programas que usam o Azure Resource Manager (como a CLI do Azure, o Azure PowerShell, o Kit de Recursos de DevOps do Gerenciamento de API do Azure ou o Terraform) para interagir com o serviço de Gerenciamento de API serão afetados por essa alteração. Você não poderá executar essas ferramentas com êxito, a menos que as atualize.

Qual é o prezo para a mudança?

As versões da API afetadas não serão mais válidas depois de 30 de setembro de 2023.

Depois de 30 de setembro de 2023, se você preferir não atualizar as ferramentas, os scripts e os programas, os serviços continuarão funcionando, mas você não poderá adicionar ou remover as APIs, alterar a política de API ou configurar o serviço de Gerenciamento de API.

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 posteriores):

    • .NET: 8.0.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. Essa configuração limita as chamadas de API do plano de controle para sua instância com uma versão de API igual ou mais recente que esse valor. Atualmente você pode definir isso para 2021-08-01.

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 Impedir que usuários com permissões somente leitura acessem segredos de serviço, selecione Sim. A versão mínima da API é exibida.
  5. Selecione Salvar.

Mais informações

Conteúdo relacionado

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