Push settings to App Configuration with Azure Pipelines

The Azure App Configuration Push task pushes key-values from a configuration file into your App Configuration store. This task enables full circle functionality within the pipeline as you're now able to pull settings from the App Configuration store as well as push settings to the App Configuration store.

Prerequisites

Create a service connection

A service connection gives you access to resources in your Azure subscription from your Azure DevOps project.

  1. In Azure DevOps, go to the project that contains your target pipeline. In the lower-left corner, select Project settings.

  2. Under Pipelines, select Service connections. In the upper-right corner, select New service connection.

  3. In New service connection, select Azure Resource Manager.

    Screenshot shows selecting Azure Resource Manager from the New service connection dropdown list.

  4. In the Authentication method dialog, select Service principal (automatic) to create a new service principal or select Service principal (manual) to use an existing service principal.

  5. Enter your subscription and resource and a name for your service connection.

If you created a new service principal, find the name of the service principal assigned to the service connection. You'll add a new role assignment to this service principal in the next step.

  1. Go to Project Settings > Service connections.

  2. Select the new service connection.

  3. Select Manage Service Principal.

  4. Note the value in Display name.

    Screenshot shows the service principal display name.

Add role assignment

Assign the proper App Configuration role assignments to the credentials being used within the task so that the task can access the App Configuration store.

  1. Go to your target App Configuration store.

  2. In the left menu, select Access control (IAM).

  3. In the right pane, select Add role assignments.

    Screenshot shows the Add role assignments button.

  4. For Role, select App Configuration Data Owner. This role allows the task to read from and write to the App Configuration store.

  5. Select the service principal associated with the service connection that you created in the previous section.

    Screenshot shows the Add role assignment dialog.

Use in builds

This section will cover how to use the Azure App Configuration Push task in an Azure DevOps build pipeline.

  1. Navigate to the build pipeline page by clicking Pipelines > Pipelines. Documentation for build pipelines can be found here.
    • If you're creating a new build pipeline, on the last step of the process, on the Review tab, select Show assistant on the right side of the pipeline. Screenshot shows the Show assistant button for a new pipeline.
    • If you're using an existing build pipeline, click the Edit button at the top-right. Screenshot shows the Edit button for an existing pipeline.
  2. Search for the Azure App Configuration Push Task. Screenshot shows the Add Task dialog with Azure App Configuration Push in the search box.
  3. Configure the necessary parameters for the task to push the key-values from the configuration file to the App Configuration store. Explanations of the parameters are available in the Parameters section below, and in tooltips next to each parameter. Screenshot shows the app configuration push task parameters.
  4. Save and queue a build. The build log will display any failures that occurred during the execution of the task.

Use in releases

This section will cover how to use the Azure App Configuration Push task in an Azure DevOps release pipelines.

  1. Navigate to release pipeline page by selecting Pipelines > Releases. Documentation for release pipelines can be found here.
  2. Choose an existing release pipeline. If you don’t have one, select + New to create a new one.
  3. Select the Edit button in the top-right corner to edit the release pipeline.
  4. From the Tasks dropdown, choose the Stage to which you want to add the task. More information about stages can be found here. Screenshot shows the selected stage in the Tasks dropdown.
  5. Click + next to the Job to which you want to add a new task. Screenshot shows the plus button next to the job.
  6. In the Add tasks dialog, type Azure App Configuration Push into the search box and select it.
  7. Configure the necessary parameters within the task to push your key-values from your configuration file to your App Configuration store. Explanations of the parameters are available in the Parameters section below, and in tooltips next to each parameter.
  8. Save and queue a release. The release log will display any failures encountered during the execution of the task.

Parameters

The following parameters are used by the App Configuration Push task:

  • Azure subscription: A drop-down containing your available Azure service connections. To update and refresh your list of available Azure service connections, press the Refresh Azure subscription button to the right of the textbox.
  • App Configuration Name: A drop-down that loads your available configuration stores under the selected subscription. To update and refresh your list of available configuration stores, press the Refresh App Configuration Name button to the right of the textbox.
  • Configuration File Path: The path to your configuration file. The Configuration File Path parameter begins at the root of the file repository. You can browse through your build artifact to select a configuration file. (... button to the right of the textbox). The supported file formats are: yaml, json, properties. The following is an example configuration file in json format.
    {
        "TestApp:Settings:BackgroundColor":"#FFF",
        "TestApp:Settings:FontColor":"#000",
        "TestApp:Settings:FontSize":"24",
        "TestApp:Settings:Message": "Message data"
    }
    
  • Separator: The separator that's used to flatten .json and .yml files.
  • Depth: The depth that the .json and .yml files will be flattened to.
  • Prefix: A string that's appended to the beginning of each key pushed to the App Configuration store.
  • Label: A string that's added to each key-value as the label within the App Configuration store.
  • Content Type: A string that's added to each key-value as the content type within the App Configuration store.
  • Tags: A JSON object in the format of {"tag1":"val1", "tag2":"val2"}, which defines tags that are added to each key-value pushed to your App Configuration store.
  • Delete all other Key-Values in store with the specified prefix and label: Default value is Unchecked.
    • Checked: Removes all key-values in the App Configuration store that match both the specified prefix and label before pushing new key-values from the configuration file.
    • Unchecked: Pushes all key-values from the configuration file into the App Configuration store and leaves everything else in the App Configuration store intact.

Troubleshooting

If an unexpected error occurs, debug logs can be enabled by setting the pipeline variable system.debug to true.

FAQ

How can I upload multiple configuration files?

Create multiple instances of the Azure App Configuration Push task within the same pipeline to push multiple configuration files to the App Configuration store.

How can I create Key Vault references using this task?

To create Key Vault references, set the "Content Type" parameter to application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8. If not all key-values in a configuration file are Key Vault references, put Key Vault references and normal key-values in separate configuration files, and push them separately.

Why am I receiving a 409 error when attempting to push key-values to my configuration store?

A 409 Conflict error message will occur if the task tries to remove or overwrite a key-value that is locked in the App Configuration store.