通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

快速入门：使用 GitHub Actions 部署 Bicep 文件

  • 项目

GitHub Actions 是 GitHub 中用于自动执行软件开发工作流的一套功能。 在本快速入门中，你将使用 GitHub Actions 部署 Azure 资源管理器，以自动将 Bicep 文件部署到 Azure。

本快速入门简要介绍了 GitHub Actions 和 Bicep 文件。 若要了解设置 GitHub Actions 和项目的更详细步骤，请参阅使用 Bicep 和 GitHub Actions 部署 Azure 资源。

先决条件

  • 具有活动订阅的 Azure 帐户。 免费创建帐户。
  • 一个 GitHub 帐户。 如果没有该帐户，请注册免费版。
  • 一个 GitHub 存储库，用于存储 Bicep 文件和工作流文件。 若要创建一个存储库，请参阅创建新存储库。

创建资源组

创建资源组。 稍后在本快速入门中，你要将 Bicep 文件部署到此资源组。

az group create -n exampleRG -l westus

生成部署凭据

GitHub Actions 将在某个标识下运行。 使用 az ad sp create-for-rbac 命令为标识创建服务主体。 为服务主体授予在上一会话中创建的资源组的参与者角色，以便具有该标识的 GitHub 操作可以在此资源组中创建资源。 建议授予所需的最低访问权限。

az ad sp create-for-rbac --name {app-name} --role contributor --scopes /subscriptions/{subscription-id}/resourceGroups/exampleRG --json-auth

请将 {app-name} 占位符替换为应用程序的名称。 将 {subscription-id} 替换为订阅 ID。

输出是一个 JSON 对象，其中包含的角色分配凭据可提供对应用服务应用的访问权限，类似于以下输出。

  {
    "clientId": "<GUID>",
    "clientSecret": "<GUID>",
    "subscriptionId": "<GUID>",
    "tenantId": "<GUID>",
    ...
  }

复制此 JSON 对象供以后使用。 只需具有 clientId、clientSecret、subscriptionId 和 tenantId 值的部分。 确保最后一行末尾没有额外的逗号，例如上一个示例中的 tenantId 行，否则将导致 JSON 文件无效。 部署过程中会出现错误，指出“登录失败并出现错误: 内容不是有效的 JSON 对象。 请仔细检查‘auth-type’是否正确。”

配置 GitHub 机密

为 Azure 凭据、资源组和订阅创建机密。 将在创建工作流部分使用这些机密。

  1. 在 GitHub 中导航到你的存储库。

  2. 选择“设置”>“机密和变量”>“操作”>“新建存储库机密”。

  3. 将 Azure CLI 命令的整个 JSON 输出粘贴到机密的值字段中。 将机密命名为 AZURE_CREDENTIALS。

  4. 创建另一个名为 AZURE_RG 的机密。 将资源组的名称添加到机密的值字段 (exampleRG)。

  5. 创建另一个名为 AZURE_SUBSCRIPTION 的机密。 将订阅 ID 添加到该机密的“值”字段（例如：aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e）。

添加 Bicep 文件

将 Bicep 文件添加到 GitHub 存储库。 以下 Bicep 文件创建存储帐户：

@minLength(3)
@maxLength(11)
param storagePrefix string

@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_RAGRS'
  'Standard_ZRS'
  'Premium_LRS'
  'Premium_ZRS'
  'Standard_GZRS'
  'Standard_RAGZRS'
])
param storageSKU string = 'Standard_LRS'

param location string = resourceGroup().location

var uniqueStorageName = '${storagePrefix}${uniqueString(resourceGroup().id)}'

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: uniqueStorageName
  location: location
  sku: {
    name: storageSKU
  }
  kind: 'StorageV2'
  properties: {
    supportsHttpsTrafficOnly: true
  }
}

output storageEndpoint object = stg.properties.primaryEndpoints

Bicep 文件采用一个名为 storagePrefix 的参数，其中包含 3 到 11 个字符。

你可以将该文件放到存储库中的任何位置。 下一部分中的工作流示例假设 Bicep 文件名为 main.bicep，并存储在存储库的根目录中。

创建工作流

工作流定义了在触发时要执行的步骤。 它是存储库的 .github/workflows/ 路径中的一个 YAML (.yml) 文件。 工作流文件扩展名可以是“.yml”或“.yaml”。

若要创建工作流，请执行以下步骤：

  1. 在 GitHub 存储库的顶部菜单中，选择“操作”。

  2. 选择“新建工作流”。

  3. 选择“自己设置工作流”。

  4. 如果希望使用“main.yml”以外的其他名称，请重命名工作流文件。 例如：deployBicepFile.yml。

  5. 将 yml 文件的内容替换为以下代码：

    name: Deploy Bicep file
on: [push]
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:

    - name: Checkout code
      uses: actions/checkout@main

    - name: Log into Azure
      uses: azure/login@v1
      with:
        creds: ${{ secrets.AZURE_CREDENTIALS }}

    - name: Deploy Bicep file
      uses: azure/arm-deploy@v1
      with:
        subscriptionId: ${{ secrets.AZURE_SUBSCRIPTION }}
        resourceGroupName: ${{ secrets.AZURE_RG }}
        template: ./main.bicep
        parameters: 'storagePrefix=mystore storageSKU=Standard_LRS'
        failOnStdErr: false

    将 mystore 替换为你自己的存储帐户名称前缀。

    注意

    可以改为在 ARM 部署操作中指定一个 JSON 格式的参数文件（例如：.azuredeploy.parameters.json）。

    工作流文件的第一部分包含：

    • name：工作流的名称。
    • 事件：触发工作流的 GitHub 事件的名称。 当主分支上发生推送事件时，将触发工作流。

  6. 选择“提交更改”。

  7. 选择“直接提交到主分支”。

  8. 选择“提交新文件”（或“提交更改”）。

更新工作流文件或 Bicep 文件会触发工作流。 提交更改后，工作流将立即启动。

检查工作流状态

  1. 选择“操作”选项卡。你将看到列出的“创建 deployBicepFile.yml”工作流。 运行此工作流需要 1-2 分钟。
  2. 选择要打开的工作流，并验证 Status 是否为 Success。

清理资源

不再需要资源组和存储库时，请通过删除资源组和 GitHub 存储库来清理部署的资源。

az group delete --name exampleRG

后续步骤

Bicep 文件结构和语法