1. Packages
  2. Azure Classic
  3. API Docs
  4. appconfiguration
  5. getConfigurationKeys

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

azure.appconfiguration.getConfigurationKeys

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

    Use this data source to access information about existing Azure App Configuration Keys.

    Note: App Configuration Keys are provisioned using a Data Plane API which requires the role App Configuration Data Owner on either the App Configuration or a parent scope (such as the Resource Group/Subscription). More information can be found in the Azure Documentation for App Configuration.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Azure.AppConfiguration.GetConfigurationKeys.Invoke(new()
        {
            ConfigurationStoreId = azurerm_app_configuration.Appconf.Id,
        });
    
        return new Dictionary<string, object?>
        {
            ["value"] = test.Apply(getConfigurationKeysResult => getConfigurationKeysResult.Items),
        };
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appconfiguration"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := appconfiguration.GetConfigurationKeys(ctx, &appconfiguration.GetConfigurationKeysArgs{
    			ConfigurationStoreId: azurerm_app_configuration.Appconf.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("value", test.Items)
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.appconfiguration.AppconfigurationFunctions;
    import com.pulumi.azure.appconfiguration.inputs.GetConfigurationKeysArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = AppconfigurationFunctions.getConfigurationKeys(GetConfigurationKeysArgs.builder()
                .configurationStoreId(azurerm_app_configuration.appconf().id())
                .build());
    
            ctx.export("value", test.applyValue(getConfigurationKeysResult -> getConfigurationKeysResult.items()));
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    test = azure.appconfiguration.get_configuration_keys(configuration_store_id=azurerm_app_configuration["appconf"]["id"])
    pulumi.export("value", test.items)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const test = azure.appconfiguration.getConfigurationKeys({
        configurationStoreId: azurerm_app_configuration.appconf.id,
    });
    export const value = test.then(test => test.items);
    
    variables:
      test:
        fn::invoke:
          Function: azure:appconfiguration:getConfigurationKeys
          Arguments:
            configurationStoreId: ${azurerm_app_configuration.appconf.id}
    outputs:
      value: ${test.items}
    

    Using getConfigurationKeys

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConfigurationKeys(args: GetConfigurationKeysArgs, opts?: InvokeOptions): Promise<GetConfigurationKeysResult>
    function getConfigurationKeysOutput(args: GetConfigurationKeysOutputArgs, opts?: InvokeOptions): Output<GetConfigurationKeysResult>
    def get_configuration_keys(configuration_store_id: Optional[str] = None,
                               key: Optional[str] = None,
                               label: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetConfigurationKeysResult
    def get_configuration_keys_output(configuration_store_id: Optional[pulumi.Input[str]] = None,
                               key: Optional[pulumi.Input[str]] = None,
                               label: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationKeysResult]
    func GetConfigurationKeys(ctx *Context, args *GetConfigurationKeysArgs, opts ...InvokeOption) (*GetConfigurationKeysResult, error)
    func GetConfigurationKeysOutput(ctx *Context, args *GetConfigurationKeysOutputArgs, opts ...InvokeOption) GetConfigurationKeysResultOutput

    > Note: This function is named GetConfigurationKeys in the Go SDK.

    public static class GetConfigurationKeys 
    {
        public static Task<GetConfigurationKeysResult> InvokeAsync(GetConfigurationKeysArgs args, InvokeOptions? opts = null)
        public static Output<GetConfigurationKeysResult> Invoke(GetConfigurationKeysInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConfigurationKeysResult> getConfigurationKeys(GetConfigurationKeysArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:appconfiguration/getConfigurationKeys:getConfigurationKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConfigurationStoreId string

    Specifies the id of the App Configuration.

    Key string

    The name of the App Configuration Keys to look up.

    Label string

    The label of the App Configuration Keys tp look up.

    ConfigurationStoreId string

    Specifies the id of the App Configuration.

    Key string

    The name of the App Configuration Keys to look up.

    Label string

    The label of the App Configuration Keys tp look up.

    configurationStoreId String

    Specifies the id of the App Configuration.

    key String

    The name of the App Configuration Keys to look up.

    label String

    The label of the App Configuration Keys tp look up.

    configurationStoreId string

    Specifies the id of the App Configuration.

    key string

    The name of the App Configuration Keys to look up.

    label string

    The label of the App Configuration Keys tp look up.

    configuration_store_id str

    Specifies the id of the App Configuration.

    key str

    The name of the App Configuration Keys to look up.

    label str

    The label of the App Configuration Keys tp look up.

    configurationStoreId String

    Specifies the id of the App Configuration.

    key String

    The name of the App Configuration Keys to look up.

    label String

    The label of the App Configuration Keys tp look up.

    getConfigurationKeys Result

    The following output properties are available:

    ConfigurationStoreId string
    Id string

    The provider-assigned unique ID for this managed resource.

    Items List<GetConfigurationKeysItem>

    A list of items blocks as defined below.

    Key string

    The name of the App Configuration Key.

    Label string

    The label of the App Configuration Key.

    ConfigurationStoreId string
    Id string

    The provider-assigned unique ID for this managed resource.

    Items []GetConfigurationKeysItem

    A list of items blocks as defined below.

    Key string

    The name of the App Configuration Key.

    Label string

    The label of the App Configuration Key.

    configurationStoreId String
    id String

    The provider-assigned unique ID for this managed resource.

    items List<GetConfigurationKeysItem>

    A list of items blocks as defined below.

    key String

    The name of the App Configuration Key.

    label String

    The label of the App Configuration Key.

    configurationStoreId string
    id string

    The provider-assigned unique ID for this managed resource.

    items GetConfigurationKeysItem[]

    A list of items blocks as defined below.

    key string

    The name of the App Configuration Key.

    label string

    The label of the App Configuration Key.

    configuration_store_id str
    id str

    The provider-assigned unique ID for this managed resource.

    items Sequence[GetConfigurationKeysItem]

    A list of items blocks as defined below.

    key str

    The name of the App Configuration Key.

    label str

    The label of the App Configuration Key.

    configurationStoreId String
    id String

    The provider-assigned unique ID for this managed resource.

    items List<Property Map>

    A list of items blocks as defined below.

    key String

    The name of the App Configuration Key.

    label String

    The label of the App Configuration Key.

    Supporting Types

    GetConfigurationKeysItem

    ContentType string

    The content type of the App Configuration Key.

    Etag string

    The ETag of the key.

    Key string

    The name of the App Configuration Keys to look up.

    Label string

    The label of the App Configuration Keys tp look up.

    Locked bool

    Is this App Configuration Key be Locked to prevent changes.

    Tags Dictionary<string, string>

    A mapping of tags assigned to the resource.

    Type string

    The type of the App Configuration Key. It can either be kv (simple key/value) or vault (where the value is a reference to a Key Vault Secret.

    Value string

    The value of the App Configuration Key.

    VaultKeyReference string

    The ID of the vault secret this App Configuration Key refers to, when type is vault.

    ContentType string

    The content type of the App Configuration Key.

    Etag string

    The ETag of the key.

    Key string

    The name of the App Configuration Keys to look up.

    Label string

    The label of the App Configuration Keys tp look up.

    Locked bool

    Is this App Configuration Key be Locked to prevent changes.

    Tags map[string]string

    A mapping of tags assigned to the resource.

    Type string

    The type of the App Configuration Key. It can either be kv (simple key/value) or vault (where the value is a reference to a Key Vault Secret.

    Value string

    The value of the App Configuration Key.

    VaultKeyReference string

    The ID of the vault secret this App Configuration Key refers to, when type is vault.

    contentType String

    The content type of the App Configuration Key.

    etag String

    The ETag of the key.

    key String

    The name of the App Configuration Keys to look up.

    label String

    The label of the App Configuration Keys tp look up.

    locked Boolean

    Is this App Configuration Key be Locked to prevent changes.

    tags Map<String,String>

    A mapping of tags assigned to the resource.

    type String

    The type of the App Configuration Key. It can either be kv (simple key/value) or vault (where the value is a reference to a Key Vault Secret.

    value String

    The value of the App Configuration Key.

    vaultKeyReference String

    The ID of the vault secret this App Configuration Key refers to, when type is vault.

    contentType string

    The content type of the App Configuration Key.

    etag string

    The ETag of the key.

    key string

    The name of the App Configuration Keys to look up.

    label string

    The label of the App Configuration Keys tp look up.

    locked boolean

    Is this App Configuration Key be Locked to prevent changes.

    tags {[key: string]: string}

    A mapping of tags assigned to the resource.

    type string

    The type of the App Configuration Key. It can either be kv (simple key/value) or vault (where the value is a reference to a Key Vault Secret.

    value string

    The value of the App Configuration Key.

    vaultKeyReference string

    The ID of the vault secret this App Configuration Key refers to, when type is vault.

    content_type str

    The content type of the App Configuration Key.

    etag str

    The ETag of the key.

    key str

    The name of the App Configuration Keys to look up.

    label str

    The label of the App Configuration Keys tp look up.

    locked bool

    Is this App Configuration Key be Locked to prevent changes.

    tags Mapping[str, str]

    A mapping of tags assigned to the resource.

    type str

    The type of the App Configuration Key. It can either be kv (simple key/value) or vault (where the value is a reference to a Key Vault Secret.

    value str

    The value of the App Configuration Key.

    vault_key_reference str

    The ID of the vault secret this App Configuration Key refers to, when type is vault.

    contentType String

    The content type of the App Configuration Key.

    etag String

    The ETag of the key.

    key String

    The name of the App Configuration Keys to look up.

    label String

    The label of the App Configuration Keys tp look up.

    locked Boolean

    Is this App Configuration Key be Locked to prevent changes.

    tags Map<String>

    A mapping of tags assigned to the resource.

    type String

    The type of the App Configuration Key. It can either be kv (simple key/value) or vault (where the value is a reference to a Key Vault Secret.

    value String

    The value of the App Configuration Key.

    vaultKeyReference String

    The ID of the vault secret this App Configuration Key refers to, when type is vault.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi