練習 - 搭配多個環境使用 Bicep 參數

已完成

現在您的管線已部署至這兩個環境，接下來即可與第三方 API 整合以進行產品檢閱。

您的網站小組已提供網站應該用來存取服務的 API 金鑰和 URL。 針對測試與實際執行環境使用不同的值。 在此單元中，您將更新管線，以使用產品檢閱 API 的正確設定來設定每個環境。

在此過程中，您將會：

• 為每個環境建立變數群組。
• 更新管線，使其為每個環境挑選正確的變數群組，而不是使用範本參數。
• 更新 Bicep 檔案，以傳播產品檢閱 API 所需的設定。
• 更新變數群組和管線，以設定產品檢閱 API 設定的值。
• 檢閱管線結果以及對 Azure 環境的變更。

新增變數群組

由於您想要新增更多隨著個別環境而不同的參數，您決定不要直接將管線參數新增至管線 YAML 檔案中。 您將使用變數群組將每個環境的值保存在一起。

1. 在您的瀏覽器中，移至 [管線] > [程式庫]。

   

2. 選取 [+ 變數群組] 按鈕。

   

3. 輸入 ToyWebsiteTest 作為變數群組名稱。

4. 選取 [+ 新增] 按鈕，將變數新增至變數群組。 使用下列設定建立兩個變數：

   名稱	值
   EnvironmentType	Test
   resourceGroupName	ToyWebsiteTest

   請注意，您不會在變數群組中定義服務連線名稱。 服務連線名稱會有特殊規則說明如何加以指定。 在此課程模組中，您將使用管線範本參數。

   

5. 選取儲存。

6. 選取瀏覽器中的 [上一頁] 按鈕，以返回變數群組清單。

7. 新增名為 ToyWebsiteProduction 的另一個變數群組。 使用下列設定建立兩個變數：

   名稱	值
   EnvironmentType	生產環境
   resourceGroupName	ToyWebsiteProduction

   

   請注意，兩個環境的變數名稱是相同的，但值不同。

8. 儲存生產變數群組。

更新部署管線範本以使用變數群組

1. 在 Visual Studio Code 中，開啟 deploy.yml 檔案。

2. 在檔案頂端，移除 resourceGroupName 和 serviceConnectionName 參數。 請勿刪除 environmentType 或 deploymentDefaultLocation 參數。

   parameters:
   - name: environmentType
     type: string
   - name: deploymentDefaultLocation
     type: string
     default: westus3
   

3. 更新 ValidateBicepCode 作業以匯入變數群組：

   - ${{ if ne(parameters.environmentType, 'Production') }}:
     - stage: Validate_${{parameters.environmentType}}
       displayName: Validate (${{parameters.environmentType}} Environment)
       jobs:
       - job: ValidateBicepCode
         displayName: Validate Bicep code
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
   

4. 更新 ValidateBicepCode 作業，以根據 environmentType 參數值自動推斷服務連線名稱：

   - ${{ if ne(parameters.environmentType, 'Production') }}:
     - stage: Validate_${{parameters.environmentType}}
       displayName: Validate (${{parameters.environmentType}} Environment)
       jobs:
       - job: ValidateBicepCode
         displayName: Validate Bicep code
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureResourceManagerTemplateDeployment@3
             name: RunPreflightValidation
             displayName: Run preflight validation
             inputs:
               connectedServiceName: ToyWebsite${{parameters.environmentType}}
               location: ${{parameters.deploymentDefaultLocation}}
               deploymentMode: Validation
               resourceGroupName: $(ResourceGroupName)
               csmFile: deploy/main.bicep
               overrideParameters: >
                 -environmentType $(EnvironmentType)
   

5. 更新 ValidateBicepCode 作業，以使用匯入的變數群組來設定部署工作的資源群組名稱和環境型別引數：

   - ${{ if ne(parameters.environmentType, 'Production') }}:
     - stage: Validate_${{parameters.environmentType}}
       displayName: Validate (${{parameters.environmentType}} Environment)
       jobs:
       - job: ValidateBicepCode
         displayName: Validate Bicep code
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureResourceManagerTemplateDeployment@3
             name: RunPreflightValidation
             displayName: Run preflight validation
             inputs:
               connectedServiceName: ToyWebsite${{parameters.environmentType}}
               location: ${{parameters.deploymentDefaultLocation}}
               deploymentMode: Validation
               resourceGroupName: $(ResourceGroupName)
               csmFile: deploy/main.bicep
               overrideParameters: >
                 -environmentType $(EnvironmentType)
   

