Gerenciar perfis de versão de API no Hub Azure StackManage API version profiles in Azure Stack Hub

Perfis de API especificam o provedor de recursos do Azure e a versão de API para pontos de extremidade REST do Azure.API profiles specify the Azure resource provider and the API version for Azure REST endpoints. Você pode criar clientes personalizados em diferentes idiomas usando perfis de API.You can create custom clients in different languages using API profiles. Cada cliente usa um perfil de API para contatar o provedor de recursos correto e a versão de API para Azure Stack Hub.Each client uses an API profile to contact the correct resource provider and API version for 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 Azure Stack Hub.You can create an app to work with Azure resource providers without having to know exactly which version of each resource provider API is compatible with Azure Stack Hub. Basta alinhar seu aplicativo a um perfil e o SDK será revertido para a versão de API correta.Just align your app to a profile and the SDK reverts to the correct API version.

Este tópico ajuda a:This topic helps you:

  • Entenda os perfis de API para Azure Stack Hub.Understand API profiles for Azure Stack Hub.
  • Saiba como você pode usar perfis de API para desenvolver suas soluções.Learn how you can use API profiles to develop your solutions.
  • Consulte onde encontrar diretrizes específicas de código.See where to find code-specific guidance.

Resumo de perfis de APISummary of API profiles

  • Os perfis de API são usados para representar um conjunto de provedores de recursos do Azure e suas versões de API.API profiles are used to represent a set of Azure resource providers and their API versions.
  • Os perfis de API foram criados para você criar modelos em várias nuvens do Azure.API profiles were created for you to create templates across multiple Azure clouds. Os perfis fornecem uma interface compatível e estável.Profiles provide a compatible and stable interface.
  • Os perfis são liberados quatro vezes por ano.Profiles are released four times a year.
  • São usadas três convenções de nomenclatura de perfil:Three profile naming conventions are used:
    • mais recentelatest
      Contém as versões de API mais recentes lançadas no Azure global.Contains the most recent API versions released in global Azure.
    • aaaa-mm-dd-híbridoyyyy-mm-dd-hybrid
      Lançado bidirecionalmente, esta versão se concentra na consistência e na estabilidade em várias nuvens.Released bi-annually, this release focuses on consistency and stability across multiple clouds. Esse perfil visa a compatibilidade de Hub de Azure Stack ideal.This profile targets optimal Azure Stack Hub compatibility.
    • aaaa-mm-dd-Profileyyyy-mm-dd-profile
      Equilibra a estabilidade ideal e os recursos mais recentes.Balances optimal stability and the latest features.

Perfis de API do Azure e compatibilidade de Hub de Azure StackAzure API profiles and Azure Stack Hub compatibility

Os perfis de API do Azure mais recentes não são compatíveis com o Hub Azure Stack.The newest Azure API profiles are not compatible with Azure Stack Hub. Use as seguintes convenções de nomenclatura para identificar quais perfis usar para suas soluções de Hub de Azure Stack:Use the following naming conventions to identify which profiles to use for your Azure Stack Hub solutions:

ÚltimaLatest
Esse perfil tem as versões de API mais atualizadas encontradas no Azure global, que não funcionam no Hub Azure Stack.This profile has the most up-to-date API versions found in global Azure, which do not work in Azure Stack Hub. O mais recente tem o maior número de alterações significativas.Latest has the largest number of breaking changes. O perfil deixa de lado a estabilidade e a compatibilidade com outras nuvens.The profile puts aside stability and compatibility with other clouds. Se você estiver tentando usar as versões mais atualizadas da API, mais recente é o perfil que você deve usar.If you're trying to use the most up-to-date API versions, Latest is the profile you should use.

Aaaa-mm-dd-híbridoYyyy-mm-dd-hybrid
Esse perfil é lançado em março e setembro todos os anos.This profile is released in March and September every year. Ele tem estabilidade e compatibilidade ideais com várias nuvens e foi projetado para direcionar o Azure global e o Hub de Azure Stack.It has optimal stability and compatibility with various clouds, and is designed to target global Azure and Azure Stack Hub. As versões da API do Azure listadas neste perfil serão as mesmas que aquelas listadas no Hub Azure Stack.The Azure API versions listed in this profile will be the same as the ones that are listed in Azure Stack Hub. Use este perfil para desenvolver código para soluções de nuvem híbrida.Use this profile to develop code for hybrid cloud solutions.

