Partilhar via


Visão geral dos templates web Python do azd

Os modelos Python Web Azure Developer CLI (azd) são a maneira mais rápida e fácil de criar, configurar e implantar aplicativos Web Python no Azure. Este artigo fornece informações contextuais básicas para ajudá-lo a entender os componentes envolvidos e como os modelos simplificam a implantação.

A melhor maneira de começar é seguir o início rápido para criar seu primeiro aplicativo Web Python e implantá-lo no Azure em minutos com azd modelos. Se preferir não configurar um ambiente de desenvolvimento local, você pode seguir o início rápido usando o GitHub Codespaces para uma experiência totalmente baseada em nuvem com todas as ferramentas pré-configuradas.

O que são os modelos azd da web do Python?

Os azd modelos são projetados para desenvolvedores Web Python experientes que desejam implantar aplicativos escaláveis e prontos para nuvem no Azure com o mínimo de tempo de configuração.

Esses modelos oferecem o ponto de partida mais fácil possível para criar e implantar aplicativos Web Python ao:

  • Configuração rápida de um ambiente completo de desenvolvimento local e hospedagem.
  • Automatizando a criação de um ambiente de implantação do Azure correspondente.
  • Usando um fluxo de trabalho CLI simples e memorável.

Depois que seus ambientes são configurados, os modelos fornecem a maneira mais rápida de começar a criar seu aplicativo Web Python. É possível:

  • Modifique os arquivos de código fornecidos para corresponder aos requisitos do seu aplicativo.
  • Implante atualizações com o mínimo de esforço usando comandos azd.
  • Estenda o modelo para se adequar à sua arquitetura.

Esses modelos refletem padrões de design comprovados e práticas recomendadas, permitindo que você:

  • Construa com confiança sobre uma base arquitetônica sólida.
  • Siga as orientações desenvolvidas por especialistas do setor com profunda experiência em Python e Azure.
  • Garanta a manutenção, escalabilidade e segurança desde o início.

Que tarefas posso fazer com os modelos?

Ao executar um modelo de azd da Web Python, você conclui rapidamente várias tarefas:

  • Criar aplicativo inicial. Você cria um site para uma empresa fictícia chamada Relecloud. Este projeto inicial inclui:

    • Código bem organizado e pronto para produção
    • Melhores práticas para frameworks web Python (como Flask, Django).
    • Uso adequado de dependências, configuração e estrutura.

    O modelo foi projetado para ser um ponto de partida — você pode personalizar livremente a lógica e expandir ou remover recursos do Azure para se adequar ao seu projeto.

  • Provisionar recursos do Azure. Usando o Bicep, uma linguagem moderna de infraestrutura como código (IaC), o modelo provisiona todos os recursos necessários do Azure para:

    • Hospedar seu aplicativo Web (como Serviço de Aplicativo, Aplicativos de Contêiner)
    • Conectando-se a bancos de dados (como PostgreSQL, Cosmos DB)

    Os arquivos do Bicep são totalmente editáveis — você pode adicionar ou personalizar serviços do Azure à medida que seu aplicativo evolui. Semelhante à tarefa anterior, você pode modificar os modelos do Bicep para adicionar mais serviços do Azure, conforme necessário.

  • Implantar o aplicativo inicial nos recursos provisionados do Azure. Depois que os recursos são provisionados, seu aplicativo é implantado automaticamente no ambiente do Azure. Agora pode:

    • Veja seu aplicativo em execução na nuvem em poucos minutos.
    • Teste o seu comportamento.
    • Decida qual funcionalidade ou configuração atualizar em seguida.
  • (Opcional) Configurar o repositório GitHub e o pipeline de CI/CD. Você pode opcionalmente inicializar um repositório no GitHub com um pipeline de integração contínua/entrega contínua (CI/CD) do GitHub Actions para:

    • Automatize implantações em alterações de código.
    • Colabore com os membros da equipa.
    • Envie atualizações por push para o Azure mesclando na ramificação principal.

    Essa integração ajuda você a adotar as melhores práticas de DevOps desde o início.

Onde posso aceder aos modelos?

Muitos modelos azd estão disponíveis na galeria Awesome Azure Developer CLI Templates. Esses modelos fornecem projetos de aplicativo Web Python prontos para uso com paridade de recursos em combinações populares de serviços do Azure e estruturas Web Python.

Cada modelo inclui:

  • Um aplicativo de exemplo com código limpo e sustentável.
  • Infraestrutura como código pré-configurada usando Bicep.
  • Fluxos de trabalho de implantação contínuos usando a CLI do Azure Developer.
  • Integração opcional de CI/CD via GitHub Actions

As tabelas a seguir listam os monikers de modelo de azd da Web Python que estão disponíveis para uso com o comando azd init. As tabelas identificam as tecnologias implementadas em cada modelo e fornecem um link para o repositório GitHub correspondente, onde você pode contribuir com alterações.

Os seguintes modelos de azd estão disponíveis para o Django web framework.

Modelo Base de dados Plataforma de alojamento Repositório GitHub
azure-django-postgres-flexible-aca Azure Database para Servidor Flexível PostgreSQL Aplicativos de Contêiner do Azure https://github.com/Azure-Samples/azure-django-postgres-flexible-aca
azure-django-postgres-flexible-appservice Banco de Dados do Azure para Servidor Flexível PostgreSQL Serviço de Aplicativo do Azure https://github.com/Azure-Samples/azure-django-postgres-flexible-appservice
azure-django-cosmos-postgres-aca o Azure Cosmos DB para Banco de Dados do Azure para PostgreSQL Aplicativos de contêiner do Azure https://github.com/Azure-Samples/azure-django-cosmos-postgres-aca
azure-django-cosmos-postgres-appservice Azure Cosmos DB para Banco de Dados do Azure para PostgreSQL Serviço de Aplicativo do Azure https://github.com/Azure-Samples/azure-django-cosmos-postgres-appservice
azure-django-postgres-addon-aca Aplicativos de Contêiner do Azure com o Banco de Dados do Azure para PostgreSQL Aplicativos de contêiner do Azure https://github.com/Azure-Samples/azure-django-postgres-addon-aca

Como devo usar os modelos?

Cada modelo de azd compreende um repositório do GitHub que contém o código da aplicação (código Python que utiliza um framework web popular) e os arquivos de infraestrutura como código (nomeadamente, Bicep) para criar os recursos do Azure. O modelo também contém a configuração necessária para configurar um repositório GitHub com um pipeline de CI/CD.

Os principais componentes de cada modelo incluem:

  • Código da aplicação: Escrito em Python e construído usando um framework web popular (como Flask, Django, FastAPI). O aplicativo de exemplo demonstra as práticas recomendadas em roteamento, acesso a dados e configuração.

  • Infraestrutura como código (IaC): fornecida por meio de arquivos Bicep para definir e provisionar os recursos necessários do Azure, como:

    • Serviço de Aplicativo ou Aplicativos de Contêiner
    • Bancos de Dados do Azure (como PostgreSQL, Cosmos DB)
    • Serviços de IA do Azure, armazenamento e muito mais
  • Configuração de CI/CD (Opcional): Inclui arquivos para configurar um repositório GitHub com um pipeline de CI/CD de Ações do GitHub, permitindo:

    • Implantação automática no Azure em cada solicitação push ou pull para a ramificação principal.
    • Integração perfeita ao seu fluxo de trabalho de DevOps

    Estes modelos são totalmente personalizáveis, dando-lhe uma base sólida para desenvolver e adaptar-se às necessidades específicas do seu projeto.

Para executar as tarefas definidas por um modelo da Web azd, use vários comandos Python azd. Para obter descrições detalhadas desses comandos, consulte Guia de início rápido : implantar um modelo de CLI do desenvolvedor do Azure. As instruções rápidas orientam-no pelas etapas para utilizar um modelo específico azd. Você só precisa executar cinco instruções de linha de comando essenciais para o ambiente de hospedagem de produção e o ambiente de desenvolvimento local.

A tabela a seguir resume os cinco comandos essenciais:

