使用 Azure Pipelines 生成 Python Web 应用并将其部署到 Azure 应用服务

配置自托管代理

自承载生成代理不支持下载 Python 版本。 若要使用自己的自承载代理，需要将代理配置为运行 Python。

为了避免兼容性问题，请将 Python 版本与 Azure 应用服务 Web 应用中的运行时版本匹配， 3.11 在本例中。 必须预安装 Python 版本。 使用完整的安装程序来获取与 pip 兼容的 Python 版本。

需要将所需的 Python 版本添加到自承载代理上的工具缓存中，以便管道任务可以使用它。 通常，工具缓存位于代理的 _work/_tool 目录中。 或者，可以使用环境变量 AGENT_TOOLSDIRECTORY替代路径。 在工具目录下，基于 Python 版本创建以下目录结构：

$AGENT_TOOLSDIRECTORY/
    Python/
        {version number}/
            {platform}/
                {tool files}
            {platform}.complete

版本号应遵循 1.2.3 格式。 平台应为 x86 或 x64。 工具文件应为解压缩的 Python 版本文件。 {platform}.complete 应为一个 0 字节文件，它类似 x86.complete 或 x64.complete 且仅表示该工具已正确安装在缓存中。

例如，若要在 64 位 Windows 计算机上使用 Python 3.11，请创建以下目录结构：

$AGENT_TOOLSDIRECTORY/
    Python/
        3.11.4/
            x64/
                {python files}
            x64.complete

如果托管代理的计算机已有要使用的 Python 版本，则可以将文件复制到工具缓存。 如果没有该 Python 版本，则可从 Python 网站下载它。

创建服务主体

服务主体是为应用程序、托管服务和自动化工具创建的标识，用于访问 Azure 资源。 此访问权限仅限于分配给服务主体的角色，从而可以控制可在哪个级别访问哪些资源。

若要创建服务主体，请在 Bash Cloud Shell 中运行以下命令。 替换为 <service-principal-name> 服务主体的名称、 <your-subscription-id> Azure 订阅 ID 以及 <your-resource-group> Web 应用的资源组。

az ad sp create-for-rbac --display-name <service-principal-name> --role contributor --scopes /subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>

该命令返回以下 JSON 对象：

{
  "appId": "<client GUID>",
  "displayName": "<service-principal-name">,
  "password": "<password-string>",
  "tenant": "<tenant GUID>"
  ...
}

记下用于在下一部分中创建服务连接的值appIdpassword和tenantId值。

1. 在 Azure DevOps 项目页上，选择 “项目设置”。

2. 在 “项目设置”中，选择 “管道>服务连接”。

3. 在 “服务连接 ”页上，如果此服务连接是项目中的第一个连接，请选择“ 新建服务连接 ”或 “创建服务连接 ”。

   

4. 在 “新建服务连接 ”屏幕上，选择 “Azure 资源管理器 ”，然后选择“ 下一步”。

   

5. 在 “新建 Azure 服务连接 ”屏幕上，选择 标识类型。 此示例使用建议的应用注册（自动）。 有关身份验证方法的详细信息，请参阅使用 Azure 资源管理器服务连接以连接到 Azure。

6. 对于凭据，请选择“工作负荷标识联合”（自动）。

7. 填写以下字段：

   • 范围级别：选择 订阅。
   • 订阅：选择 Azure 订阅。
   • 资源组：选择包含 Web 应用的资源组。
   • 服务连接名称：输入连接的描述性名称。
   • 向所有管道授予访问权限：选中此复选框可授予对项目中所有管道的访问权限。

8. 选择保存。

   

1. 在 Azure DevOps 项目页上，选择 “项目设置”。

2. 在 “项目设置”中，选择 “管道>服务连接”。

3. 在 “服务连接 ”页上，如果此服务连接是项目中的第一个连接，请选择“ 新建服务连接 ”或 “创建服务连接 ”。

   

4. 在 “新建服务连接 ”屏幕上，选择 “Azure 资源管理器 ”，然后选择“ 下一步”。

   

5. 选择 “服务主体”（手动）， 然后选择“ 下一步”。

   

6. 在 “新建 Azure 服务连接 ”屏幕上，完成以下字段：

   • 环境：选择 Azure 云。
   • 范围级别：选择 订阅。
   • 订阅 ID：输入 Azure 订阅 ID。
   • 订阅名称：输入 Azure 订阅名称。

7. 在 “身份验证 ”部分中，完成以下字段：

   • 服务主体 ID：输入 appId 命令返回 az ad sp create-for-rbac 的值。
   • 凭据：选择 服务主体密钥。
   • 服务主体密钥：输入 password 命令返回 az ad sp create-for-rbac 的值。
   • 租户 ID：输入 tenant 命令返回 az ad sp create-for-rbac 的值。
   • 选择验证以验证此连接。

8. 在“ 详细信息 ”部分的 “服务连接名称”下，输入服务连接的名称。

9. 选中复选框，以 授予对所有管道的访问权限。

10. 选择验证并保存。

    

1. 在项目的左侧导航菜单上，选择 “管道”。

2. 在 “管道 ”页上，选择“ 新建管道”，如果此管道是项目中的第一个管道，则 选择“创建管道 ”。

   

3. 在 代码屏幕的“位置” 上，选择 “GitHub”。 系统可能会提示你登录 GitHub。

   

4. 在 “选择存储库 ”屏幕上，选择分叉示例存储库。 GitHub 可能会提示你再次输入 GitHub 密码，或安装 Azure Pipelines GitHub 应用。 按照屏幕上的说明安装应用。 有关详细信息，请参阅 GitHub 应用身份验证。

   

5. 在 “配置管道 ”页上，选择 Python 到 Azure 上的 Linux Web 应用。

6. 在下一个屏幕上，选择 Azure 订阅，然后选择 “继续”。

7. 在下一个屏幕上，选择 Azure Web 应用，然后选择 “验证并配置”。

Azure Pipelines 创建一个 azure-pipelines.yml 文件，并将其显示在 YAML 管道编辑器中。

1. 在项目的左侧导航菜单上，选择 “管道”。

2. 在 “管道 ”页上，选择“ 新建管道”，如果此管道是项目中的第一个管道，则 选择“创建管道 ”。

   

3. 在 代码页的“位置” 上，选择 “GitHub Enterprise Server”。 系统可能会提示你登录 GitHub。

   

4. 在 “选择存储库 ”选项卡上，选择分支示例存储库。 GitHub 可能会提示你再次输入 GitHub 密码，或安装 Azure Pipelines GitHub 扩展或应用。 按照屏幕上的说明安装应用。 有关详细信息，请参阅访问 GitHub 存储库。

   

5. 在 “配置管道 ”页上，选择 “初学者管道”。

6. 在 “查看管道 YAML ”页上，将初学者 azure-pipelines.yml 文件的内容替换为以下 YAML 管道文件。 在 YAML 文件中：

   • 将 <your-service-connection-name> 和 <your-web-app-name> 占位符替换为你自己的值。

   • 替换为 <your-pool-name> 要使用的代理池的名称，并替换为 <your-python-version> 代理上运行的 Python 版本。 此版本应与命令的 runtime_version JSON 输出匹配az webapp up。

下面的完整示例 YAML 管道文件将 CI/CD 管道定义为一系列 阶段、 作业和 步骤，其中每个步骤都包含不同 任务 和 脚本的详细信息。 生成的 YAML 代码会自动使用应用和连接的值填充占位符。

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<GUID>'

  # Web app name
  webAppName: '<your-webapp-name>'

  # Agent VM image name
  vmImageName: 'ubuntu-latest'

  # Environment name
  environmentName: '<your-webapp-name>'

  # Project root folder. Point to the folder containing manage.py file.
  projectRoot: $(System.DefaultWorkingDirectory)

  pythonVersion: '3.11'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
    pool:
      vmImage: $(vmImageName)
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install setuptools
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - upload: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
      displayName: 'Upload package'
      artifact: drop

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : $(webAppName)'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip

trigger:
- main

variables:
  # Azure Resource Manager connection created during pipeline creation
  azureServiceConnectionId: '<your-service-connection-name>'

  # Web app name
  webAppName: '<your-web-app-name>'

  # Environment name
  environmentName: '<your-web-app-name>'

  # Project root folder. 
  projectRoot: $(System.DefaultWorkingDirectory)

  # Python version: 
  pythonVersion: '<your-python-version>'

stages:
- stage: Build
  displayName: Build stage
  jobs:
  - job: BuildJob
pool:
      name: '<your-pool-name>'
      demands: python
    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '$(pythonVersion)'
      displayName: 'Use Python $(pythonVersion)'

    - script: |
        python -m venv antenv
        source antenv/bin/activate
        python -m pip install --upgrade pip
        pip install -r requirements.txt
      workingDirectory: $(projectRoot)
      displayName: "Install requirements"

    - task: ArchiveFiles@2
      displayName: 'Archive files'
      inputs:
        rootFolderOrFile: '$(projectRoot)'
        includeRootFolder: false
        archiveType: zip
        archiveFile: $(Build.ArtifactStagingDirectory)/$(Build.BuildId).zip
        replaceExistingArchive: true

    - task: PublishBuildArtifacts@1
      inputs:
        PathtoPublish: '$(Build.ArtifactStagingDirectory)'
        ArtifactName: 'drop'
        publishLocation: 'Container'

- stage: Deploy
  displayName: 'Deploy Web App'
  dependsOn: Build
  condition: succeeded()
  jobs:
  - deployment: DeploymentJob
    pool:
      name: '<your-pool-name'
    environment: $(environmentName)
    strategy:
      runOnce:
        deploy:
          steps:

          - task: UsePythonVersion@0
            inputs:
              versionSpec: '$(pythonVersion)'
            displayName: 'Use Python version'

          - task: AzureWebApp@1
            displayName: 'Deploy Azure Web App : <your-web-app-name>'
            inputs:
              azureSubscription: $(azureServiceConnectionId)
              appName: $(webAppName)
              package: $(Pipeline.Workspace)/drop/$(Build.BuildId).zip
              startUpCommand: 'startup.txt'

生成阶段包含一个作业，该作业在变量中vmImageName定义的作系统上运行，在本例中。ubuntu-latest

  - job: BuildJob
    pool:
      vmImage: $(vmImageName)

生成阶段包含一个作业，该作业在由参数标识pool的name代理上运行。

可使用 demands 关键字指定代理功能。 例如，demands: python 指定代理必须已安装 Python。 若要按名称指定自承载代理，可以使用 demands: Agent.Name -equals <agent-name>。

  - job: BuildJob
    pool:
      name: <your-pool-name>
      demands: python

  - deployment: DeploymentJob
    pool:
      vmImage: $(vmImageName)
    environment: $(environmentName)

• 关键字deployment指示作业是面向要部署到的环境的部署作业。 environment运行作业时，会自动在项目中创建该作业。

• 此参数 pool 指定部署代理池，如果未 name 指定默认代理池，则使用默认代理池。 代理在变量中vmImageName定义的作系统上运行，在本例中。ubuntu-latest

  - deployment: DeploymentJob
    pool:
      name: <your-pool-name>
    environment: $(environmentName)

• 关键字deployment指示作业是面向要部署到的环境的部署作业。 environment运行作业时，会自动在项目中创建该作业。

• 该 pool 参数指定部署代理池，并且必须包含一个代理，该代理能够运行管道中指定的 Python 版本。