aaaa-mm-dd-Profileyyyy-mm-dd-profile
Esse perfil é lançado para o Azure global em junho e dezembro.This profile is released for global Azure in June and December. Ele não funciona com o Hub Azure Stack e, normalmente, haverá muitas alterações significativas.It does not work with Azure Stack Hub, and there will typically be many breaking changes. Embora ele Equilibre a estabilidade ideal e os recursos mais recentes, a diferença entre o mais recente e esse perfil é que o mais recente sempre consiste nas versões mais recentes da API, independentemente de quando a API é liberada.Although it balances optimal stability and the latest features, the difference between Latest and this profile is that Latest always consists of the newest API versions, regardless of when the API is released. Por exemplo, se uma nova versão de API for criada para a API de computação amanhã, essa versão de API será listada na mais recente, mas não no perfil aaaa-mm-dd-Profile , pois esse perfil já existe.For example, if a new API version is created for the Compute API tomorrow, that API version is listed in the Latest, but not in the yyyy-mm-dd-profile profile, because this profile already exists. aaaa-mm-dd-Profile abrange as versões mais atualizadas lançadas antes de junho ou antes de dezembro.yyyy-mm-dd-profile covers the most up-to-date versions released before June or before December.

Azure Resource Manager perfis de APIAzure Resource Manager API profiles

Azure Stack Hub não usa a versão mais recente das versões de API encontradas no Azure global.Azure Stack Hub does not use the latest version of the API versions found in global Azure. Ao criar uma solução, você deve encontrar a versão de API para cada provedor de recursos do Azure compatível com o Hub de Azure Stack.When you create a solution, you must find the API version for each Azure resource provider that is compatible with Azure Stack Hub.

Em vez de pesquisar cada provedor de recursos e a versão específica com suporte pelo Hub Azure Stack, você pode usar um perfil de API.Rather than research every resource provider and the specific version supported by Azure Stack Hub, you can use an API profile. O perfil especifica um conjunto de provedores de recursos e versões de API.The profile specifies a set of resource providers and API versions. O SDK, ou uma ferramenta criada com o SDK, será revertido para o destino api-version especificado no perfil.The SDK, or a tool built with the SDK, will revert to the target api-version specified in the profile. Com os perfis de API, você pode especificar uma versão de perfil que se aplica a um modelo inteiro.With API profiles, you can specify a profile version that applies to an entire template. Em tempo de execução, o Azure Resource Manager seleciona a versão correta do recurso.At runtime, the Azure Resource Manager selects the right version of the resource.

Os perfis de API funcionam com ferramentas que usam Azure Resource Manager, como PowerShell, CLI do Azure, código fornecido no SDK e Microsoft Visual Studio.API profiles work with tools that use Azure Resource Manager, such as PowerShell, Azure CLI, code provided in the SDK, and Microsoft Visual Studio. Ferramentas e SDKs podem usar perfis para ler qual versão dos módulos e bibliotecas incluir ao criar um aplicativo.Tools and SDKs can use profiles to read which version of the modules and libraries to include when building an app.

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 a API-Version 2015-12-01, você deve procurar 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 instalá-los.For example, if you use PowerShell to create a storage account using the Microsoft.Storage resource provider, which supports api-version 2016-03-30 and a VM using the Microsoft.Compute resource provider with api-version 2015-12-01, you must look up which PowerShell module supports 2016-03-30 for Storage, and which module supports 2015-02-01 for Compute, and then install them. Em vez disso, você pode usar um perfil.Instead, you can use a profile. Use o cmdlet Install-Profile <profilename> e o PowerShell carregará a versão correta dos módulos.Use the cmdlet Install-Profile <profilename>, and PowerShell loads the correct version of the modules.

Da mesma forma, ao usar o SDK do Python para criar um aplicativo baseado em Python, você pode especificar o perfil.Similarly, when using the Python SDK to build a Python-based app, you can specify the profile. O SDK carrega os módulos corretos para os provedores de recursos que você especificou em seu script.The SDK loads the right modules for the resource providers that you've specified in your script.

Como desenvolvedor, você pode se concentrar em escrever sua solução.As a developer, you can focus on writing your solution. Em vez de Pesquisar as versões de API, o provedor de recursos e a nuvem funcionam juntas, você pode usar um perfil e saber que o código funciona em todas as nuvens que dão suporte a esse perfil.Instead of researching which API versions, resource provider, and cloud work together, you can use a profile and know that your code works across all clouds that support that profile.

Exemplos de código de perfil de APIAPI profile code samples

Você pode encontrar exemplos de código para ajudá-lo a integrar sua solução com seu idioma preferido com o Azure Stack Hub usando perfis.You can find code samples to help you integrate your solution with your preferred language with Azure Stack Hub by using profiles. No momento, você pode encontrar orientações e exemplos para os seguintes idiomas:Currently, you can find guidance and samples for the following languages:

  • .NET.NET
    Use o perfil da API .NET para obter a versão mais recente e mais estável de cada tipo de recurso em um pacote de provedor de recursos.Use the .NET API profile to get the latest, most stable version of each resource type in a resource provider package. Para obter mais informações, consulte usar perfis de versão de API com .net no Hub Azure Stack.For more information, see Use API version profiles with .NET in Azure Stack Hub.
  • PowerShellPowerShell
    Use o módulo AZ. Bootstrapper disponível por meio do Galeria do PowerShell para obter os cmdlets do PowerShell necessários para trabalhar com perfis de versão de API.Use the Az.Bootstrapper module available through the PowerShell Gallery to get the PowerShell cmdlets required to work with API version profiles. Para obter informações, consulte usar perfis de versão de API para o PowerShell.For information, see Use API version profiles for PowerShell. Use o módulo AzureRM. Bootstrapper disponível por meio do Galeria do PowerShell para obter os cmdlets do PowerShell necessários para trabalhar com perfis de versão de API.Use the AzureRM.Bootstrapper module available through the PowerShell Gallery to get the PowerShell cmdlets required to work with API version profiles. Para obter informações, consulte usar perfis de versão de API para o PowerShell.For information, see Use API version profiles for PowerShell.
  • CLI do AzureAzure CLI
    Atualize sua configuração de ambiente para usar o perfil de versão de API de Azure Stack Hub específico.Update your environment configuration to use the Azure Stack Hub specific API version profile. Para obter informações, consulte usar perfis de versão de API para CLI do Azure.For information, see Use API version profiles for Azure CLI.
  • GoGo
    No SDK do Go, um perfil é uma combinação de diferentes tipos de recursos com versões diferentes de serviços diferentes.In the Go SDK, a profile is a combination of different resource types with different versions from different services. Os perfis estão disponíveis sob os perfis/caminho com sua versão no formato aaaa-mm-dd .Profiles are available under the profiles/path with their version in the YYYY-MM-DD format. Para obter informações, consulte usar perfis de versão de API para go.For information, see Use API version profiles for Go.
  • RubyRuby
    O SDK do Ruby para o Azure Stack Hub Resource Manager fornece ferramentas para ajudá-lo a criar e gerenciar sua infraestrutura.The Ruby SDK for the Azure Stack Hub Resource Manager provides tools to help you build and manage your infrastructure. Os provedores de recursos no SDK incluem computação, redes virtuais e armazenamento com a linguagem Ruby.Resource providers in the SDK include compute, virtual networks, and storage with the Ruby language. Para obter informações, consulte usar perfis de versão de API com Ruby.For information, see Use API version profiles with Ruby.
  • PythonPython
    O SDK do Python dá suporte a perfis de versão de API para direcionar diferentes plataformas de nuvem, como Azure Stack Hub e o Azure global.The Python SDK supports API version profiles to target different cloud platforms such as Azure Stack Hub and global Azure. Use perfis de API para criar soluções para uma nuvem híbrida.Use API profiles to create solutions for a hybrid cloud. Para obter informações, consulte usar perfis de versão de API com Python.For information, see Use API version profiles with Python.
  • Node.jsNode.js
    O SDK do Node.js para o Azure Stack Gerenciador de recursos do Hub fornece ferramentas para ajudá-lo a criar e gerenciar sua infraestrutura.The Node.js SDK for the Azure Stack Hub Resource Manager provides tools to help you build and manage your infrastructure. Para obter mais informações, consulte usar perfis de versão de API com Node.js.For more information, see Use API version Profiles with Node.js.

Próximas etapasNext steps