6. 對 PreviewAzureChanges 作業進行變更：

   - ${{ if eq(parameters.environmentType, 'Production') }}:
     - stage: Preview_${{parameters.environmentType}}
       displayName: Preview (${{parameters.environmentType}} Environment)
       jobs:
       - job: PreviewAzureChanges
         displayName: Preview Azure changes
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureCLI@2
             name: RunWhatIf
             displayName: Run what-if
             inputs:
               azureSubscription: ToyWebsite${{parameters.environmentType}}
               scriptType: 'bash'
               scriptLocation: 'inlineScript'
               inlineScript: |
                 az deployment group what-if \
                   --resource-group $(ResourceGroupName) \
                   --template-file deploy/main.bicep \
                   --parameters environmentType=$(EnvironmentType)
   

7. 對 Deploy 部署作業進行相同的變更：

   - stage: Deploy_${{parameters.environmentType}}
     displayName: Deploy (${{parameters.environmentType}} Environment)
     jobs:
     - deployment: DeployWebsite
       displayName: Deploy website
       variables:
       - group: ToyWebsite${{parameters.environmentType}}
       environment: ${{parameters.environmentType}}
       strategy:
         runOnce:
           deploy:
             steps:
               - checkout: self
   
               - task: AzureResourceManagerTemplateDeployment@3
                 name: DeployBicepFile
                 displayName: Deploy Bicep file
                 inputs:
                   connectedServiceName: ToyWebsite${{parameters.environmentType}}
                   deploymentName: $(Build.BuildNumber)
                   location: ${{parameters.deploymentDefaultLocation}}
                   resourceGroupName: $(ResourceGroupName)
                   csmFile: deploy/main.bicep
                   overrideParameters: >
                     -environmentType $(EnvironmentType)
                   deploymentOutputs: deploymentOutputs
   

8. 確認 deploy.yml 檔案現在看起來如同下列程式碼：

   parameters:
   - name: environmentType
     type: string
   - name: deploymentDefaultLocation
     type: string
     default: westus3
   
   stages:
   
   - ${{ if ne(parameters.environmentType, 'Production') }}:
     - stage: Validate_${{parameters.environmentType}}
       displayName: Validate (${{parameters.environmentType}} Environment)
       jobs:
       - job: ValidateBicepCode
         displayName: Validate Bicep code
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureResourceManagerTemplateDeployment@3
             name: RunPreflightValidation
             displayName: Run preflight validation
             inputs:
               connectedServiceName: ToyWebsite${{parameters.environmentType}}
               location: ${{parameters.deploymentDefaultLocation}}
               deploymentMode: Validation
               resourceGroupName: $(ResourceGroupName)
               csmFile: deploy/main.bicep
               overrideParameters: >
                 -environmentType $(EnvironmentType)
   
   - ${{ if eq(parameters.environmentType, 'Production') }}:
     - stage: Preview_${{parameters.environmentType}}
       displayName: Preview (${{parameters.environmentType}} Environment)
       jobs:
       - job: PreviewAzureChanges
         displayName: Preview Azure changes
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureCLI@2
             name: RunWhatIf
             displayName: Run what-if
             inputs:
               azureSubscription: ToyWebsite${{parameters.environmentType}}
               scriptType: 'bash'
               scriptLocation: 'inlineScript'
               inlineScript: |
                 az deployment group what-if \
                   --resource-group $(ResourceGroupName) \
                   --template-file deploy/main.bicep \
                   --parameters environmentType=$(EnvironmentType)
   
   - stage: Deploy_${{parameters.environmentType}}
     displayName: Deploy (${{parameters.environmentType}} Environment)
     jobs:
     - deployment: DeployWebsite
       displayName: Deploy website
       variables:
       - group: ToyWebsite${{parameters.environmentType}}
       environment: ${{parameters.environmentType}}
       strategy:
         runOnce:
           deploy:
             steps:
               - checkout: self
   
               - task: AzureResourceManagerTemplateDeployment@3
                 name: DeployBicepFile
                 displayName: Deploy Bicep file
                 inputs:
                   connectedServiceName: ToyWebsite${{parameters.environmentType}}
                   deploymentName: $(Build.BuildNumber)
                   location: ${{parameters.deploymentDefaultLocation}}
                   resourceGroupName: $(ResourceGroupName)
                   csmFile: deploy/main.bicep
                   overrideParameters: >
                     -environmentType $(EnvironmentType)
                   deploymentOutputs: deploymentOutputs
   
               - bash: |
                   echo "##vso[task.setvariable variable=appServiceAppHostName;isOutput=true]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppHostName.value')"
                 name: SaveDeploymentOutputs
                 displayName: Save deployment outputs into variables
                 env:
                   DEPLOYMENT_OUTPUTS: $(deploymentOutputs)
   
   - stage: SmokeTest_${{parameters.environmentType}}
     displayName: Smoke Test (${{parameters.environmentType}} Environment)
     jobs:
     - job: SmokeTest
       displayName: Smoke test
       variables:
         appServiceAppHostName: $[ stageDependencies.Deploy_${{parameters.environmentType}}.DeployWebsite.outputs['DeployWebsite.SaveDeploymentOutputs.appServiceAppHostName'] ]
       steps:
         - task: PowerShell@2
           name: RunSmokeTests
           displayName: Run smoke tests
           inputs:
             targetType: inline
             script: |
               $container = New-PesterContainer `
                 -Path 'deploy/Website.Tests.ps1' `
                 -Data @{ HostName = '$(appServiceAppHostName)' }
               Invoke-Pester `
                 -Container $container `
                 -CI
   
         - task: PublishTestResults@2
           name: PublishTestResults
           displayName: Publish test results
           condition: always()
           inputs:
             testResultsFormat: NUnit
             testResultsFiles: 'testResults.xml'
   

