Gerir perfis de versão API no Azure Stack HubManage API version profiles in Azure Stack Hub

Os perfis da API especificam o fornecedor de recursos Azure e a versão API para os pontos finais Azure REST.API profiles specify the Azure resource provider and the API version for Azure REST endpoints. Pode criar clientes personalizados em diferentes idiomas utilizando perfis de API.You can create custom clients in different languages using API profiles. Cada cliente utiliza um perfil API para contactar o fornecedor de recursos correto e a versão API para o Azure Stack Hub.Each client uses an API profile to contact the correct resource provider and API version for Azure Stack Hub.

Pode criar uma aplicação para trabalhar com fornecedores de recursos Azure sem ter de saber exatamente qual a versão de cada fornecedor de recursos API compatível com o 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 a sua aplicação com um perfil e o SDK reverte para a versão API correta.Just align your app to a profile and the SDK reverts to the correct API version.

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

  • Compreenda os perfis da API para o Azure Stack Hub.Understand API profiles for Azure Stack Hub.
  • Saiba como pode usar perfis de API para desenvolver as suas soluções.Learn how you can use API profiles to develop your solutions.
  • Veja onde encontrar orientação específica para códigos.See where to find code-specific guidance.

Resumo dos perfis da APISummary of API profiles

  • Os perfis da API são utilizados para representar um conjunto de fornecedores de recursos Azure e as suas versões API.API profiles are used to represent a set of Azure resource providers and their API versions.
  • Os perfis de API foram criados para criar modelos em várias nuvens de 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 divulgados quatro vezes por ano.Profiles are released four times a year.
  • São utilizadas três convenções de nomeação de perfil:Three profile naming conventions are used:
    • mais recentelatest
      Contém as versões API mais recentes lançadas no Azure global.Contains the most recent API versions released in global Azure.
    • yyy-mm-dd-híbridoyyyy-mm-dd-hybrid
      Lançada bianuamente, esta versão foca-se na consistência e estabilidade em várias nuvens.Released bi-annually, this release focuses on consistency and stability across multiple clouds. Este perfil tem como alvo a compatibilidade ideal do Azure Stack Hub.This profile targets optimal Azure Stack Hub compatibility.
    • yyy-mm-dd-perfilyyyy-mm-dd-profile
      Equilibra a estabilidade ideal e as funcionalidades mais recentes.Balances optimal stability and the latest features.

Perfis API Azure e compatibilidade do Azure Stack HubAzure API profiles and Azure Stack Hub compatibility

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

ÚltimasLatest
Este perfil tem as versões API mais atualizadas encontradas no Azure global, que não funcionam no Azure Stack Hub.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 mudanças de rutura.Latest has the largest number of breaking changes. O perfil põe de lado a estabilidade e a compatibilidade com outras nuvens.The profile puts aside stability and compatibility with other clouds. Se estiver a tentar utilizar as versões API mais atualizadas, o Mais Recente é o perfil que deve utilizar.If you're trying to use the most up-to-date API versions, Latest is the profile you should use.

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

yyy-mm-dd-perfilyyyy-mm-dd-profile
Este perfil é lançado para o Global Azure em junho e dezembro.This profile is released for global Azure in June and December. Não funciona com o Azure Stack Hub, e normalmente haverá muitas mudanças de rutura.It does not work with Azure Stack Hub, and there will typically be many breaking changes. Apesar de equilibrar a estabilidade ideal e as funcionalidades mais recentes, a diferença entre o Mais Recente e este perfil é que o Mais Recente consiste sempre nas versões API mais recentes, independentemente de quando a API for lançada.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 amanhã for criada uma nova versão API para a API compute, essa versão API está listada no mais recente , mas não no perfil de perfil yyy-mm-dd, porque este 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. O perfil yyy-mm-dd 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.

Perfis Azure Resource Manager APIAzure Resource Manager API profiles

O Azure Stack Hub não utiliza a versão mais recente das versões API encontradas no Azure global.Azure Stack Hub does not use the latest version of the API versions found in global Azure. Quando criar uma solução, tem de encontrar a versão API para cada fornecedor de recursos Azure que seja compatível com o Azure Stack Hub.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 todos os fornecedores de recursos e a versão específica suportada pelo Azure Stack Hub, pode utilizar um perfil 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 fornecedores de recursos e versões API.The profile specifies a set of resource providers and API versions. O SDK, ou uma ferramenta construída com o SDK, reverterá para o alvo 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 perfis de API, 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 Gestor de Recursos Azure seleciona a versão certa do recurso.At runtime, the Azure Resource Manager selects the right version of the resource.

