Skip to content

Data Source: azurermAadb2CDirectory

Use this data source to access information about an existing AAD B2C Directory.

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 dataAzurermAadb2CDirectoryExample =
  new azurerm.dataAzurermAadb2CDirectory.DataAzurermAadb2CDirectory(
    this,
    "example",
    {
      domain_name: "exampleb2ctenant.onmicrosoft.com",
      resource_group_name: "example-rg",
    }
  );
new cdktf.TerraformOutput(this, "tenant_id", {
  value: dataAzurermAadb2CDirectoryExample.tenantId,
});

Arguments Reference

The following arguments are supported:

  • domainName - (Required) Domain name of the B2C tenant, including the onmicrosoftCom suffix.

  • resourceGroupName - (Required) The name of the Resource Group where the AAD B2C Directory exists.

Attributes Reference

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

  • id - The ID of the AAD B2C Directory.

  • billingType - The type of billing for the AAD B2C tenant. Possible values include: mau or auths.

  • dataResidencyLocation - Location in which the B2C tenant is hosted and data resides. See official docs for more information.

  • effectiveStartDate - The date from which the billing type took effect. May not be populated until after the first billing cycle.

  • skuName - Billing SKU for the B2C tenant. See official docs for more information.

  • tags - A mapping of tags assigned to the AAD B2C Directory.

  • tenantId - The Tenant ID for the AAD B2C tenant.

\~> Note: The countryCode and displayName are not returned by this data source due to API limitations.

Timeouts

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

  • read - (Defaults to 5 minutes) Used when retrieving the AAD B2C Directory.