Add Azure AppConfig KV - Retrieve Values

[harrisonmeister]

Background

There is no native way in Octopus to retrieve configuration values from an Azure App Configuration Store for use in an Octopus deployment or runbook.

In addition, the step can (if configured) create an output variable that includes a JSON value that can be used in the built-in Azure App Service step to supply an entire JSON object for AppSettings.

Results

This step retrieves one or more key/values from an Azure App Configuration store and creates output variables for each value retrieved. These values can be used in other deployment or runbook process steps.

You can retrieve individual keys that match a specific name, and you can choose a custom output variable name for each key.

Wildcard search is also supported using the * notation in the Key Names parameter. Note: Combining a wildcard search with custom output variable names is not supported.

Authentication is performed using an Azure Service Principal.

---

Required:

• An Azure account with permissions to retrieve key/values from the Azure App Config store.
• Theaz CLI on the target or worker. If the CLI can't be found, the step will fail.

Notes:

• Tested on Octopus 2024.1 using az version 2.38.0
• Tested with both Windows PowerShell and PowerShell Core (on Linux).

Before

N/A

After

Step template in a runbook process:

Results in Task log:

Pre-requisites

• [X] Id should be a GUID that is not 00000000-0000-0000-0000-000000000000
  • NOTE If you are modifying an existing step template, please make sure that you do not modify the Id property (updating the Id will break the Library sync functionality in Octopus).
• [X] Version should be incremented, otherwise the integration with Octopus won't update the step template correctly
• [X] Parameter names should not start with $
• [X] Step template parameter names (the ones declared in the JSON, not the script body) should be prefixed with a namespace so that they are less likely to clash with other user-defined variables in Octopus (see this issue). For example, use an abbreviated name of the step template or the category of the step template).
• [X] LastModifiedBy field must be present, and (optionally) updated with the correct author

[harrisonmeister]

A few minor points, and only one (empty string not caught with a null check) that might manifest as a bug.

Thank @mcasperson - I think I got all those fixed up in 265bb61