Comando Descrição da tarefa
azd init --template <template name> Crie um novo projeto a partir de um modelo e crie uma cópia do código do aplicativo em seu computador local. O comando solicita que você forneça um nome de ambiente (como "myapp") que é usado como um prefixo na nomeação dos recursos implantados.
azd auth login Entre no Azure. O comando abre uma janela do navegador onde você pode entrar no Azure. Depois de iniciar sessão, a janela do browser fecha e o comando é concluído. O comando azd auth login é necessário somente na primeira vez que você usa a CLI do Desenvolvedor do Azure (azd) por sessão.
azd up Provisione os recursos de nuvem e implante o aplicativo nesses recursos.
azd deploy Implante alterações no código-fonte do aplicativo em recursos já provisionados pelo comando azd up.
azd down Se tiver sido utilizado, elimine os recursos do Azure e o pipeline de CI/CD.

Dica

Quando você trabalha com os comandos azd, observe as solicitações para inserir mais informações. Depois de executar o comando azd up, você pode ser solicitado a selecionar uma assinatura, se tiver mais de uma. Você também pode ser solicitado a especificar sua região. Você pode alterar as respostas aos prompts editando as variáveis de ambiente armazenadas na pasta /.azure/ do modelo.

Depois de concluir as tarefas essenciais fornecidas pelo azd modelo, você tem uma cópia pessoal do modelo original onde você pode modificar qualquer arquivo, conforme necessário.

  • Código do aplicativo: Personalize o código do projeto Python para implementar seu próprio design, rotas e lógica de negócios.
  • Infraestrutura como código (Bicep): atualize os arquivos Bicep para provisionar serviços adicionais do Azure, alterar configurações ou remover recursos desnecessários.

Esse ponto de partida flexível permite que você construa sobre uma base bem estruturada enquanto adapta o aplicativo ao seu caso de uso do mundo real.

Você também pode modificar a configuração de infraestrutura como código se precisar alterar os recursos do Azure. Para obter mais informações, consulte a seção O que posso editar ou excluir mais adiante neste artigo.

Tarefas de modelo opcionais

Além dos cinco comandos essenciais, há tarefas opcionais que você pode concluir com os modelos azd.

Reprovisionar e modificar recursos do Azure

Depois de provisionar recursos do Azure com um modelo de azd, você pode modificar e reprovisionar um recurso.

Configurar uma pipeline de CI/CD

A CLI do Desenvolvedor do Azure (azd) fornece uma maneira fácil de configurar um pipeline de CI/CD para seu novo aplicativo Web Python. Quando você mescla confirmações ou solicitações de pull em sua ramificação principal, o pipeline cria e publica automaticamente as alterações em seus recursos do Azure.

  • Para configurar a pipeline de CI/CD, indique o repositório GitHub e as configurações pretendidas para ativar a pipeline.
  • Para criar o pipeline, use o comando azd pipeline config.

Depois de configurar o pipeline, sempre que as alterações de código são mescladas na ramificação principal do repositório, o pipeline implanta as alterações em seus serviços provisionados do Azure.

Alternativas aos modelos

Se você preferir não usar os modelos de azd Web do Python, há métodos alternativos para implantar aplicativos Web Python no Azure e provisionar recursos do Azure.

Você pode criar muitos recursos e concluir as etapas de implantação usando várias ferramentas:

Você também pode seguir um tutorial de ponta a ponta que apresenta estruturas de desenvolvimento web Python:

Perguntas frequentes

As seções a seguir resumem as respostas às perguntas freqüentes sobre como trabalhar com os modelos de azd da Web do Python.

Tenho que usar Dev Containers?

Não. Os modelos de azd da Web Python usam de contêineres de desenvolvimento de código do Visual Studio por padrão. Os Contêineres de Desenvolvimento oferecem muitos benefícios, mas exigem alguns pré-requisitos de conhecimento e software. Se você preferir não usar contêineres de desenvolvimento e, em vez disso, usar seu ambiente de desenvolvimento local, consulte o arquivo de README.md no diretório raiz do aplicativo de exemplo para obter instruções de configuração do ambiente.

O que posso editar ou eliminar?

O conteúdo de cada modelo de azd web Python pode variar dependendo do tipo de projeto e da pilha de tecnologia subjacente empregada. Os modelos identificados neste artigo seguem uma convenção comum de pasta e arquivo, conforme descrito na tabela a seguir.

