Exercise - Seed a storage account and database

  • 14 minutes

You updated your pipeline to build and deploy your website's application to the Azure App Service app defined in your Bicep file. But the smoke test stage is failing because the database isn't working yet. In this unit, you deploy a new Azure SQL logical server and database, and configure your pipeline to build and deploy the database's schema. You also update your pipeline to add some sample product data for your test environment so that your team can try out the website.

In the process, you do the following tasks:

  • Add a blob container to the Azure storage account.
  • Add an Azure SQL logical server and database.
  • Update the build stage to build the database project into a DACPAC file.
  • Add new variables to your variable group for the Azure SQL logical server and database.
  • Update your deployment stages to use the new variables as parameter values.
  • Add new pipeline steps to deploy your DACPAC file.
  • Run the pipeline and view the website.

Add a storage container

Your Bicep file already defines a storage account, but it doesn't define a blob container. Here, you add a blob container to your Bicep file. You also provide the name of the storage account and blob container to the application by using its configuration settings. That way, the app knows which storage account to access.

  1. In Visual Studio Code, open the main.bicep file in the deploy folder.

  2. Below the variables that define resource names (near Line 27), add a new variable definition for the blob storage container's name:

    var storageAccountImagesBlobContainerName = 'toyimages'

  3. Update the storageAccount resource to define the blob container:

    resource storageAccount 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: storageAccountName
  location: location
  kind: 'StorageV2'
  sku: environmentConfigurationMap[environmentType].storageAccount.sku

  resource blobService 'blobServices' = {
    name: 'default'

    resource storageAccountImagesBlobContainer 'containers' = {
      name: storageAccountImagesBlobContainerName

      properties: {
        publicAccess: 'Blob'
      }
    }
  }
}

  4. Update the app's appSettings property to add three new application settings for the storage account name, blob endpoint, and blob container name:

    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
        }
        {
          name: 'StorageAccountName'
          value: storageAccount.name
        }
        {
          name: 'StorageAccountBlobEndpoint'
          value: storageAccount.properties.primaryEndpoints.blob
        }
        {
          name: 'StorageAccountImagesContainerName'
          value: storageAccount::blobService::storageAccountImagesBlobContainer.name
        }
      ]
    }
  }
}

  5. At the end of the file, add new outputs to expose the names of the storage account and blob container:

    output storageAccountName string = storageAccount.name
output storageAccountImagesBlobContainerName string = storageAccount::blobService::storageAccountImagesBlobContainer.name

  6. Save your changes to the file.

  7. Commit your changes to your Git repository, but don't push them yet. In the Visual Studio Code terminal, run the following commands:

    git add .
git commit -m "Add storage container"

Add an Azure SQL logical server and database

Your Bicep file doesn't currently deploy an Azure SQL logical server or database. In this section, you add these resources to your Bicep file.

  1. In the main.bicep file, add two new parameters below the reviewApiKey parameter:

    @description('The administrator login username for the SQL server.')
param sqlServerAdministratorLogin string

@secure()
@description('The administrator login password for the SQL server.')
param sqlServerAdministratorLoginPassword string

  2. Below the variables that define resource names, add new variables to define the names of your Azure SQL logical server and database:

    var sqlServerName = 'toy-website-${resourceNameSuffix}'
var sqlDatabaseName = 'Toys'

  3. Below the variables you just added, define a new variable that creates a connection string for the application to access the database:

    // Define the connection string to access Azure SQL.
var sqlDatabaseConnectionString = 'Server=tcp:${sqlServer.properties.fullyQualifiedDomainName},1433;Initial Catalog=${sqlDatabase.name};Persist Security Info=False;User ID=${sqlServerAdministratorLogin};Password=${sqlServerAdministratorLoginPassword};MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;'

    Note

    For simplicity, the application uses the administrator login and password to access the database. This isn't good practice for a production solution, though. It's better to use an App Service managed identity to access the database, and grant the managed identity the minimum permissions needed by the application. We link to more information on the Summary page.

  4. Near the end of the file, above the outputs, add the Azure SQL logical server and database resources:

    resource sqlServer 'Microsoft.Sql/servers@2022-05-01-preview' = {
  name: sqlServerName
  location: location
  properties: {
    administratorLogin: sqlServerAdministratorLogin
    administratorLoginPassword: sqlServerAdministratorLoginPassword
  }
}

resource sqlServerFirewallRule 'Microsoft.Sql/servers/firewallRules@2022-05-01-preview' = {
  parent: sqlServer
  name: 'AllowAllWindowsAzureIps'
  properties: {
    endIpAddress: '0.0.0.0'
    startIpAddress: '0.0.0.0'
  }
}

resource sqlDatabase 'Microsoft.Sql/servers/databases@2022-05-01-preview' = {
  parent: sqlServer
  name: sqlDatabaseName
  location: location
  sku: environmentConfigurationMap[environmentType].sqlDatabase.sku
}

  5. Update the environmentConfigurationMap variable to define the sku values to use for your database for each environment:

    var environmentConfigurationMap = {
  Production: {
    appServicePlan: {
      sku: {
        name: 'S1'
        capacity: 1
      }
    }
    storageAccount: {
      sku: {
        name: 'Standard_LRS'
      }
    }
    sqlDatabase: {
      sku: {
        name: 'Standard'
        tier: 'Standard'
      }
    }
  }
  Test: {
    appServicePlan: {
      sku: {
        name: 'F1'
      }
    }
    storageAccount: {
      sku: {
        name: 'Standard_GRS'
      }
    }
    sqlDatabase: {
      sku: {
        name: 'Standard'
        tier: 'Standard'
      }
    }
  }
}

  6. Add another app setting to your App Service app for the database connection string:

    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
        }
        {
          name: 'StorageAccountName'
          value: storageAccount.name
        }
        {
          name: 'StorageAccountBlobEndpoint'
          value: storageAccount.properties.primaryEndpoints.blob
        }
        {
          name: 'StorageAccountImagesContainerName'
          value: storageAccount::blobService::storageAccountImagesBlobContainer.name
        }
        {
          name: 'SqlDatabaseConnectionString'
          value: sqlDatabaseConnectionString
        }
      ]
    }
  }
}

  7. At the bottom of the file, add outputs to expose the host name of the Azure SQL logical server and the name of the database:

    output appServiceAppName string = appServiceApp.name
output appServiceAppHostName string = appServiceApp.properties.defaultHostName
output storageAccountName string = storageAccount.name
output storageAccountImagesBlobContainerName string = storageAccount::blobService::storageAccountImagesBlobContainer.name
output sqlServerFullyQualifiedDomainName string = sqlServer.properties.fullyQualifiedDomainName
output sqlDatabaseName string = sqlDatabase.name

  8. Save your changes to the file.

Add new build steps for the database project

Your website developers prepared a Visual Studio database project that deploys and configures your website database table. Here, you update your pipeline Build stage to build the database project into a DACPAC file and publish it as a pipeline artifact.

  1. Open the build.yml file in the deploy/pipeline-templates folder.

  2. To build the Visual Studio database project, copy the generated DACPAC file to a staging folder, and publish it as a pipeline artifact, add the following steps:

    jobs:
- job: Build
  displayName: Build application and database
  pool:
    vmImage: windows-latest

  steps:

  # Build, copy, and publish the website.
  - task: DotNetCoreCLI@2
    displayName: Build publishable website
    inputs:
      command: 'publish'
      publishWebProjects: true

  - task: CopyFiles@2
    displayName: Copy publishable website
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/src/ToyCompany/ToyCompany.Website/bin'
      contents: '**/publish.zip'
      targetFolder: '$(Build.ArtifactStagingDirectory)/website'
      flattenFolders: true

  - task: PublishBuildArtifacts@1
    displayName: Publish website as pipeline artifact
    inputs:
      pathToPublish: '$(Build.ArtifactStagingDirectory)/website'
      artifactName: 'website'

  # Build, copy, and publish the DACPAC file.
  - task: VSBuild@1
    displayName: Build Visual Studio solution
    inputs:
      solution: '$(Build.SourcesDirectory)/src/ToyCompany/ToyCompany.Database/ToyCompany.Database.sqlproj'

  - task: CopyFiles@2
    displayName: Copy DACPAC
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)/src/ToyCompany/ToyCompany.Database/bin'
      contents: '**/*.dacpac'
      targetFolder: '$(Build.ArtifactStagingDirectory)/database'
      flattenFolders: true

  - task: PublishBuildArtifacts@1
    displayName: Publish DACPAC as pipeline artifact
    inputs:
      pathToPublish: '$(Build.ArtifactStagingDirectory)/database'
      artifactName: 'database'

  3. Save your changes to the file.

Add values to the variable groups

  1. In your browser, go to Pipelines > Library.

  2. Select the ToyWebsiteProduction variable group.

    Screenshot of Azure DevOps showing the list of variable groups, with the ToyWebsiteProduction variable group highlighted.

  3. Add the following variables to the variable group:

    Name Value
    SqlServerAdministratorLogin ToyCompanyAdmin
    SqlServerAdministratorLoginPassword SecurePassword!111

  4. Select the padlock icon next to the SqlServerAdministratorLoginPassword variable. This feature tells Azure Pipelines to treat the variable's value securely.

    Screenshot of the production variable group, with the secret variable button highlighted.

  5. Save the variable group.

    Screenshot of the production variable group, with the Save button highlighted.

  6. Repeat the process to add the following variables to the ToyWebsiteTest variable group:

    Name Value
    SqlServerAdministratorLogin TestToyCompanyAdmin
    SqlServerAdministratorLoginPassword SecurePassword!999

    Remember to select the padlock icon next to the SqlServerAdministratorLoginPassword variable and save the variable group.

Add parameter values to the Validate and Preview stages

The Bicep file now has two new mandatory parameters: sqlServerAdministratorLogin and sqlServerAdministratorLoginPassword. Here, you propagate those parameter values from your variable group, for both the Validate and Preview stages.

  1. In Visual Studio Code, open the deploy.yml file in the deploy/pipeline-templates folder.

  2. Update the Validate stage's RunPreflightValidation step by adding the new parameters.

    - 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)
      -sqlServerAdministratorLogin $(SqlServerAdministratorLogin)
      -sqlServerAdministratorLoginPassword $(SqlServerAdministratorLoginPassword)

  3. Update the Preview stage's RunWhatIf step by adding the new parameters.

    inlineScript: |
  az deployment group what-if \
    --resource-group $(ResourceGroupName) \
    --template-file deploy/main.bicep \
    --parameters environmentType=$(EnvironmentType) \
                 reviewApiUrl=$(ReviewApiUrl) \
                 reviewApiKey=$(ReviewApiKey) \
                 sqlServerAdministratorLogin=$(SqlServerAdministratorLogin) \
                 sqlServerAdministratorLoginPassword=$(SqlServerAdministratorLoginPassword)

    Important

    Be sure to add the backslash character (\) at the end of the line that sets the reviewApiKey parameter value, and on the subsequent line. The \ character indicates that there are further lines that are part of the same Azure CLI command.

Add parameter values to the Deploy stage

  1. Update the Deploy stage's DeployBicepFile step by adding the new parameters:

    - 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)
      -sqlServerAdministratorLogin $(SqlServerAdministratorLogin)
      -sqlServerAdministratorLoginPassword $(SqlServerAdministratorLoginPassword)
    deploymentOutputs: deploymentOutputs

  2. Create pipeline variables that contain the values of the Bicep outputs you recently added for the storage account and Azure SQL resources:

    - bash: |
    echo "##vso[task.setvariable variable=appServiceAppName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppName.value')"
    echo "##vso[task.setvariable variable=appServiceAppHostName;isOutput=true]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppHostName.value')"
    echo "##vso[task.setvariable variable=storageAccountName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.storageAccountName.value')"
    echo "##vso[task.setvariable variable=storageAccountImagesBlobContainerName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.storageAccountImagesBlobContainerName.value')"
    echo "##vso[task.setvariable variable=sqlServerFullyQualifiedDomainName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.sqlServerFullyQualifiedDomainName.value')"
    echo "##vso[task.setvariable variable=sqlDatabaseName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.sqlDatabaseName.value')"
  name: SaveDeploymentOutputs
  displayName: Save deployment outputs into variables
  env:
    DEPLOYMENT_OUTPUTS: $(deploymentOutputs)

Add database deployment steps

