Add Azure Function - Set AppSettings from Azure AppConfig

[harrisonmeister]

Background

Similar to #1451, there is no native way in Octopus to retrieve configuration values from an Azure App Configuration Store and to publish them to an Azure App function subsequently

Results

This step retrieves one or more key/values from an Azure App Configuration store and adds them to an Azure App Function's AppSettings.

You can retrieve individual keys that match a specific name, and you can choose a custom setting 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.

You can also combine retrieved values with additional parameters passed into the step using the Additional AppSettings parameter.

Authentication is performed using an Azure Service Principal.

---

Required:

• An Azure account with permission to retrieve values from the Azure App Config store and publish to the App Function.
• 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).
• Slot Settings are not currently supported.

Before

N/A

After

Step template in a runbook process:

Results in Task log:

Verbose logs:

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]

Small style suggestions, and one potential bug where an empty string is checked by comparing it to $null.

Thanks @mcasperson - these should be resolved in a64d8ff

Side note: I use more brackets in a ton of places :smile: