Share via

Python Web azd Templates 概觀

  • 發行項

Python Web Azure 開發人員 CLI （azd） 範本是開始建置 Python Web 應用程式並將其部署至 Azure 的最快速且最簡單的方式。 本文會在您開始使用時提供內容相關的背景資訊。

開始使用的最佳方式是 遵循快速入門 來建立您的第一個 Python Web 應用程式，並在幾分鐘內使用 azd 範本將其部署至 Azure。 如果您不想設定本機開發環境，您仍然可以改用 GitHub Codespaces 來遵循快速入門。

什麼是 Python Web azd 範本？

令人敬畏的 AZD 範本資源庫提供許多azd範本。 不過，這個 Python Web azd 範本集合是獨一無二的，因為它們提供範例 Web 應用程式，其功能同位在 Azure 資源和 Python Web 架構的許多不同熱門組合之間。

當您執行 Python Web azd 範本時，您將：

  • 建立入門應用程式 - 具體而言，是名為 Relecloud 虛構公司的網站。 專案程式代碼針對特定技術堆疊所需的特定 Python 架構和套件，提供許多最佳做法。 範本是應用程式的起點。 您可以視需要新增或移除應用程式邏輯和 Azure 資源。
  • 布建 Azure 資源 - 範本會布建 Azure 資源，以使用 Bicep 作為熱門基礎結構即程式碼工具，來裝載 Web 應用程式和資料庫。 同樣地，如果您需要新增更多 Azure 服務，請 修改 Bicep 範本 。
  • 將入門應用程式部署至新布建的 Azure 資源 - 入門應用程式會自動部署，讓您可以在幾分鐘內看到應用程式全部運作，並決定您想要修改的專案。
  • 選擇性：設定 GitHub 存放庫和 CI/CD 管線 - 如果您想要的話，範本包含邏輯來為您設定 GitHub 存放庫，包括 GitHub Actions CI/CD 管線。 在幾分鐘內，您就能夠變更 Web 專案程式代碼。 當您將這些變更合併至 GitHub 存放庫的主要 分支時，CI/CD 管線會將這些變更發佈至新的 Azure 主控環境。

神秘 適合嗎？

範本供想要開始建置以 Azure 部署為目標的新 Python Web 應用程式的經驗 Python Web 開發人員使用。

我為什麼要使用這個？

azd使用範本提供數個優點：

  • 最快速的開始 - 透過本機開發環境和裝載環境設定的方式，您可以在幾分鐘內專注於建置應用程式。
  • 最簡單的啟動 - 只要執行幾個命令行指示，即可建置整個本機開發、裝載和部署環境。 工作流程很容易使用且容易記住。
  • 以最佳做法 為基礎建置 - 每個範本都是由 Python 在 Azure 業界資深人士上建置和維護。 請遵循其設計方法新增程序代碼，以建置在堅實的基礎之上。

範本的索引

下表列出可用的 Python Web azd 範本 Monikers，以搭配 azd init 命令使用、每個範本中實作的技術，以及如果您想要參與變更，則為 GitHub 存放庫的連結。

範本 Web Framework Database 裝載平臺 GitHub 存放庫
azure-django-postgres-flexible-aca Django PostgreSQL 彈性伺服器 Azure 容器應用程式 repo
azure-django-postgres-flexible-appservice Django PostgreSQL 彈性伺服器 Azure App Service repo
azure-django-cosmos-postgres-aca Django Cosmos DB （PostgreSQL 配接器） Azure 容器應用程式 repo
azure-django-cosmos-postgres-appservice Django Cosmos DB （PostgreSQL 配接器） Azure App Service repo
azure-django-postgres-addon-aca Django Azure Container Apps PostgreSQL 附加元件 Azure 容器應用程式 repo

範本如何運作？

您可以使用各種 azd 命令來執行範本所 azd 定義的工作。 這些命令會在開始使用 Azure 開發人員 CLI 中詳細說明。

此 azd 範本包含 GitHub 存放庫，其中包含使用熱門 Web 架構的應用程式程式碼（Python 程式代碼）和基礎結構即程式代碼 （即 Bicep） 檔案，以建立 Azure 資源。 它也包含使用 CI/CD 管線設定 GitHub 存放庫所需的設定。

快速入門會逐步引導您完成使用特定 azd 範本的步驟。 它只需要您將五個命令行指示執行至實際執行裝載環境，以及本機開發環境：

  1. azd init --template <template name> - 從範本建立新專案，並在本機計算機上建立應用程式程式代碼的複本。 命令會提示您提供環境名稱（例如 “myapp”），做為已部署資源的命名前置詞。
  2. azd auth login - 將您登入 Azure。 命令會開啟瀏覽器視窗，您可以在其中登入 Azure。 登入之後，瀏覽器視窗會關閉並完成命令。 azd auth login只有在每次會話使用 Azure 開發人員 CLI 時azd，才需要命令。
  3. azd up - 布建雲端資源，並將應用程式部署至這些資源。
  4. azd deploy - 將應用程式原始碼的變更部署到已布建的資源 azd up。
  5. azd down - 如果使用 Azure 資源和 CI/CD 管線，則會將其刪除。

提示

