Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

B2CTenant

API Version: 2019-01-01-preview.

Example Usage

Create tenant

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var b2cTenant = new AzureNative.AzureActiveDirectory.B2CTenant("b2cTenant", new AzureNative.AzureActiveDirectory.B2CTenantArgs
        {
            Location = "United States",
            Properties = new AzureNative.AzureActiveDirectory.Inputs.CreateTenantRequestBodyPropertiesArgs
            {
                CountryCode = "US",
                DisplayName = "Contoso",
            },
            ResourceGroupName = "contosoResourceGroup",
            ResourceName = "contoso.onmicrosoft.com",
            Sku = new AzureNative.AzureActiveDirectory.Inputs.B2CResourceSKUArgs
            {
                Name = AzureNative.AzureActiveDirectory.B2CResourceSKUName.Standard,
                Tier = AzureNative.AzureActiveDirectory.B2CResourceSKUTier.A0,
            },
        });
    }

}
package main

import (
	azureactivedirectory "github.com/pulumi/pulumi-azure-native/sdk/go/azure/azureactivedirectory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azureactivedirectory.NewB2CTenant(ctx, "b2cTenant", &azureactivedirectory.B2CTenantArgs{
			Location: pulumi.String("United States"),
			Properties: &azureactivedirectory.CreateTenantRequestBodyPropertiesArgs{
				CountryCode: pulumi.String("US"),
				DisplayName: pulumi.String("Contoso"),
			},
			ResourceGroupName: pulumi.String("contosoResourceGroup"),
			ResourceName:      pulumi.String("contoso.onmicrosoft.com"),
			Sku: &azureactivedirectory.B2CResourceSKUArgs{
				Name: azureactivedirectory.B2CResourceSKUNameStandard,
				Tier: azureactivedirectory.B2CResourceSKUTierA0,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var b2cTenant = new B2CTenant("b2cTenant", B2CTenantArgs.builder()        
            .location("United States")
            .properties(Map.ofEntries(
                Map.entry("countryCode", "US"),
                Map.entry("displayName", "Contoso")
            ))
            .resourceGroupName("contosoResourceGroup")
            .resourceName("contoso.onmicrosoft.com")
            .sku(Map.ofEntries(
                Map.entry("name", "Standard"),
                Map.entry("tier", "A0")
            ))
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

b2c_tenant = azure_native.azureactivedirectory.B2CTenant("b2cTenant",
    location="United States",
    properties=azure_native.azureactivedirectory.CreateTenantRequestBodyPropertiesArgs(
        country_code="US",
        display_name="Contoso",
    ),
    resource_group_name="contosoResourceGroup",
    resource_name_="contoso.onmicrosoft.com",
    sku=azure_native.azureactivedirectory.B2CResourceSKUArgs(
        name=azure_native.azureactivedirectory.B2CResourceSKUName.STANDARD,
        tier=azure_native.azureactivedirectory.B2CResourceSKUTier.A0,
    ))
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const b2cTenant = new azure_native.azureactivedirectory.B2CTenant("b2cTenant", {
    location: "United States",
    properties: {
        countryCode: "US",
        displayName: "Contoso",
    },
    resourceGroupName: "contosoResourceGroup",
    resourceName: "contoso.onmicrosoft.com",
    sku: {
        name: azure_native.azureactivedirectory.B2CResourceSKUName.Standard,
        tier: azure_native.azureactivedirectory.B2CResourceSKUTier.A0,
    },
});
resources:
  b2cTenant:
    type: azure-native:azureactivedirectory:B2CTenant
    properties:
      location: United States
      properties:
        countryCode: US
        displayName: Contoso
      resourceGroupName: contosoResourceGroup
      resourceName: contoso.onmicrosoft.com
      sku:
        name: Standard
        tier: A0

Create a B2CTenant Resource

new B2CTenant(name: string, args: B2CTenantArgs, opts?: CustomResourceOptions);
@overload
def B2CTenant(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              location: Optional[str] = None,
              properties: Optional[CreateTenantRequestBodyPropertiesArgs] = None,
              resource_group_name: Optional[str] = None,
              resource_name_: Optional[str] = None,
              sku: Optional[B2CResourceSKUArgs] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def B2CTenant(resource_name: str,
              args: B2CTenantArgs,
              opts: Optional[ResourceOptions] = None)
func NewB2CTenant(ctx *Context, name string, args B2CTenantArgs, opts ...ResourceOption) (*B2CTenant, error)
public B2CTenant(string name, B2CTenantArgs args, CustomResourceOptions? opts = null)
public B2CTenant(String name, B2CTenantArgs args)
public B2CTenant(String name, B2CTenantArgs args, CustomResourceOptions options)
type: azure-native:azureactivedirectory:B2CTenant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args B2CTenantArgs
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 B2CTenantArgs
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 B2CTenantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args B2CTenantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args B2CTenantArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

B2CTenant 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 B2CTenant resource accepts the following input properties:

Properties Pulumi.AzureNative.AzureActiveDirectory.Inputs.CreateTenantRequestBodyPropertiesArgs
ResourceGroupName string

The name of the resource group.

Sku Pulumi.AzureNative.AzureActiveDirectory.Inputs.B2CResourceSKUArgs

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

Location string

The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information.

ResourceName string

The initial domain name of the B2C tenant.

Tags Dictionary<string, string>

Resource Tags

Properties CreateTenantRequestBodyPropertiesArgs
ResourceGroupName string

The name of the resource group.

Sku B2CResourceSKUArgs

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

Location string

The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information.

ResourceName string

The initial domain name of the B2C tenant.

Tags map[string]string

Resource Tags

properties CreateTenantRequestBodyPropertiesArgs
resourceGroupName String

The name of the resource group.

sku B2CResourceSKUArgs

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

location String

The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information.

resourceName String

The initial domain name of the B2C tenant.

tags Map<String,String>

Resource Tags

properties CreateTenantRequestBodyPropertiesArgs
resourceGroupName string

The name of the resource group.

sku B2CResourceSKUArgs

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

location string

The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information.

resourceName string

The initial domain name of the B2C tenant.

tags {[key: string]: string}

Resource Tags

properties CreateTenantRequestBodyPropertiesArgs
resource_group_name str

The name of the resource group.

sku B2CResourceSKUArgs

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

location str

The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information.

resource_name str

The initial domain name of the B2C tenant.

tags Mapping[str, str]

Resource Tags

properties Property Map
resourceGroupName String

The name of the resource group.

sku Property Map

SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

location String

The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information.

resourceName String

The initial domain name of the B2C tenant.

tags Map<String>

Resource Tags

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the B2C tenant resource.

Type string

The type of the B2C tenant resource.

BillingConfig Pulumi.AzureNative.AzureActiveDirectory.Outputs.B2CTenantResourcePropertiesResponseBillingConfig

The billing configuration for the tenant.

TenantId string

An identifier of the B2C tenant.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the B2C tenant resource.

Type string

The type of the B2C tenant resource.

BillingConfig B2CTenantResourcePropertiesResponseBillingConfig

The billing configuration for the tenant.

TenantId string

An identifier of the B2C tenant.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the B2C tenant resource.

type String

The type of the B2C tenant resource.

billingConfig B2CTenantResourcePropertiesResponseBillingConfig

The billing configuration for the tenant.

tenantId String

An identifier of the B2C tenant.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the B2C tenant resource.

type string

The type of the B2C tenant resource.

billingConfig B2CTenantResourcePropertiesResponseBillingConfig

The billing configuration for the tenant.

tenantId string

An identifier of the B2C tenant.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the B2C tenant resource.

type str

The type of the B2C tenant resource.

billing_config B2CTenantResourcePropertiesResponseBillingConfig

The billing configuration for the tenant.

tenant_id str

An identifier of the B2C tenant.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the B2C tenant resource.

type String

The type of the B2C tenant resource.

billingConfig Property Map

The billing configuration for the tenant.

tenantId String

An identifier of the B2C tenant.

Supporting Types

B2CResourceSKU

Name B2CResourceSKUName

The name of the SKU for the tenant.

Tier B2CResourceSKUTier

The tier of the tenant.

name B2CResourceSKUName

The name of the SKU for the tenant.

tier B2CResourceSKUTier

The tier of the tenant.

name B2CResourceSKUName

The name of the SKU for the tenant.

tier B2CResourceSKUTier

The tier of the tenant.

name B2CResourceSKUName

The name of the SKU for the tenant.

tier B2CResourceSKUTier

The tier of the tenant.

name "Standard" | "PremiumP1" | "PremiumP2"

The name of the SKU for the tenant.

tier "A0"

The tier of the tenant.

B2CResourceSKUName

Standard
Standard

Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

PremiumP1
PremiumP1

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

PremiumP2
PremiumP2

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

B2CResourceSKUNameStandard
Standard

Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

B2CResourceSKUNamePremiumP1
PremiumP1

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

B2CResourceSKUNamePremiumP2
PremiumP2

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

Standard
Standard

Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

PremiumP1
PremiumP1

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

PremiumP2
PremiumP2

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

Standard
Standard

Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

PremiumP1
PremiumP1

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

PremiumP2
PremiumP2

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

STANDARD
Standard

Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

PREMIUM_P1
PremiumP1

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

PREMIUM_P2
PremiumP2

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

"Standard"
Standard

Azure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.

"PremiumP1"
PremiumP1

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

"PremiumP2"
PremiumP2

Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.

B2CResourceSKUResponse

Name string

The name of the SKU for the tenant.

Tier string

The tier of the tenant.

Name string

The name of the SKU for the tenant.

Tier string

The tier of the tenant.

name String

The name of the SKU for the tenant.

tier String

The tier of the tenant.

name string

The name of the SKU for the tenant.

tier string

The tier of the tenant.

name str

The name of the SKU for the tenant.

tier str

The tier of the tenant.

name String

The name of the SKU for the tenant.

tier String

The tier of the tenant.

B2CResourceSKUTier

A0
A0

The SKU tier used for all Azure AD B2C tenants.

B2CResourceSKUTierA0
A0

The SKU tier used for all Azure AD B2C tenants.

A0
A0

The SKU tier used for all Azure AD B2C tenants.

A0
A0

The SKU tier used for all Azure AD B2C tenants.

A0
A0

The SKU tier used for all Azure AD B2C tenants.

"A0"
A0

The SKU tier used for all Azure AD B2C tenants.

B2CTenantResourcePropertiesResponseBillingConfig

EffectiveStartDateUtc string

The data from which the billing type took effect

BillingType string

The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

EffectiveStartDateUtc string

The data from which the billing type took effect

BillingType string

The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

effectiveStartDateUtc String

The data from which the billing type took effect

billingType String

The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

effectiveStartDateUtc string

The data from which the billing type took effect

billingType string

The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

effective_start_date_utc str

The data from which the billing type took effect

billing_type str

The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

effectiveStartDateUtc String

The data from which the billing type took effect

billingType String

The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

CreateTenantRequestBodyProperties

CountryCode string

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

DisplayName string

The display name of the B2C tenant.

CountryCode string

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

DisplayName string

The display name of the B2C tenant.

countryCode String

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

displayName String

The display name of the B2C tenant.

countryCode string

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

displayName string

The display name of the B2C tenant.

country_code str

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

display_name str

The display name of the B2C tenant.

countryCode String

Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list.

displayName String

The display name of the B2C tenant.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:azureactivedirectory:B2CTenant contoso.onmicrosoft.com /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com 

Package Details

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