Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

Directory

Manages an AAD B2C Directory.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Azure.AadB2C.Directory("example", new Azure.AadB2C.DirectoryArgs
        {
            CountryCode = "US",
            DataResidencyLocation = "United States",
            DisplayName = "example-b2c-tenant",
            DomainName = "exampleb2ctenant.onmicrosoft.com",
            ResourceGroupName = "example-rg",
            SkuName = "PremiumP1",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/aadb2c"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aadb2c.NewDirectory(ctx, "example", &aadb2c.DirectoryArgs{
			CountryCode:           pulumi.String("US"),
			DataResidencyLocation: pulumi.String("United States"),
			DisplayName:           pulumi.String("example-b2c-tenant"),
			DomainName:            pulumi.String("exampleb2ctenant.onmicrosoft.com"),
			ResourceGroupName:     pulumi.String("example-rg"),
			SkuName:               pulumi.String("PremiumP1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.aadb2c.Directory;
import com.pulumi.azure.aadb2c.DirectoryArgs;
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) {
        var example = new Directory("example", DirectoryArgs.builder()        
            .countryCode("US")
            .dataResidencyLocation("United States")
            .displayName("example-b2c-tenant")
            .domainName("exampleb2ctenant.onmicrosoft.com")
            .resourceGroupName("example-rg")
            .skuName("PremiumP1")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example = azure.aadb2c.Directory("example",
    country_code="US",
    data_residency_location="United States",
    display_name="example-b2c-tenant",
    domain_name="exampleb2ctenant.onmicrosoft.com",
    resource_group_name="example-rg",
    sku_name="PremiumP1")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.aadb2c.Directory("example", {
    countryCode: "US",
    dataResidencyLocation: "United States",
    displayName: "example-b2c-tenant",
    domainName: "exampleb2ctenant.onmicrosoft.com",
    resourceGroupName: "example-rg",
    skuName: "PremiumP1",
});
resources:
  example:
    type: azure:aadb2c:Directory
    properties:
      countryCode: US
      dataResidencyLocation: United States
      displayName: example-b2c-tenant
      domainName: exampleb2ctenant.onmicrosoft.com
      resourceGroupName: example-rg
      skuName: PremiumP1

Create a Directory Resource

new Directory(name: string, args: DirectoryArgs, opts?: CustomResourceOptions);
@overload
def Directory(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              country_code: Optional[str] = None,
              data_residency_location: Optional[str] = None,
              display_name: Optional[str] = None,
              domain_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              sku_name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def Directory(resource_name: str,
              args: DirectoryArgs,
              opts: Optional[ResourceOptions] = None)
func NewDirectory(ctx *Context, name string, args DirectoryArgs, opts ...ResourceOption) (*Directory, error)
public Directory(string name, DirectoryArgs args, CustomResourceOptions? opts = null)
public Directory(String name, DirectoryArgs args)
public Directory(String name, DirectoryArgs args, CustomResourceOptions options)
type: azure:aadb2c:Directory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DirectoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DirectoryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DirectoryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DirectoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DirectoryArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Directory Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Directory resource accepts the following input properties:

DataResidencyLocation string

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

DomainName string

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

ResourceGroupName string

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

SkuName string

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

CountryCode string

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

DisplayName string

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the AAD B2C Directory.

DataResidencyLocation string

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

DomainName string

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

ResourceGroupName string

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

SkuName string

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

CountryCode string

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

DisplayName string

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

Tags map[string]string

A mapping of tags which should be assigned to the AAD B2C Directory.

dataResidencyLocation String

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

domainName String

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

resourceGroupName String

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

skuName String

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

countryCode String

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

displayName String

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

tags Map<String,String>

A mapping of tags which should be assigned to the AAD B2C Directory.

dataResidencyLocation string

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

domainName string

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

resourceGroupName string

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

skuName string

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

countryCode string

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

displayName string

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

tags {[key: string]: string}

A mapping of tags which should be assigned to the AAD B2C Directory.

data_residency_location str

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

domain_name str

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

resource_group_name str

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

sku_name str

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

country_code str

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

display_name str

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

tags Mapping[str, str]

A mapping of tags which should be assigned to the AAD B2C Directory.

dataResidencyLocation String

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

domainName String

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

resourceGroupName String

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

skuName String

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

countryCode String

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

displayName String

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

tags Map<String>

A mapping of tags which should be assigned to the AAD B2C Directory.

Outputs

All input properties are implicitly available as output properties. Additionally, the Directory resource produces the following output properties:

BillingType string

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

EffectiveStartDate string

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

Id string

The provider-assigned unique ID for this managed resource.

TenantId string

The Tenant ID for the AAD B2C tenant.

BillingType string

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

EffectiveStartDate string

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

Id string

The provider-assigned unique ID for this managed resource.

TenantId string

The Tenant ID for the AAD B2C tenant.

billingType String

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

effectiveStartDate String

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

id String

The provider-assigned unique ID for this managed resource.

tenantId String

The Tenant ID for the AAD B2C tenant.

billingType string

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

effectiveStartDate string

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

id string

The provider-assigned unique ID for this managed resource.

tenantId string

The Tenant ID for the AAD B2C tenant.

billing_type str

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

effective_start_date str

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

id str

The provider-assigned unique ID for this managed resource.

tenant_id str

The Tenant ID for the AAD B2C tenant.

billingType String

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

effectiveStartDate String

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

id String

The provider-assigned unique ID for this managed resource.

tenantId String

The Tenant ID for the AAD B2C tenant.

Look up an Existing Directory Resource

Get an existing Directory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DirectoryState, opts?: CustomResourceOptions): Directory
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        billing_type: Optional[str] = None,
        country_code: Optional[str] = None,
        data_residency_location: Optional[str] = None,
        display_name: Optional[str] = None,
        domain_name: Optional[str] = None,
        effective_start_date: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_id: Optional[str] = None) -> Directory
func GetDirectory(ctx *Context, name string, id IDInput, state *DirectoryState, opts ...ResourceOption) (*Directory, error)
public static Directory Get(string name, Input<string> id, DirectoryState? state, CustomResourceOptions? opts = null)
public static Directory get(String name, Output<String> id, DirectoryState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
BillingType string

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

CountryCode string

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

DataResidencyLocation string

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

DisplayName string

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

DomainName string

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

EffectiveStartDate string

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

ResourceGroupName string

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

SkuName string

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the AAD B2C Directory.

TenantId string

The Tenant ID for the AAD B2C tenant.

BillingType string

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

CountryCode string

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

DataResidencyLocation string

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

DisplayName string

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

DomainName string

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

EffectiveStartDate string

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

ResourceGroupName string

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

SkuName string

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

Tags map[string]string

A mapping of tags which should be assigned to the AAD B2C Directory.

TenantId string

The Tenant ID for the AAD B2C tenant.

billingType String

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

countryCode String

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

dataResidencyLocation String

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

displayName String

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

domainName String

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

effectiveStartDate String

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

resourceGroupName String

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

skuName String

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

tags Map<String,String>

A mapping of tags which should be assigned to the AAD B2C Directory.

tenantId String

The Tenant ID for the AAD B2C tenant.

billingType string

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

countryCode string

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

dataResidencyLocation string

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

displayName string

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

domainName string

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

effectiveStartDate string

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

resourceGroupName string

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

skuName string

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

tags {[key: string]: string}

A mapping of tags which should be assigned to the AAD B2C Directory.

tenantId string

The Tenant ID for the AAD B2C tenant.

billing_type str

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

country_code str

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

data_residency_location str

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

display_name str

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

domain_name str

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

effective_start_date str

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

resource_group_name str

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

sku_name str

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

tags Mapping[str, str]

A mapping of tags which should be assigned to the AAD B2C Directory.

tenant_id str

The Tenant ID for the AAD B2C tenant.

billingType String

The type of billing for the AAD B2C tenant. Possible values include: MAU or Auths.

countryCode String

Country code of the B2C tenant. The country_code should be valid for the specified data_residency_location. See official docs for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

dataResidencyLocation String

Location in which the B2C tenant is hosted and data resides. The data_residency_location should be valid for the specified country_code. See official docs for more information. Changing this forces a new AAD B2C Directory to be created.

displayName String

The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.

domainName String

Domain name of the B2C tenant, including the .onmicrosoft.com suffix. Changing this forces a new AAD B2C Directory to be created.

effectiveStartDate String

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

resourceGroupName String

The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.

skuName String

Billing SKU for the B2C tenant. Must be one of: PremiumP1 or PremiumP2 (Standard is not supported). See official docs for more information.

tags Map<String>

A mapping of tags which should be assigned to the AAD B2C Directory.

tenantId String

The Tenant ID for the AAD B2C tenant.

Import

AAD B2C Directories can be imported using the resource id, e.g.

 $ pulumi import azure:aadb2c/directory:Directory example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/example-resource-group/providers/Microsoft.AzureActiveDirectory/b2cDirectories/directory-name

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.