觀看輸出以取得 azd 您需要回答的提示。 例如，在執行 azd up 命令之後，如果屬於多個訂用帳戶，系統可能會提示您選取訂用帳戶。 此外，系統會提示您選取區域。 您可以編輯儲存在 範本 /.azure/ 資料夾中的環境變數，以變更提示的解答。

範本完成後，您有原始範本的個人複本，您可以視需要修改每個檔案。 您至少可以修改 Python 專案程式代碼，讓專案具有您的設計和應用程式邏輯。 如果您需要變更 Azure 資源，您也可以 修改基礎結構即程式代碼組態 。 請參閱標題為 我可以編輯或刪除哪些內容一節？

選擇性：修改和重新布建 Azure 資源

如果您想要變更布建的 Azure 資源，您可以在 範本中編輯適當的 Bicep 檔案 ，並使用：

  1. azd provision - 將 Azure 資源重新布建至 Bicep 檔案中所定義的所需狀態。

設定 CI/CD 管線

Azure 開發人員 CLI （azd） 可讓您輕鬆地為新的 Python Web 應用程式設定 CI/CD 管線。 每次您將認可或提取要求合併到主要分支時，CI/CD 管線會自動建置併發佈您的 Azure 資源變更。

選擇性：自動設定 GitHub Actions CI/CD 管線

如果您想要實作 GitHub Actions CI/CD 管線功能，請使用下列命令：

  1. azd pipeline config - 可讓您指定 GitHub 存放庫和設定，以啟用 CI\CD 管線。 設定之後，每次將程式代碼變更合併至 存放庫的主要 分支時，管線就會將變更部署到您布建的 Azure 服務。

我的其他選項為何？

如果您不想使用 azd 範本，您可以將 Python 應用程式部署至 Azure，並以多種方式建立 Azure 資源。

您可以使用下列其中一個工具來完成許多資源建立和部署步驟：

或者，如果您要尋找具有 Python Web 開發架構的端對端教學課程，請參閱：

我是否必須使用開發容器？

否。 根據預設，Python Web azd 範本會使用 開發容器 。 開發容器提供許多優點，但需要一些必要條件知識和軟體。 如果您不想使用開發容器，而偏好改用本機開發環境，請參閱 範例應用程式根目錄中的 README.md 檔案，以取得環境設定指示。

我可以編輯或刪除哪些專案？

每個 azd 範本的內容可能會因項目類型和所採用的基礎技術堆疊而有所不同。 本文所列的範本遵循一般慣例：

資料夾/檔案 目的 描述
/ 根目錄 根目錄包含許多不同類型的檔案和資料夾，以供許多不同的用途使用。
/。蔚藍 azd 組態檔 包含 Azure 開發人員 CLI （azd） 命令所使用的環境變數。 執行 命令之後，就會建立此 azd init 資料夾。 您可以變更環境變數的值，以自訂應用程式和 Azure 資源。 如需詳細資訊，請參閱 環境特定的 .env 檔案。
/.devcontainer 開發容器組態檔 開發容器 可讓您建立容器型開發環境，其中包含Visual StudioCode內軟體開發所需的所有資源。
.github/ GitHub Actions 設定 包含選擇性 GitHub Actions CI/CD 管線的組態設定，以及 Linting 和 test。 如果您不想使用 azd pipeline config 命令設定 GitHub Actions 管線，則可以修改或刪除 azure-dev.yaml 檔案。
/infra Bicep 檔案 Bicep 可讓您宣告您想要部署至環境的 Azure 資源。 您應該只修改 main.bicep 和 web.bicep 檔案。 請參閱快速入門：使用 Bicep 調整使用 Python Web 範本部署azd的服務。
src/ 入門專案程式代碼檔案 包含 Web 架構、靜態檔案、程式代碼邏輯和數據模型、等等 requirements.txt的 .py 檔案所需的任何範本。 特定檔案取決於 Web 架構、數據存取架構等等。 您可以修改這些檔案，以符合您的專案需求。
/.cruft.json 範本產生檔案 在內部用來產生 azd 範本。 您可以安全地刪除此檔案。
/.gitattributes git 屬性 提供 git 關於處理檔案和資料夾的重要組態。 您可以視需要修改此檔案。
/.gitignore git ignore 告知 git 忽略存放庫中的檔案和資料夾。 您可以視需要修改此檔案。
/azure.yaml azd 組態檔 包含用來宣告要部署哪些服務和專案資料夾的組態設定 azd up 。 這個檔案不得刪除。
/*。Md Markdown 檔案 有數個 Markdown 檔案有不同的用途。 您可以安全地刪除這些檔案。
/docker-compose.yml Docker compose 在應用程式部署至 Azure 之前，先建立應用程式的容器套件。
/pyproject.toml Python 建置系統 包含 Python 專案的建置系統需求。 您可以將此檔案修改為包含您慣用的工具（例如，使用linter和單元測試架構）。
/requirements-dev.in pip 需求檔案 用來使用 pip install -r 命令建立需求的開發環境版本。 您可以視需要修改此檔案以包含其他套件。

提示

使用良好的版本控制做法，讓您能夠回到專案運作的時間點，以防您莫名其妙地中斷某些專案。

常見問題集

問：我在使用 azd 範本時收到錯誤。 我能做什麼?

答：請參閱 針對 Azure 開發人員 CLI 進行疑難解答。 您也可以在個別 azd 範本的 GitHub 存放庫上回報問題。