Os perfis da API funcionam com ferramentas que utilizam o Azure Resource Manager, como o PowerShell, o Azure CLI, 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 que versão dos módulos e bibliotecas incluir ao construir uma app.Tools and SDKs can use profiles to read which version of the modules and libraries to include when building an app.

Por exemplo, se utilizar o PowerShell para criar uma conta de armazenamento utilizando o fornecedor de recursos Microsoft.Storage, que suporta a versão API 2016-03-30 e um VM utilizando o fornecedor de recursos Microsoft.Compute com versão API 2015-12-01, você deve procurar o módulo PowerShell suporta 2016-03-30 para armazenamento, e qual módulo suporta 2015-02-01 para a Computação, e depois instale- os mesmos.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, podes usar um perfil.Instead, you can use a profile. Utilize o cmdlet Install-Profile <profilename> , e o PowerShell carrega 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 utilizar o Python SDK para construir uma aplicação baseada em Python, 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 certos para os fornecedores de recursos que especificou no seu script.The SDK loads the right modules for the resource providers that you've specified in your script.

Como desenvolvedor, pode concentrar-se em escrever a sua solução.As a developer, you can focus on writing your solution. Em vez de pesquisar quais versões API, fornecedor de recursos e cloud trabalham em conjunto, você pode usar um perfil e saber que o seu código funciona em todas as nuvens que suportam 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.

Amostras de código de perfil da APIAPI profile code samples

Pode encontrar amostras de código para ajudá-lo a integrar a sua solução com o seu idioma preferido com o Azure Stack Hub utilizando perfis.You can find code samples to help you integrate your solution with your preferred language with Azure Stack Hub by using profiles. Atualmente, pode encontrar orientação e amostras para as seguintes línguas:Currently, you can find guidance and samples for the following languages:

  • .NET.NET
    Utilize o perfil de API .NET para obter a versão mais recente e estável de cada tipo de recurso num pacote de fornecedor 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 os perfis de versão API com .NET no Azure Stack Hub.For more information, see Use API version profiles with .NET in Azure Stack Hub.
  • PowerShellPowerShell
    Utilize o módulo Az.Bootstrapper disponível através da PowerShell Gallery para obter os cmdlets PowerShell necessários para trabalhar com perfis de versão 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 os perfis da versão API para PowerShell.For information, see Use API version profiles for PowerShell. Utilize o módulo AzureRM.Bootstrapper disponível através da PowerShell Gallery para obter os cmdlets PowerShell necessários para trabalhar com perfis de versão 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 os perfis da versão API para PowerShell.For information, see Use API version profiles for PowerShell.
  • CLI do AzureAzure CLI
    Atualize a configuração do ambiente para utilizar o perfil de versão API específico do Azure Stack Hub.Update your environment configuration to use the Azure Stack Hub specific API version profile. Para obter informações, consulte os perfis da versão API para Azure CLI.For information, see Use API version profiles for Azure CLI.
  • IrGo
    No Go SDK, um perfil é uma combinação de diferentes tipos de recursos com diferentes versões de diferentes serviços.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 nos perfis/caminhos com a sua versão no formato YYYYY-MM-DD.Profiles are available under the profiles/path with their version in the YYYY-MM-DD format. Para obter informações, consulte os perfis da versão API para Go.For information, see Use API version profiles for Go.
  • RubyRuby
    O Ruby SDK para o Azure Stack Hub Resource Manager fornece ferramentas para o ajudar a construir e gerir a sua infraestrutura.The Ruby SDK for the Azure Stack Hub Resource Manager provides tools to help you build and manage your infrastructure. Os fornecedores de recursos no SDK incluem computação, redes virtuais e armazenamento com o idioma Ruby.Resource providers in the SDK include compute, virtual networks, and storage with the Ruby language. Para obter informações, consulte os perfis de versão API com a Ruby.For information, see Use API version profiles with Ruby.
  • PythonPython
    O Python SDK suporta perfis de versão API para direcionar diferentes plataformas em nuvem, como o Azure Stack Hub e o Global Azure.The Python SDK supports API version profiles to target different cloud platforms such as Azure Stack Hub and global Azure. Utilize perfis 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 os perfis de versão API com Python.For information, see Use API version profiles with Python.
  • Node.jsNode.js
    O Node.js SDK para o Azure Stack Hub Resource Manager fornece ferramentas para ajudá-lo a construir e gerir a 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 use perfis da versão API com Node.js.For more information, see Use API version Profiles with Node.js.

Passos seguintesNext steps