azappconfig

Azure App Configuration client library for Go

Azure App Configuration is a managed service that helps developers centralize their application and feature settings simply and securely. It allows you to create and manage application configuration settings and retrieve their revisions from a specific point in time.

Source code | Package (pkg.go.dev) | Product documentation

Getting started

Install packages

Install azappconfig with go get:

go get github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig

Prerequisites

• An Azure subscription

• Go version 1.16 or higher

• An App Configuration store. If you need to create one, you can use the Azure Cloud Shell to create one with these commands (replace "my-resource-group" and "my-app-config" with your own, unique names):

  (Optional) if you want a new resource group to hold the Azure App Configuration:

  az group create --name my-resource-group --location westus2
  

  Create the Key Vault:

  az appconfig create --resource-group my-resource-group --name my-app-config --location westus2
  

  Output:

  {
      "creationDate": "...",
      "endpoint": "https://my-app-config.azconfig.io",
      "id": "/subscriptions/.../resourceGroups/my-resource-group/providers/Microsoft.AppConfiguration/configurationStores/my-app-config",
      "location": "westus2",
      "name": "my-app-config",
      "provisioningState": "Succeeded",
      "resourceGroup": "my-resource-group",
      "tags": {},
      "type": "Microsoft.AppConfiguration/configurationStores"
  }
  

  The "endpoint" property is the endpointUrl used by Client

Authenticate the client

This document demonstrates using the connection string. However, Client accepts any azidentity credential. See the azidentity documentation for more information about other credentials.

Create a client

Constructing the client requires your App Configuration connection string, which you can get from the Azure Portal.

export APPCONFIGURATION_CONNECTION_STRING="Endpoint=https://my-app-config.azconfig.io;Id=...;Secret=..."

import (
    "os"
    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
)

client, err = azappconfig.NewClientFromConnectionString(os.Getenv("APPCONFIGURATION_CONNECTION_STRING"), nil)

Or, using Default Azure Credential from Azure Identity:

import (
    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
)

credential, err := azidentity.NewDefaultAzureCredential(nil)

client, err = azappconfig.NewClient("https://my-app-config.azconfig.io", credential, nil)

Examples

This section contains code snippets covering common tasks:

• Add a configuration setting
• Get a configuration setting
• Set a configuration setting
• Set a configuration setting read only
• List configuration setting revisions
• Delete a configuration setting

Add a configuration setting

import (
    "fmt"
    "os"

    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
)

func ExampleAddConfigurationSetting() {
    connectionString := os.Getenv("APPCONFIGURATION_CONNECTION_STRING")
    client, err := azappconfig.NewClientFromConnectionString(connectionString, nil)
    if err != nil {
        panic(err)
    }

    // Create configuration setting
    resp, err := client.AddSetting(
        context.TODO(),
        "key",
        to.Ptr("value"),
        &azappconfig.AddSettingOptions{
            Label: to.Ptr("label"),
        })

    if err != nil {
        panic(err)
    }

    fmt.Println(*resp.Key)
    fmt.Println(*resp.Label)
    fmt.Println(*resp.Value)
}

Get a configuration setting

import (
    "fmt"
    "os"

    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
)

func ExampleGetConfigurationSetting() {
    connectionString := os.Getenv("APPCONFIGURATION_CONNECTION_STRING")
    client, err := azappconfig.NewClientFromConnectionString(connectionString, nil)
    if err != nil {
        panic(err)
    }

    // Get configuration setting
    resp, err := client.GetSetting(
        context.TODO(),
        "key"
        &azappconfig.GetSettingOptions{
            Label: to.Ptr("label")
        })

    if err != nil {
        panic(err)
    }

    fmt.Println(*resp.Key)
    fmt.Println(*resp.Label)
    fmt.Println(*resp.Value)
}

Set a configuration setting

import (
    "fmt"
    "os"

    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
)

func ExampleSetConfigurationSetting() {
    connectionString := os.Getenv("APPCONFIGURATION_CONNECTION_STRING")
    client, err := azappconfig.NewClientFromConnectionString(connectionString, nil)
    if err != nil {
        panic(err)
    }

    // Set configuration setting
    resp, err := client.SetSetting(
        context.TODO(),
        "key",
        to.Ptr("new_value"),
        &azappconfig.SetSettingOptions{
            Label: to.Ptr("label"),
        })

    if err != nil {
        panic(err)
    }

    fmt.Println(*resp.Key)
    fmt.Println(*resp.Label)
    fmt.Println(*resp.Value)
}

Set a configuration setting read only

import (
    "fmt"
    "os"

    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
)

func ExampleSetConfigurationSettingReadOnly() {
    connectionString := os.Getenv("APPCONFIGURATION_CONNECTION_STRING")
    client, err := azappconfig.NewClientFromConnectionString(connectionString, nil)
    if err != nil {
        panic(err)
    }

    // Set configuration setting read only
    resp, err := client.SetReadOnly(
        context.TODO(),
        "key",
        true,
        &azappconfig.SetReadOnlyOptions{
            Label: to.Ptr("label")
        })

    if err != nil {
        panic(err)
    }

    fmt.Println(*resp.Key)
    fmt.Println(*resp.Label)
    fmt.Println(*resp.Value)
    fmt.Println(*resp.IsReadOnly)

    // Remove read only status
    resp, err := client.SetReadOnly(
        context.TODO(),
        "key",
        false,
        &azappconfig.SetReadOnlyOptions{
            Label: to.Ptr("label")
        })

    if err != nil {
        panic(err)
    }

    fmt.Println(*resp.Key)
    fmt.Println(*resp.Label)
    fmt.Println(*resp.Value)
    fmt.Println(*resp.IsReadOnly)
}

List configuration setting revisions

import (
    "fmt"
    "os"

    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
)

func ExampleListRevisions() {
    connectionString := os.Getenv("APPCONFIGURATION_CONNECTION_STRING")
    client, err := azappconfig.NewClientFromConnectionString(connectionString, nil)
    if err != nil {
        panic(err)
    }

    revPgr := client.NewListRevisionsPager(
        azappconfig.SettingSelector{
            KeyFilter: to.Ptr("*"),
            LabelFilter: to.Ptr("*"),
            Fields: azappconfig.AllSettingFields()
        },
        nil)

    for revPgr.More() {
        if revResp, revErr := revPgr.NextPage(context.TODO()); revErr == nil {
            for _, setting := range revResp.Settings {
                fmt.Println(*setting.Key)
                fmt.Println(*setting.Label)
                fmt.Println(*setting.Value)
                fmt.Println(*setting.IsReadOnly)
            }
        }
    }
}

Delete a configuration setting

import (
    "fmt"
    "os"

    "github.com/Azure/azure-sdk-for-go/sdk/appconfig/azappconfig"
    "github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
)

func ExampleDeleteConfigurationSetting() {
    connectionString := os.Getenv("APPCONFIGURATION_CONNECTION_STRING")
    client, err := azappconfig.NewClientFromConnectionString(connectionString, nil)
    if err != nil {
        panic(err)
    }

    // Delete configuration setting
    resp, err := client.DeleteSetting(
        context.TODO(),
        "key",
        &azappconfig.DeleteSettingOptions{
            Label: to.Ptr("label")
        })

    if err != nil {
        panic(err)
    }
    fmt.Println(*resp.Key)
    fmt.Println(*resp.Label)
}

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.