Partilhar via

Importar e exportar definições de esquema com o PowerShell

  • Artigo

Importante

A 11 de julho de 2026, o Blueprints (Pré-visualização) será preterido. Migre as definições e atribuições de esquemas existentes para As Especificações de Modelo e As Pilhas de Implementação. Os artefactos de esquema devem ser convertidos em modelos JSON do ARM ou ficheiros Bicep utilizados para definir pilhas de implementação. Para saber como criar um artefacto como um recurso do ARM, consulte:

O Azure Blueprints pode ser totalmente gerido através de portal do Azure. À medida que as organizações avançam na utilização do Azure Blueprints, devem começar a pensar nas definições do esquema como código gerido. Este conceito é frequentemente referido como Infraestrutura como Código (IaC). Tratar as definições do esquema como código oferece vantagens adicionais para além do que portal do Azure oferece. As vantagens incluem:

  • Partilhar definições de esquema
  • Criar cópias de segurança das definições do esquema
  • Reutilizar definições de esquema em inquilinos ou subscrições diferentes
  • Colocar as definições do esquema no controlo de origem
    • Teste automatizado de definições de esquema em ambientes de teste
    • Suporte de pipelines de integração contínua e implementação contínua (CI/CD)

Quaisquer que sejam as suas razões, gerir as definições do esquema como código tem benefícios. Este artigo mostra como utilizar os Import-AzBlueprintWithArtifact comandos e Export-AzBlueprintWithArtifact no módulo Az.Blueprint .

Pré-requisitos

Este artigo pressupõe um conhecimento de trabalho moderado do Azure Blueprints. Se ainda não o fez, veja os seguintes artigos:

Se ainda não estiver instalado, siga as instruções em Adicionar o módulo Az.Blueprint para instalar e validar o módulo Az.Blueprint a partir do Galeria do PowerShell.

Estrutura de pastas de uma definição de esquema

Antes de analisarmos a exportação e importação de esquemas, vamos ver como os ficheiros que compõem a definição do esquema são estruturados. Uma definição de esquema deve ser armazenada na sua própria pasta.

Importante

Se não for transmitido nenhum valor para o parâmetro Nome do Import-AzBlueprintWithArtifact cmdlet, é utilizado o nome da pasta na qual a definição do esquema é armazenada.

Juntamente com a definição do esquema, que tem de ser denominada blueprint.json, são os artefactos de que a definição do esquema é composta. Cada artefacto tem de estar na subpasta denominada artifacts. Em conjunto, a estrutura da definição do esquema como ficheiros JSON nas pastas deve ter o seguinte aspeto:

.
|
|- MyBlueprint/  _______________ # Root folder name becomes default name of blueprint definition
|  |- blueprint.json  __________ # The blueprint definition. Fixed name.
|
|  |- artifacts/  ______________ # Subfolder for all blueprint artifacts. Fixed name.
|     |- artifact.json  ________ # Blueprint artifact as JSON file. Artifact named from file.
|     |- ...
|     |- more-artifacts.json

Exportar a definição do esquema

Os passos para exportar a definição do esquema são simples. Exportar a definição do esquema pode ser útil para partilhar, fazer cópias de segurança ou colocar no controlo de origem.

  • Esquema [obrigatório]
    • Especifica a definição do esquema
    • Utilizar Get-AzBlueprint para obter o objeto de referência
  • OutputPath [obrigatório]
    • Especifica o caminho para guardar os ficheiros JSON de definição de esquema
    • Os ficheiros de saída estão numa subpasta com o nome da definição do esquema
  • Versão (opcional)
    • Especifica a versão a exportar se o objeto de referência blueprint contiver referências a mais do que uma versão.

  1. Obtenha uma referência à definição do esquema para exportar a partir da subscrição representada como {subId}:

    # Login first with Connect-AzAccount if not using Cloud Shell

# Get version '1.1' of the blueprint definition in the specified subscription
$bpDefinition = Get-AzBlueprint -SubscriptionId '{subId}' -Name 'MyBlueprint' -Version '1.1'

  2. Utilize o Export-AzBlueprintWithArtifact cmdlet para exportar a definição de esquema especificada:

    Export-AzBlueprintWithArtifact -Blueprint $bpDefinition -OutputPath 'C:\Blueprints'

Importar a definição do esquema

Assim que tiver uma definição de esquema exportada ou tiver uma definição de esquema criada manualmente na estrutura de pastas necessária, pode importar essa definição de esquema para um grupo de gestão ou subscrição diferente.

Para obter exemplos de definições de esquema incorporadas, veja o repositório gitHub do Azure Blueprints.

  • Nome [obrigatório]
    • Especifica o nome da nova definição de esquema
  • InputPath [obrigatório]
  • ManagementGroupId (opcional)
    • O ID do grupo de gestão para guardar a definição do esquema se não for a predefinição de contexto atual
    • ManagementGroupId ou SubscriptionId têm de ser especificados
  • SubscriptionId (opcional)
    • O ID da subscrição para guardar a definição do esquema se não for a predefinição de contexto atual
    • ManagementGroupId ou SubscriptionId têm de ser especificados

  1. Utilize o Import-AzBlueprintWithArtifact cmdlet para importar a definição de esquema especificada:

    # Login first with Connect-AzAccount if not using Cloud Shell

Import-AzBlueprintWithArtifact -Name 'MyBlueprint' -ManagementGroupId 'DevMG' -InputPath 'C:\Blueprints\MyBlueprint'

Assim que a definição do esquema for importada, atribua-a ao PowerShell.

Para obter informações sobre como criar definições de esquema avançadas, veja os seguintes artigos:

Passos seguintes