In this section, you define the steps that are required to deploy the database components of your website. First, you add a step to deploy the DACPAC file that the pipeline previously built. Then, you add sample data to the database and storage account, but only for nonproduction environments.

  1. Below the DeployWebsiteApp step in the Deploy stage, add a new step to deploy the DACPAC file:

    - task: SqlAzureDacpacDeployment@1
  name: DeploySqlDatabaseDacpac
  displayName: Deploy DACPAC to database
  inputs:
    ConnectedServiceNameARM: ToyWebsite${{parameters.environmentType}}
    authenticationType: 'server'
    serverName: $(sqlServerFullyQualifiedDomainName)
    databaseName: $(sqlDatabaseName)
    sqlUsername: $(SqlServerAdministratorLogin)
    sqlPassword: $(SqlServerAdministratorLoginPassword)
    deployType: 'DacpacTask'
    deploymentAction: 'Publish'
    dacpacFile: '$(Pipeline.Workspace)/database/ToyCompany.Database.dacpac'

  2. Below the step you just added, define a step to seed the database with sample data.

    - ${{ if ne(parameters.environmentType, 'Production') }}:
  - task: SqlAzureDacpacDeployment@1
    name: AddTestDataToDatabase
    displayName: Add test data to database
    inputs:
      ConnectedServiceNameARM: ToyWebsite${{parameters.environmentType}}
      authenticationType: 'server'
      serverName: $(sqlServerFullyQualifiedDomainName)
      databaseName: $(sqlDatabaseName)
      sqlUsername: $(SqlServerAdministratorLogin)
      sqlPassword: $(SqlServerAdministratorLoginPassword)
      deployType: 'sqlTask'
      sqlFile: 'deploy/sample-data/Toys.sql'

    Notice that this step has a condition applied to it so that it only runs for nonproduction environments.

  3. Below the step you just added, and still within the scope of the condition, add a step to upload some sample toy images to the blob container by using Azure CLI:

    - task: AzureCLI@2
  name: UploadSampleImages
  displayName: Upload sample images
  inputs:
    azureSubscription: ToyWebsite${{parameters.environmentType}}
    scriptType: 'bash'
    scriptLocation: 'inlineScript'
    inlineScript: |
      az storage blob upload-batch \
        --account-name $(storageAccountName) \
        --destination $(storageAccountImagesBlobContainerName) \
        --source 'deploy/sample-data/toyimages'

Verify files and commit your changes

  1. Verify that your main.bicep file looks like this:

    @description('The location into which your Azure resources should be deployed.')
param location string = resourceGroup().location

@description('Select the type of environment you want to provision. Allowed values are Production and Test.')
@allowed([
  'Production'
  'Test'
])
param environmentType string

@description('A unique suffix to add to resource names that need to be globally unique.')
@maxLength(13)
param resourceNameSuffix string = uniqueString(resourceGroup().id)

@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

@description('The administrator login username for the SQL server.')
param sqlServerAdministratorLogin string

@secure()
@description('The administrator login password for the SQL server.')
param sqlServerAdministratorLoginPassword string

// Define the names for resources.
var appServiceAppName = 'toy-website-${resourceNameSuffix}'
var appServicePlanName = 'toy-website'
var logAnalyticsWorkspaceName = 'workspace-${resourceNameSuffix}'
var applicationInsightsName = 'toywebsite'
var storageAccountName = 'mystorage${resourceNameSuffix}'
var storageAccountImagesBlobContainerName = 'toyimages'
var sqlServerName = 'toy-website-${resourceNameSuffix}'
var sqlDatabaseName = 'Toys'

// Define the connection string to access Azure SQL.
var sqlDatabaseConnectionString = 'Server=tcp:${sqlServer.properties.fullyQualifiedDomainName},1433;Initial Catalog=${sqlDatabase.name};Persist Security Info=False;User ID=${sqlServerAdministratorLogin};Password=${sqlServerAdministratorLoginPassword};MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;'

// Define the SKUs for each component based on the environment type.
var environmentConfigurationMap = {
  Production: {
    appServicePlan: {
      sku: {
        name: 'S1'
        capacity: 1
      }
    }
    storageAccount: {
      sku: {
        name: 'Standard_LRS'
      }
    }
    sqlDatabase: {
      sku: {
        name: 'Standard'
        tier: 'Standard'
      }
    }
  }
  Test: {
    appServicePlan: {
      sku: {
        name: 'F1'
      }
    }
    storageAccount: {
      sku: {
        name: 'Standard_GRS'
      }
    }
    sqlDatabase: {
      sku: {
        name: 'Standard'
        tier: 'Standard'
      }
    }
  }
}

resource appServicePlan 'Microsoft.Web/serverfarms@2022-03-01' = {
  name: appServicePlanName
  location: location
  sku: environmentConfigurationMap[environmentType].appServicePlan.sku
}

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
        }
        {
          name: 'StorageAccountName'
          value: storageAccount.name
        }
        {
          name: 'StorageAccountBlobEndpoint'
          value: storageAccount.properties.primaryEndpoints.blob
        }
        {
          name: 'StorageAccountImagesContainerName'
          value: storageAccount::blobService::storageAccountImagesBlobContainer.name
        }
        {
          name: 'SqlDatabaseConnectionString'
          value: sqlDatabaseConnectionString
        }
      ]
    }
  }
}

