Configurar e consumir fontes de modelo

A CLI do Desenvolvedor do Azure foi projetada em torno de um poderoso sistema de modelo que simplifica a implantação e o provisionamento de recursos do Azure. Ao desenvolver com azdo , você tem a opção de criar seu próprio modelo ou escolher em uma lista configurável de modelos existentes. Neste artigo, você aprenderá a trabalhar com listas de modelos e configurar sua instalação local azd para dar suporte a diferentes fontes de lista de modelos.

Entender as fontes de modelo

Uma fonte de modelo azd aponta para um arquivo de configuração JSON que descreve uma lista de modelos disponíveis e seus metadados essenciais, como o nome, a descrição e o local do código-fonte do modelo (geralmente um repositório GitHub). Quando você habilita uma origem de modelo, os modelos que ela define são disponibilizados por meio de azd outros comandos. Por exemplo, o snippet JSON de origem do modelo abaixo define dois modelos:

[
  {
    "name": "Starter - Bicep",
    "description": "A starter template with Bicep as infrastructure provider",
    "repositoryPath": "azd-starter-bicep",
    "tags": ["bicep"]
  },
  {
    "name": "Starter - Terraform",
    "description": "A starter template with Terraform as infrastructure provider",
    "repositoryPath": "azd-starter-terraform",
    "tags": ["terraform"]
  }
]

Cada entrada de modelo no arquivo de configuração JSON inclui as seguintes propriedades:

  • name: o nome de exibição do modelo.
  • descrição: um breve resumo do que o modelo faz.
  • caminho do repositório: o caminho para o código-fonte do modelo, que pode ser:
    • Um URI totalmente qualificado para um repositório Git, como "https://dev.azure.com/org/project/_git/repo".
    • "{owner}/{repo}" para repositórios do GitHub.
    • "{repo}" para repositórios do GitHub na organização Azure-Samples.
  • marcas: palavras-chave que ajudam os usuários a filtrar modelos com azd init --filter <tag> e azd template list --filter <tag>.

Para obter um exemplo completo, consulte este arquivo JSON, que é a fonte de modelo padrão incluída no azd.

azd permite habilitar várias fontes de modelo de cada vez. As seguintes opções de origem de modelo estão disponíveis atualmente para escolha:

  • awesome-azd - Uma lista de modelos padrão da galeria do Awesome AZD que está habilitada por padrão. Os modelos padrão têm um vazio ou ausente templateType.
  • padrão - Um pequeno conjunto de modelos selecionados para demonstrar diferentes pilhas de tecnologia.
  • file - Um caminho local/de rede que aponta para um arquivo de configuração JSON de origem do modelo.
  • url - Um caminho endereçável HTTP(S) que aponta para um arquivo de configuração JSON de origem do modelo.
  • gh - Aponta para um repositório GitHub.
  • ade - Aponta para uma lista de modelos do Ambiente de Implantação do Azure. Saiba mais sobre o suporte da CLI do Desenvolvedor do Azure para Ambientes de Implantação do Azure.

Trabalhar com fontes de modelo

azd fornece vários comandos para configurar fontes de modelo.

Use o azd template source list comando para listar todas as fontes de modelo configuradas no momento:

azd template source list

Exemplo de saída com duas fontes de modelo configuradas:

Key          Name         Type         Location

awesome-azd  Awesome AZD  awesome-azd  https://aka.ms/awesome-azd/templates.json
default      Default      resource

Use o azd template source add comando para adicionar uma nova fonte de modelo. Este comando aceita os seguintes parâmetros:

  • key: O nome técnico da origem do modelo.
  • --type, -t: o tipo de origem do modelo - os valores válidos são file, url e gh para GitHub.
  • --location, -l: o local de origem do modelo, que deve ser uma rede local ou um URI da Web HTTP(S).
  • --name, -n: nome de exibição da origem do modelo (opcional, usa a chave se omitido).
azd template source add <key> --type <file-or-url-or-gh> --location <your-uri> --name <your-display-name>

Use o azd template source remove comando para remover uma fonte de modelo:

azd template source remove <key>

Use o azd config reset comando para redefinir a configuração do modelo de volta para as configurações padrão:

azd config reset

Trabalhar com listas de modelos

Depois de configurar suas fontes de modelo, use o azd template list comando para listar os modelos disponíveis dessas fontes:

azd template list

O azd template list comando inclui apenas modelos padrão que têm um vazio ou ausente templateType. Ele exclui modelos específicos de extensão, como modelos com templateType definido como extension.ai.agent. Para inicializar um modelo específico de extensão, siga a documentação de extensão ou modelo.

Por exemplo, uma instalação padrão de azd lista os seguintes modelos da origem do modelo awesome-azd :

Name                                                         Source       Repository Path

Event Driven Java Application with Azure Service Bus         Awesome AZD  Azure-Samples/ASA-Samples-Event-Driven-Application
Static React Web App with Java API and PostgreSQL            Awesome AZD  Azure-Samples/ASA-Samples-Web-Application
SAP CAP on Azure App Service Quickstart                      Awesome AZD  Azure-Samples/app-service-javascript-sap-cap-quickstart
SAP Cloud SDK on Azure App Service Quickstart (TypeScript)   Awesome AZD  Azure-Samples/app-service-javascript-sap-cloud-sdk-quickstart
Java Spring Apps with Azure OpenAI                           Awesome AZD  Azure-Samples/app-templates-java-openai-springapps
WordPress with Azure Container Apps                          Awesome AZD  Azure-Samples/apptemplate-wordpress-on-ACA
Bicep template to bootstrap Azure Deployment Environments    Awesome AZD  Azure-Samples/azd-deployment-environments
Starter - Bicep                                              Awesome AZD  Azure-Samples/azd-starter-bicep
Starter - Terraform                                          Awesome AZD  Azure-Samples/azd-starter-terraform
...
# Additional templates omitted 

Inclua o --source sinalizador para listar apenas modelos de uma fonte específica:

azd template list --source <source-name>

Para inicializar um modelo padrão da lista exibida, execute o azd init comando e forneça o caminho do repositório do modelo:

azd init --template <path-value>

Trabalhar com ambientes de implantação do Azure

A CLI do Desenvolvedor do Azure (azd) também fornece suporte para Ambientes de Implantação do Azure. Um ADE (Ambiente de Implantação do Azure) é uma coleção pré-configurada de recursos do Azure implantados em assinaturas predefinidas. A governança do Azure é aplicada a essas assinaturas com base no tipo de ambiente, como área restrita, teste, preparo ou produção. Com os Ambientes de Implantação do Azure, você pode impor políticas de segurança corporativa e fornecer um conjunto coletado de modelos de IaC (infraestrutura como código) predefinidos.

A integração do ADE está além do escopo deste artigo. Saiba mais sobre como configurar ade o suporte na documentação de suporte da CLI do Desenvolvedor do Azure para Ambientes de Implantação do Azure.

Próximas etapas