Skip to content

Data Source: azurermAppConfigurationKey

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

-> Note: App Configuration Keys are provisioned using a Data Plane API which requires the role appConfigurationDataOwner 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

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermAppConfigurationKeyTest =
  new azurerm.dataAzurermAppConfigurationKey.DataAzurermAppConfigurationKey(
    this,
    "test",
    {
      configuration_store_id: "${azurerm_app_configuration.appconf.id}",
      key: "appConfKey1",
      label: "somelabel",
    }
  );
new cdktf.TerraformOutput(this, "value", {
  value: dataAzurermAppConfigurationKeyTest.value,
});

Argument Reference

The following arguments are supported:

  • configurationStoreId - (Required) Specifies the id of the App Configuration.

  • key - (Required) The name of the App Configuration Key.

  • label - (Optional) The label of the App Configuration Key.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • contentType - The content type of the App Configuration Key.

  • value - The value of the App Configuration Key.

  • locked - Is this App Configuration Key be Locked to prevent changes.

  • type - 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.

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

  • tags - A mapping of tags assigned to the resource.

  • id - The App Configuration Key ID.

  • etag - The ETag of the key.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the App Configuration Key.