Skip to content

Data Source: azurermAppConfiguration

Use this data source to access information about an existing 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 dataAzurermAppConfigurationExample =
  new azurerm.dataAzurermAppConfiguration.DataAzurermAppConfiguration(
    this,
    "example",
    {
      name: "existing",
      resource_group_name: "existing",
    }
  );
new cdktf.TerraformOutput(this, "id", {
  value: dataAzurermAppConfigurationExample.id,
});

Arguments Reference

The following arguments are supported:

  • name - (Required) The Name of this App Configuration.

  • resourceGroupName - (Required) The name of the Resource Group where the App Configuration exists.

Attributes Reference

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

  • id - The ID of the App Configuration.

  • endpoint - The Endpoint used to access this App Configuration.

  • encryption - An encryption block as defined below.

  • localAuthEnabled - Whether local authentication methods is enabled.

  • location - The Azure Region where the App Configuration exists.

  • primaryReadKey - A primaryReadKey block as defined below containing the primary read access key.

  • primaryWriteKey - A primaryWriteKey block as defined below containing the primary write access key.

  • publicNetworkAccess - The Public Network Access setting of this App Configuration.

  • purgeProtectionEnabled - Whether Purge Protection is enabled.

  • secondaryReadKey - A secondaryReadKey block as defined below containing the secondary read access key.

  • secondaryWriteKey - A secondaryWriteKey block as defined below containing the secondary write access key.

  • sku - The name of the SKU used for this App Configuration.

  • softDeleteRetentionDays - The number of days that items should be retained for once soft-deleted.

  • tags - A mapping of tags assigned to the App Configuration.

A primaryReadKey block exports the following:

  • connectionString - The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

  • id - The ID of the Access Key.

  • secret - The Secret of the Access Key.

A primaryWriteKey block exports the following:

  • connectionString - The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

  • id - The ID of the Access Key.

  • secret - The Secret of the Access Key.

A secondaryReadKey block exports the following:

  • connectionString - The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

  • id - The ID of the Access Key.

  • secret - The Secret of the Access Key.

A secondaryWriteKey block exports the following:

  • connectionString - The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

  • id - The ID of the Access Key.

  • secret - The Secret of the Access Key.

Timeouts

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

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