9. 儲存對檔案所做的變更。

更新管線定義以簡化參數清單

1. 開啟 azure-pipelines.yml 檔案。

2. 更新使用範本的階段以移除 resourceGroupName 和 serviceConnectionName 參數。 僅保留 environmentType 參數。

   trigger:
     batch: true
     branches:
       include:
       - main
   
   pool:
     vmImage: ubuntu-latest
   
   stages:
   
   # Lint the Bicep file.
   - stage: Lint
     jobs: 
     - template: pipeline-templates/lint.yml
   
   # Deploy to the test environment.
   - template: pipeline-templates/deploy.yml
     parameters:
       environmentType: Test
   
   # Deploy to the production environment.
   - template: pipeline-templates/deploy.yml
     parameters:
       environmentType: Production
   

3. 儲存對檔案所做的變更。

4. 使用下列命令，將您的變更認可至 Git 存放庫，而不加以推送：

   git add .
   git commit -m "Use variable groups"
   

更新 Bicep 檔案

1. 開啟 main.bicep 檔案。

2. 在檔案中已有的參數下方，為新的檢閱 API 新增下列參數：

   @description('The URL to the product review API.')
   param reviewApiUrl string
   
   @secure()
   @description('The API key to use when accessing the product review API.')
   param reviewApiKey string
   

3. 更新 appServiceApp 資源定義，為應用程式提供檢閱 API URL 和金鑰，讓網站的程式碼可以使用它們：

   resource appServiceApp 'Microsoft.Web/sites@2022-03-01' = {
     name: appServiceAppName
     location: location
     properties: {
       serverFarmId: appServicePlan.id
       httpsOnly: true
       siteConfig: {
         appSettings: [
           {
             name: 'APPINSIGHTS_INSTRUMENTATIONKEY'
             value: applicationInsights.properties.InstrumentationKey
           }
           {
             name: 'APPLICATIONINSIGHTS_CONNECTION_STRING'
             value: applicationInsights.properties.ConnectionString
           }
           {
             name: 'ReviewApiUrl'
             value: reviewApiUrl
           }
           {
             name: 'ReviewApiKey'
             value: reviewApiKey
           }
         ]
       }
     }
   }
   

4. 儲存對檔案所做的變更。

更新變數群組

1. 在您的瀏覽器中，移至 [管線]>[程式庫]，然後開啟 ToyWebsiteTest 變數群組。

2. 新增下列變數：

   名稱	值
   ReviewApiKey	sandboxsecretkey
   ReviewApiUrl	https://sandbox.contoso.com/reviews

3. 選取 ReviewApiKey 變數旁的掛鎖圖示。 此步驟會指示 Azure Pipelines 安全地處理變數的值。

   

4. 儲存變數群組。

   

5. 更新 ToyWebsiteProduction 變數群組，以新增一組類似的變數：

   名稱	值
   ReviewApiKey	productionsecretkey
   ReviewApiUrl	https://api.contoso.com/reviews

   請記得選取 ReviewApiKey 變數旁的掛鎖圖示。

   

6. 儲存變數群組。

將檢閱 API 變數新增至變數群組

1. 在 Visual Studio Code 中，開啟 deploy.yml 檔案。