resource logAnalyticsWorkspace 'Microsoft.OperationalInsights/workspaces@2022-10-01' = {
  name: logAnalyticsWorkspaceName
  location: location
}

resource applicationInsights 'Microsoft.Insights/components@2020-02-02' = {
  name: applicationInsightsName
  location: location
  kind: 'web'
  properties: {
    Application_Type: 'web'
    Request_Source: 'rest'
    Flow_Type: 'Bluefield'
    WorkspaceResourceId: logAnalyticsWorkspace.id
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: storageAccountName
  location: location
  kind: 'StorageV2'
  sku: environmentConfigurationMap[environmentType].storageAccount.sku

  resource blobService 'blobServices' = {
    name: 'default'

    resource storageAccountImagesBlobContainer 'containers' = {
      name: storageAccountImagesBlobContainerName

      properties: {
        publicAccess: 'Blob'
      }
    }
  }
}

resource sqlServer 'Microsoft.Sql/servers@2022-05-01-preview' = {
  name: sqlServerName
  location: location
  properties: {
    administratorLogin: sqlServerAdministratorLogin
    administratorLoginPassword: sqlServerAdministratorLoginPassword
  }
}

resource sqlServerFirewallRule 'Microsoft.Sql/servers/firewallRules@2022-05-01-preview' = {
  parent: sqlServer
  name: 'AllowAllWindowsAzureIps'
  properties: {
    endIpAddress: '0.0.0.0'
    startIpAddress: '0.0.0.0'
  }
}

resource sqlDatabase 'Microsoft.Sql/servers/databases@2022-05-01-preview' = {
  parent: sqlServer
  name: sqlDatabaseName
  location: location
  sku: environmentConfigurationMap[environmentType].sqlDatabase.sku
}

output appServiceAppName string = appServiceApp.name
output appServiceAppHostName string = appServiceApp.properties.defaultHostName
output storageAccountName string = storageAccount.name
output storageAccountImagesBlobContainerName string = storageAccount::blobService::storageAccountImagesBlobContainer.name
output sqlServerFullyQualifiedDomainName string = sqlServer.properties.fullyQualifiedDomainName
output sqlDatabaseName string = sqlDatabase.name

    If it doesn't, update it to match the file contents.

  2. Verify that your deploy.yml file looks like this:

    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)
              -sqlServerAdministratorLogin $(SqlServerAdministratorLogin)
              -sqlServerAdministratorLoginPassword $(SqlServerAdministratorLoginPassword)