Pasta/ficheiro(s) Finalidade Descrição
/ Diretório raiz A pasta raiz para cada modelo contém muitos tipos diferentes de arquivos e pastas para finalidades diferentes.
/.azure azd arquivos de configuração A pasta .azure é criada depois de executar o comando azd init. A pasta armazena arquivos de configuração para as variáveis de ambiente usadas pelos comandos azd. Você pode alterar os valores das variáveis de ambiente para personalizar o aplicativo e os recursos do Azure. Para obter mais informações, consulte arquivo .env específico do ambiente.
/.devcontainer Arquivos de configuração do Dev Container Os Contêineres de Desenvolvimento permitem que você crie um ambiente de desenvolvimento baseado em contêiner completo com todos os recursos necessários para o desenvolvimento de software dentro do Visual Studio Code. A pasta .devcontainer é criada depois que o Visual Studio Code gera um arquivo de configuração de Dev Container em resposta a um comando de modelo.
/.github Arquivos de configuração do GitHub Actions Esta pasta contém definições de configuração para o pipeline, linting e testes opcionais do GitHub Actions CI/CD. Se você não quiser configurar o pipeline de Ações do GitHub usando comando, poderá modificar ou excluir o arquivo azure-dev.yaml .
/infra Arquivos Bicep A pasta infra contém os ficheiros de configuração do Bicep. O Bicep permite que você declare os recursos do Azure que deseja implantar em seu ambiente. Você só deve modificar o main.bicep e web.bicep arquivos. Para obter mais informações, consulte Guia de início rápido: escalando serviços implantados com os modelos Web Python do azd usando o Bicep.
/src Arquivos de código do projeto inicial A pasta src contém vários arquivos de código necessários para preparar o projeto inicial. Exemplos dos arquivos incluem modelos exigidos pela estrutura da web, arquivos estáticos, arquivos Python (.py) para a lógica de código e modelos de dados, um arquivo requirements.txt e muito mais. Os arquivos específicos dependem da estrutura da Web, da estrutura de acesso a dados e assim por diante. Você pode modificar esses arquivos para atender aos requisitos do seu projeto.
/.cruft.json Arquivo de geração de modelo O arquivo .cruft JSON é usado internamente para gerar os modelos de azd da Web do Python. Você pode excluir esse arquivo com segurança, conforme necessário.
/.gitattributes Arquivo com configurações de atributo para git Este arquivo fornece ao git definições de configuração importantes para lidar com arquivos e pastas. Você pode modificar esse arquivo, conforme necessário.
/.gitignore Arquivo com itens ignorados para git O arquivo .gitignore informa o git sobre os arquivos e pastas a serem excluídos (ignorados) ao gravar no repositório GitHub para o modelo. Você pode modificar esse arquivo, conforme necessário.
/azure.yaml azd up arquivo de configuração Este arquivo de configuração contém as definições de configuração para o comando azd up. Ele especifica os serviços e as pastas de projeto a serem implantadas. Importante: Este arquivo não deve ser excluído.
/*.md Arquivos de formato Markdown Um modelo pode incluir vários arquivos de formato Markdown (.md) para diferentes finalidades. Você pode excluir arquivos Markdown com segurança.
/docker-compose.yml Configurações de composição do Docker Esse arquivo YML cria o pacote de contêiner para o aplicativo Web Python antes que o aplicativo seja implantado no Azure.
/pyproject.toml Ficheiro de configurações de compilação do Python O arquivo TOML contém os requisitos de sistema de compilação de projetos Python. Pode modificar este ficheiro para definir as suas preferências de ferramentas, como um linter específico ou uma estrutura de teste de unidade.
/requirements-dev.in ficheiro de requisitos do pip Esse arquivo é usado para criar uma versão do ambiente de desenvolvimento dos requisitos usando o comando pip install -r. Você pode modificar esse arquivo para incluir outros pacotes, conforme necessário.

Dica

Ao modificar arquivos de modelo para seu programa, certifique-se de praticar um bom controle de versão. Essa abordagem pode ajudá-lo a restaurar o repositório para uma versão de trabalho anterior, se novas alterações causarem problemas no programa.

Como posso lidar com erros de modelo?

Se receber um erro ao usar um template de azd, reveja as opções descritas no artigo Resolução de Problemas da CLI de Desenvolvedor do Azure. Você também pode relatar problemas no repositório GitHub associado ao modelo azd.