2. 在 ValidateBicepCode 作業中，將檢閱 API 參數值新增至部署工作：

   - ${{ if ne(parameters.environmentType, 'Production') }}:
     - stage: Validate_${{parameters.environmentType}}
       displayName: Validate (${{parameters.environmentType}} Environment)
       jobs:
       - job: ValidateBicepCode
         displayName: Validate Bicep code
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureResourceManagerTemplateDeployment@3
             name: RunPreflightValidation
             displayName: Run preflight validation
             inputs:
               connectedServiceName: ToyWebsite${{parameters.environmentType}}
               location: ${{parameters.deploymentDefaultLocation}}
               deploymentMode: Validation
               resourceGroupName: $(ResourceGroupName)
               csmFile: deploy/main.bicep
               overrideParameters: >
                 -environmentType $(EnvironmentType)
                 -reviewApiUrl $(ReviewApiUrl)
                 -reviewApiKey $(ReviewApiKey)
   

3. 對 PreviewAzureChanges 作業進行相同的變更：

   - ${{ if eq(parameters.environmentType, 'Production') }}:
     - stage: Preview_${{parameters.environmentType}}
       displayName: Preview (${{parameters.environmentType}} Environment)
       jobs:
       - job: PreviewAzureChanges
         displayName: Preview Azure changes
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureCLI@2
             name: RunWhatIf
             displayName: Run what-if
             inputs:
               azureSubscription: ToyWebsite${{parameters.environmentType}}
               scriptType: 'bash'
               scriptLocation: 'inlineScript'
               inlineScript: |
                 az deployment group what-if \
                   --resource-group $(ResourceGroupName) \
                   --template-file deploy/main.bicep \
                   --parameters environmentType=$(EnvironmentType) \
                                reviewApiUrl=$(ReviewApiUrl) \
                                reviewApiKey=$(ReviewApiKey)
   

   重要

   務必在設定 environmentType 參數值的行尾以及後續行上新增反斜線 (\)。 \ 字元表示後續幾行是相同 Azure CLI 命令的一部分。

4. 對 Deploy 作業進行相同的變更：

   - stage: Deploy_${{parameters.environmentType}}
     displayName: Deploy (${{parameters.environmentType}} Environment)
     jobs:
     - deployment: DeployWebsite
       displayName: Deploy website
       variables:
       - group: ToyWebsite${{parameters.environmentType}}
       environment: ${{parameters.environmentType}}
       strategy:
         runOnce:
           deploy:
             steps:
               - checkout: self
   
               - task: AzureResourceManagerTemplateDeployment@3
                 name: DeployBicepFile
                 displayName: Deploy Bicep file
                 inputs:
                   connectedServiceName: ToyWebsite${{parameters.environmentType}}
                   deploymentName: $(Build.BuildNumber)
                   location: ${{parameters.deploymentDefaultLocation}}
                   resourceGroupName: $(ResourceGroupName)
                   csmFile: deploy/main.bicep
                   overrideParameters: >
                     -environmentType $(EnvironmentType)
                     -reviewApiUrl $(ReviewApiUrl)
                     -reviewApiKey $(ReviewApiKey)
                   deploymentOutputs: deploymentOutputs
   

5. 確認 deploy.yml 檔案現在看起來如同下列程式碼：

   parameters:
   - name: environmentType
     type: string
   - name: deploymentDefaultLocation
     type: string
     default: westus3
   
   stages:
   
   - ${{ if ne(parameters.environmentType, 'Production') }}:
     - stage: Validate_${{parameters.environmentType}}
       displayName: Validate (${{parameters.environmentType}} Environment)
       jobs:
       - job: ValidateBicepCode
         displayName: Validate Bicep code
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureResourceManagerTemplateDeployment@3
             name: RunPreflightValidation
             displayName: Run preflight validation
             inputs:
               connectedServiceName: ToyWebsite${{parameters.environmentType}}
               location: ${{parameters.deploymentDefaultLocation}}
               deploymentMode: Validation
               resourceGroupName: $(ResourceGroupName)
               csmFile: deploy/main.bicep
               overrideParameters: >
                 -environmentType $(EnvironmentType)
                 -reviewApiUrl $(ReviewApiUrl)
                 -reviewApiKey $(ReviewApiKey)
   
   - ${{ if eq(parameters.environmentType, 'Production') }}:
     - stage: Preview_${{parameters.environmentType}}
       displayName: Preview (${{parameters.environmentType}} Environment)
       jobs:
       - job: PreviewAzureChanges
         displayName: Preview Azure changes
         variables:
         - group: ToyWebsite${{parameters.environmentType}}
         steps:
           - task: AzureCLI@2
             name: RunWhatIf
             displayName: Run what-if
             inputs:
               azureSubscription: ToyWebsite${{parameters.environmentType}}
               scriptType: 'bash'
               scriptLocation: 'inlineScript'
               inlineScript: |
                 az deployment group what-if \
                   --resource-group $(ResourceGroupName) \
                   --template-file deploy/main.bicep \
                   --parameters environmentType=$(EnvironmentType) \
                                reviewApiUrl=$(ReviewApiUrl) \
                                reviewApiKey=$(ReviewApiKey)
   
   - stage: Deploy_${{parameters.environmentType}}
     displayName: Deploy (${{parameters.environmentType}} Environment)
     jobs:
     - deployment: DeployWebsite
       displayName: Deploy website
       variables:
       - group: ToyWebsite${{parameters.environmentType}}
       environment: ${{parameters.environmentType}}
       strategy:
         runOnce:
           deploy:
             steps:
               - checkout: self
   
               - task: AzureResourceManagerTemplateDeployment@3
                 name: DeployBicepFile
                 displayName: Deploy Bicep file
                 inputs:
                   connectedServiceName: ToyWebsite${{parameters.environmentType}}
                   deploymentName: $(Build.BuildNumber)
                   location: ${{parameters.deploymentDefaultLocation}}
                   resourceGroupName: $(ResourceGroupName)
                   csmFile: deploy/main.bicep
                   overrideParameters: >
                     -environmentType $(EnvironmentType)
                     -reviewApiUrl $(ReviewApiUrl)
                     -reviewApiKey $(ReviewApiKey)
                   deploymentOutputs: deploymentOutputs
   
               - bash: |
                   echo "##vso[task.setvariable variable=appServiceAppHostName;isOutput=true]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppHostName.value')"
                 name: SaveDeploymentOutputs
                 displayName: Save deployment outputs into variables
                 env:
                   DEPLOYMENT_OUTPUTS: $(deploymentOutputs)
   
   - stage: SmokeTest_${{parameters.environmentType}}
     displayName: Smoke Test (${{parameters.environmentType}} Environment)
     jobs:
     - job: SmokeTest
       displayName: Smoke test
       variables:
         appServiceAppHostName: $[ stageDependencies.Deploy_${{parameters.environmentType}}.DeployWebsite.outputs['DeployWebsite.SaveDeploymentOutputs.appServiceAppHostName'] ]
       steps:
         - task: PowerShell@2
           name: RunSmokeTests
           displayName: Run smoke tests
           inputs:
             targetType: inline
             script: |
               $container = New-PesterContainer `
                 -Path 'deploy/Website.Tests.ps1' `
                 -Data @{ HostName = '$(appServiceAppHostName)' }
               Invoke-Pester `
                 -Container $container `
                 -CI
   
         - task: PublishTestResults@2
           name: PublishTestResults
           displayName: Publish test results
           condition: always()
           inputs:
             testResultsFormat: NUnit
             testResultsFiles: 'testResults.xml'
   

6. 使用下列命令認可變更，並將其推送至您的 Git 存放庫：

   git add .
   git commit -m "Add new review API settings to Bicep file and pipeline"
   git push
   

檢視部署結果

1. 在您的瀏覽器中，移至 [管線]。

2. 選取管線的最近一次執行。

   等候管線在部署 (實際執行環境) 階段之前暫停。 管線可能需要幾分鐘的時間才會進行到這邊。

3. 如果系統要求您授與存取資源的權限，請選取 [檢視]，然後選取 [允許]。

4. 選取 [檢閱]>[核准]，以核准部署至實際執行環境。

   等候管線執行完成。

5. 選取 [管線]>[環境]。

6. 選取 [生產] 環境。

   請注意，您現在會在環境的歷程記錄中看到多個部署。

7. 在瀏覽器中，移至 Azure 入口網站。

8. 移至 [ToyWebsiteProduction] 資源群組。

9. 在資源清單中，開啟 Azure App Service 應用程式。

   選取設定。

   

10. 選取 [顯示值]。

    

11. 請注意，生產網站的 ReviewApiKey 和 ReviewApiUrl 設定值會設定為您在生產變數群組中設定的值。

    

12. 將目前的值與 ToyWebsiteTest 資源群組中 App Service 應用程式的組態設定比較。 請注意，這些值都不同。

清除資源

既然您已完成練習，您可以移除資源，以免產生費用。

在 Visual Studio Code 終端中，執行下列命令：

az group delete --resource-group ToyWebsiteTest --yes --no-wait
az group delete --resource-group ToyWebsiteProduction --yes --no-wait

資源群組會在背景中刪除。

Remove-AzResourceGroup -Name ToyWebsiteTest -Force
Remove-AzResourceGroup -Name ToyWebsiteProduction -Force