- ${{ 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) \
                             sqlServerAdministratorLogin=$(SqlServerAdministratorLogin) \
                             sqlServerAdministratorLoginPassword=$(SqlServerAdministratorLoginPassword)

- stage: Deploy_${{parameters.environmentType}}
  displayName: Deploy (${{parameters.environmentType}} Environment)
  jobs:
  - deployment: DeployWebsite
    displayName: Deploy website
    pool:
      vmImage: windows-latest
    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)
                  -sqlServerAdministratorLogin $(SqlServerAdministratorLogin)
                  -sqlServerAdministratorLoginPassword $(SqlServerAdministratorLoginPassword)
                deploymentOutputs: deploymentOutputs

            - bash: |
                echo "##vso[task.setvariable variable=appServiceAppName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppName.value')"
                echo "##vso[task.setvariable variable=appServiceAppHostName;isOutput=true]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.appServiceAppHostName.value')"
                echo "##vso[task.setvariable variable=storageAccountName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.storageAccountName.value')"
                echo "##vso[task.setvariable variable=storageAccountImagesBlobContainerName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.storageAccountImagesBlobContainerName.value')"
                echo "##vso[task.setvariable variable=sqlServerFullyQualifiedDomainName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.sqlServerFullyQualifiedDomainName.value')"
                echo "##vso[task.setvariable variable=sqlDatabaseName]$(echo $DEPLOYMENT_OUTPUTS | jq -r '.sqlDatabaseName.value')"
              name: SaveDeploymentOutputs
              displayName: Save deployment outputs into variables
              env:
                DEPLOYMENT_OUTPUTS: $(deploymentOutputs)

            - task: AzureRmWebAppDeployment@4
              name: DeployWebsiteApp
              displayName: Deploy website
              inputs:
                appType: webApp
                ConnectionType: AzureRM
                azureSubscription: ToyWebsite${{parameters.environmentType}}
                ResourceGroupName: $(ResourceGroupName)
                WebAppName: $(appServiceAppName)
                Package: '$(Pipeline.Workspace)/website/publish.zip'

            - task: SqlAzureDacpacDeployment@1
              name: DeploySqlDatabaseDacpac
              displayName: Deploy DACPAC to database
              inputs:
                ConnectedServiceNameARM: ToyWebsite${{parameters.environmentType}}
                authenticationType: 'server'
                serverName: $(sqlServerFullyQualifiedDomainName)
                databaseName: $(sqlDatabaseName)
                sqlUsername: $(SqlServerAdministratorLogin)
                sqlPassword: $(SqlServerAdministratorLoginPassword)
                deployType: 'DacpacTask'
                deploymentAction: 'Publish'
                dacpacFile: '$(Pipeline.Workspace)/database/ToyCompany.Database.dacpac'

            - ${{ if ne(parameters.environmentType, 'Production') }}:
              - task: SqlAzureDacpacDeployment@1
                name: AddTestDataToDatabase
                displayName: Add test data to database
                inputs:
                  ConnectedServiceNameARM: ToyWebsite${{parameters.environmentType}}
                  authenticationType: 'server'
                  serverName: $(sqlServerFullyQualifiedDomainName)
                  databaseName: $(sqlDatabaseName)
                  sqlUsername: $(SqlServerAdministratorLogin)
                  sqlPassword: $(SqlServerAdministratorLoginPassword)
                  deployType: 'sqlTask'
                  sqlFile: 'deploy/sample-data/Toys.sql'

              - task: AzureCLI@2
                name: UploadSampleImages
                displayName: Upload sample images
                inputs:
                  azureSubscription: ToyWebsite${{parameters.environmentType}}
                  scriptType: 'bash'
                  scriptLocation: 'inlineScript'
                  inlineScript: |
                    az storage blob upload-batch \
                      --account-name $(storageAccountName) \
                      --destination $(storageAccountImagesBlobContainerName) \
                      --source 'deploy/sample-data/toyimages'

- 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'

    If it doesn't, update it to match the file contents.

  3. Save your changes to the file.

  4. Commit and push your changes to your Git repository. In the Visual Studio Code terminal, run the following commands:

    git add .
git commit -m "Add SQL database"
git push

Run the pipeline

  1. In your browser, go to Pipelines.

  2. Select the most recent run of your pipeline.

    Wait until all the stages for the test environment finish successfully. Notice that the smoke test now also succeeds.

    Screenshot of Azure DevOps showing the pipeline run's Smoke Test stage for the test environment. The status shows that the stage succeeded.

  3. Wait for the pipeline to pause again before the Preview (Production Environment) stage, because it needs permission to a different variable group this time.

    Screenshot of Azure DevOps showing the pipeline run paused at the Deploy stage. Permission is required to continue. The View button is highlighted.

  4. Select View, and then select Permit > Permit.

    The Preview (Production Environment) stage finishes successfully.

  5. Monitor the pipeline as it completes the final stages.

    The Deploy (Production Environment) stage finishes successfully, and the Smoke Test (Production Environment) stage also finishes successfully.

    Screenshot of Azure DevOps showing the pipeline run with all stages showing success.

View the website

  1. Select the Deploy (Test Environment) stage to open the pipeline log.

  2. Select the Deploy website step.

    Hold down the Ctrl key (⌘ on macOS) and select the URL of the App Service app, opening it in a new browser tab.

    Screenshot of Azure DevOps showing the pipeline run log for the test environment's Deploy stage. The URL of the App Service app is highlighted.

  3. Select Toys.

    Screenshot of the toy company website homepage, with the Toys link highlighted.

    Notice that sample data is displayed in the test environment.

    Screenshot of the test website's toy page, with the sample toys displayed.

  4. Repeat the preceding process for the Deploy (Production Environment) stage's app.

    Notice that no sample data is displayed in the production environment.

    Screenshot of the production website's toy page, with no toys displayed.

Clean up resources

Now that the exercise is completed, you should remove the resources so that you aren't billed for them.

In the Visual Studio Code terminal, run the following commands:

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

The resource group is deleted in the background.

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