Compartilhar via

Gerenciar perfis de versão de API no Azure Stack Hub

  • Artigo

Os perfis de API especificam o provedor de recursos do Azure e a versão da API para pontos de extremidade REST do Azure. Você pode criar clientes personalizados em diferentes idiomas usando perfis de API. Cada cliente usa um perfil de API para entrar em contato com o provedor de recursos correto e a versão da API para o Azure Stack Hub.

Você pode criar um aplicativo para trabalhar com provedores de recursos do Azure sem precisar saber exatamente qual versão de cada API do provedor de recursos é compatível com o Azure Stack Hub. Basta alinhar seu aplicativo a um perfil e o SDK será revertido para a versão correta da API.

Este tópico ajuda você a:

  • Entenda os perfis de API do Azure Stack Hub.
  • Saiba como você pode usar perfis de API para desenvolver suas soluções.
  • Veja onde encontrar diretrizes específicas do código.

Resumo dos perfis de API

  • Os perfis de API são usados para representar um conjunto de provedores de recursos do Azure e suas versões de API.
  • Os perfis de API foram criados para você criar modelos em várias nuvens do Azure. Os perfis fornecem uma interface compatível e estável.
  • Os perfis são lançados quatro vezes por ano.
  • Três convenções de nomenclatura de perfil são usadas:
    • mais recente
      Contém as versões mais recentes da API lançadas no Azure global.
    • aaaa-mm-dd-hybrid
      Lançada semestralmente, esta versão se concentra na consistência e estabilidade em várias nuvens. Esse perfil tem como destino a compatibilidade ideal do Azure Stack Hub.
    • aaaa-mm-dd-profile
      Equilibra a estabilidade ideal e os recursos mais recentes.

Perfis de API do Azure e compatibilidade do Azure Stack Hub

Os perfis de API do Azure mais recentes não são compatíveis com o Azure Stack Hub. Use as seguintes convenções de nomenclatura para identificar quais perfis usar para suas soluções do Azure Stack Hub:

mais recente
Esse perfil tem as versões de API mais atualizadas encontradas no Azure global, que não funcionam no Azure Stack Hub. latest tem o maior número de alterações significativas. O perfil deixa de lado a estabilidade e a compatibilidade com outras nuvens. Se você estiver tentando usar as versões de API mais atualizadas, a mais recente é o perfil que você deve usar.

Aaaa-mm-dd-híbrido
Este perfil é lançado em março e setembro de cada ano. Ele tem estabilidade e compatibilidade ideais com várias nuvens e foi projetado para direcionar o Azure global e o Azure Stack Hub. As versões da API do Azure listadas neste perfil serão as mesmas listadas no Azure Stack Hub. Use esse perfil para desenvolver código para soluções de nuvem híbrida.

aaaa-mm-dd-profile
Esse perfil é lançado para o Azure global em junho e dezembro. Ele não funciona com o Azure Stack Hub e normalmente haverá muitas alterações significativas. Embora equilibre a estabilidade ideal e os recursos mais recentes, a diferença entre o perfil mais recente e esse é que o mais recente sempre consiste nas versões mais recentes da API, independentemente de quando a API é lançada. Por exemplo, se uma nova versão da API for criada para a API de Computação amanhã, essa versão da API será listada na mais recente, mas não no perfil aaaa-mm-dd-profile , porque esse perfil já existe. yyyy-mm-dd-profile cobre as versões mais atualizadas lançadas antes de junho ou antes de dezembro.

Perfis de API do Azure Resource Manager

O Azure Stack Hub não usa a versão mais recente das versões de API encontradas no Azure global. Ao criar uma solução, você deve encontrar a versão da API para cada provedor de recursos do Azure compatível com o Azure Stack Hub.

Em vez de pesquisar todos os provedores de recursos e a versão específica compatível com o Azure Stack Hub, você pode usar um perfil de API. O perfil especifica um conjunto de provedores de recursos e versões de API. O SDK, ou uma ferramenta criada com o SDK, será revertido para o destino api-version especificado no perfil. Com perfis de API, você pode especificar uma versão de perfil que se aplica a um modelo inteiro. Em runtime, o Azure Resource Manager seleciona a versão correta do recurso.

Os perfis de API funcionam com ferramentas que usam o Azure Resource Manager, como o PowerShell, a CLI do Azure, o código fornecido no SDK e o Microsoft Visual Studio. Ferramentas e SDKs podem usar perfis para ler qual versão dos módulos e bibliotecas incluir ao criar um aplicativo.

Por exemplo, se você usar o PowerShell para criar uma conta de armazenamento usando o provedor de recursos Microsoft.Storage, que dá suporte à api-versão 2016-03-30 e uma VM usando o provedor de recursos Microsoft.Compute com api-version 2015-12-01, você deve pesquisar qual módulo do PowerShell dá suporte a 2016-03-30 para Armazenamento e qual módulo dá suporte a 2015-02-01 para Computação e, em seguida, instalá-los. Em vez disso, você pode usar um perfil. Use o cmdlet Install-Profile <profilename>e o PowerShell carregará a versão correta dos módulos.

Da mesma forma, ao usar o SDK do Python para criar um aplicativo baseado em Python, você pode especificar o perfil. O SDK carrega os módulos corretos para os provedores de recursos que você especificou em seu script.

Como desenvolvedor, isso significa que você pode se concentrar em escrever sua solução. Em vez de pesquisar quais versões de API, provedor de recursos e nuvem funcionam juntos, você pode usar um perfil e saber que seu código funciona em todas as nuvens que dão suporte a esse perfil.

Exemplos de código de perfil de API

Você pode encontrar exemplos de código para ajudá-lo a integrar sua solução com sua linguagem preferencial com o Azure Stack Hub usando perfis. Atualmente, você pode encontrar diretrizes e exemplos para os seguintes idiomas:

  • .NET
    Use o perfil de API do .NET para obter a versão mais recente e estável de cada tipo de recurso em um pacote de provedor de recursos. Para obter mais informações, consulte Usar perfis de versão de API com .NET no Azure Stack Hub.
  • PowerShell
    Use o módulo Az.Bootstrapper disponível por meio da Galeria do PowerShell para obter os cmdlets do PowerShell necessários para trabalhar com perfis de versão da API. Para obter informações, consulte Usar perfis de versão de API para o PowerShell. Use o módulo AzureRM.Bootstrapper disponível por meio da Galeria do PowerShell para obter os cmdlets do PowerShell necessários para trabalhar com perfis de versão de API. Para obter informações, consulte Usar perfis de versão de API para o PowerShell.
  • CLI do Azure
    Atualize a configuração do ambiente para usar o perfil de versão da API específico do Azure Stack Hub. Para obter informações, consulte Usar perfis de versão de API para a CLI do Azure.
  • Go
    No SDK do Go, um perfil é uma combinação de diferentes tipos de recursos com diferentes versões de diferentes serviços. Os perfis estão disponíveis nos perfis/caminho com sua versão no formato AAAA-MM-DD . Para obter informações, consulte Usar perfis de versão de API para Go.
  • Python
    O SDK do Python dá suporte a perfis de versão de API para direcionar diferentes plataformas de nuvem, como Azure Stack Hub e Azure global. Use perfis de API para criar soluções para uma nuvem híbrida. Para obter informações, consulte Usar perfis de versão de API com Python.
  • Node.js
    O SDK do Node.js para o Azure Stack Hub Resource Manager fornece ferramentas para ajudá-lo a criar e gerenciar sua infraestrutura. Para obter mais informações, consulte Usar perfis de versão da API com Node.js.

Próximas etapas