1. Packages
  2. Azure Native
  3. API Docs
  4. azureactivedirectory
  5. B2CTenant
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

azure-native.azureactivedirectory.B2CTenant

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi

    Azure REST API version: 2021-04-01. Prior API version in Azure Native 1.x: 2019-01-01-preview

    Example Usage

    Create tenant

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var b2cTenant = new AzureNative.AzureActiveDirectory.B2CTenant("b2cTenant", new()
        {
            CountryCode = "US",
            DisplayName = "Contoso",
            Location = "United States",
            ResourceGroupName = "contosoResourceGroup",
            ResourceName = "contoso.onmicrosoft.com",
            Sku = new AzureNative.AzureActiveDirectory.Inputs.B2CResourceSKUArgs
            {
                Name = "Standard",
                Tier = "A0",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/azureactivedirectory/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := azureactivedirectory.NewB2CTenant(ctx, "b2cTenant", &azureactivedirectory.B2CTenantArgs{
    			CountryCode:       pulumi.String("US"),
    			DisplayName:       pulumi.String("Contoso"),
    			Location:          pulumi.String("United States"),
    			ResourceGroupName: pulumi.String("contosoResourceGroup"),
    			ResourceName:      pulumi.String("contoso.onmicrosoft.com"),
    			Sku: &azureactivedirectory.B2CResourceSKUArgs{
    				Name: pulumi.String("Standard"),
    				Tier: pulumi.String("A0"),
    			},
    		})
    		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.azurenative.azureactivedirectory.B2CTenant;
    import com.pulumi.azurenative.azureactivedirectory.B2CTenantArgs;
    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 b2cTenant = new B2CTenant("b2cTenant", B2CTenantArgs.builder()        
                .countryCode("US")
                .displayName("Contoso")
                .location("United States")
                .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",
        country_code="US",
        display_name="Contoso",
        location="United States",
        resource_group_name="contosoResourceGroup",
        resource_name_="contoso.onmicrosoft.com",
        sku=azure_native.azureactivedirectory.B2CResourceSKUArgs(
            name="Standard",
            tier="A0",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const b2cTenant = new azure_native.azureactivedirectory.B2CTenant("b2cTenant", {
        countryCode: "US",
        displayName: "Contoso",
        location: "United States",
        resourceGroupName: "contosoResourceGroup",
        resourceName: "contoso.onmicrosoft.com",
        sku: {
            name: "Standard",
            tier: "A0",
        },
    });
    
    resources:
      b2cTenant:
        type: azure-native:azureactivedirectory:B2CTenant
        properties:
          countryCode: US
          displayName: Contoso
          location: United States
          resourceGroupName: contosoResourceGroup
          resourceName: contoso.onmicrosoft.com
          sku:
            name: Standard
            tier: A0
    

    Create B2CTenant Resource

    new B2CTenant(name: string, args: B2CTenantArgs, opts?: CustomResourceOptions);
    @overload
    def B2CTenant(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  country_code: Optional[str] = None,
                  display_name: Optional[str] = None,
                  location: Optional[str] = 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:

    ResourceGroupName string

    The name of the resource group.

    Sku Pulumi.AzureNative.AzureActiveDirectory.Inputs.B2CResourceSKU

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

    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 Azure AD B2C tenant.

    Location string

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

    ResourceName string

    The initial domain name of the Azure AD B2C tenant.

    Tags Dictionary<string, string>

    Resource Tags

    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.

    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 Azure AD B2C tenant.

    Location string

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

    ResourceName string

    The initial domain name of the Azure AD B2C tenant.

    Tags map[string]string

    Resource Tags

    resourceGroupName String

    The name of the resource group.

    sku B2CResourceSKU

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

    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 Azure AD B2C tenant.

    location String

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

    resourceName String

    The initial domain name of the Azure AD B2C tenant.

    tags Map<String,String>

    Resource Tags

    resourceGroupName string

    The name of the resource group.

    sku B2CResourceSKU

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

    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 Azure AD B2C tenant.

    location string

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

    resourceName string

    The initial domain name of the Azure AD B2C tenant.

    tags {[key: string]: string}

    Resource Tags

    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.

    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 Azure AD B2C tenant.

    location str

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

    resource_name str

    The initial domain name of the Azure AD B2C tenant.

    tags Mapping[str, str]

    Resource Tags

    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.

    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 Azure AD B2C tenant.

    location String

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

    resourceName String

    The initial domain name of the Azure AD 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 Azure AD B2C tenant resource.

    SystemData Pulumi.AzureNative.AzureActiveDirectory.Outputs.SystemDataResponse

    Metadata pertaining to creation and last modification of the 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 Azure AD B2C tenant.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the Azure AD B2C tenant resource.

    SystemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    Type string

    The type of the B2C tenant resource.

    BillingConfig B2CTenantResourcePropertiesResponseBillingConfig

    The billing configuration for the tenant.

    TenantId string

    An identifier of the Azure AD B2C tenant.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the Azure AD B2C tenant resource.

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    type String

    The type of the B2C tenant resource.

    billingConfig B2CTenantResourcePropertiesResponseBillingConfig

    The billing configuration for the tenant.

    tenantId String

    An identifier of the Azure AD B2C tenant.

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The name of the Azure AD B2C tenant resource.

    systemData SystemDataResponse

    Metadata pertaining to creation and last modification of the resource.

    type string

    The type of the B2C tenant resource.

    billingConfig B2CTenantResourcePropertiesResponseBillingConfig

    The billing configuration for the tenant.

    tenantId string

    An identifier of the Azure AD B2C tenant.

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The name of the Azure AD B2C tenant resource.

    system_data SystemDataResponse

    Metadata pertaining to creation and last modification of the 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 Azure AD B2C tenant.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the Azure AD B2C tenant resource.

    systemData Property Map

    Metadata pertaining to creation and last modification of the 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 Azure AD B2C tenant.

    Supporting Types

    B2CResourceSKU, B2CResourceSKUArgs

    Name string | B2CResourceSKUName

    The name of the SKU for the tenant.

    Tier string | B2CResourceSKUTier

    The tier of the tenant.

    name String | B2CResourceSKUName

    The name of the SKU for the tenant.

    tier String | B2CResourceSKUTier

    The tier of the tenant.

    name string | B2CResourceSKUName

    The name of the SKU for the tenant.

    tier string | B2CResourceSKUTier

    The tier of the tenant.

    name str | B2CResourceSKUName

    The name of the SKU for the tenant.

    tier str | B2CResourceSKUTier

    The tier of the tenant.

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

    The name of the SKU for the tenant.

    tier String | "A0"

    The tier of the tenant.

    B2CResourceSKUName, B2CResourceSKUNameArgs

    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, B2CResourceSKUResponseArgs

    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, B2CResourceSKUTierArgs

    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, B2CTenantResourcePropertiesResponseBillingConfigArgs

    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.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    CreatedAt string

    The timestamp of resource creation (UTC).

    CreatedBy string

    The identity that created the resource.

    CreatedByType string

    The type of identity that created the resource.

    LastModifiedAt string

    The timestamp of resource last modification (UTC)

    LastModifiedBy string

    The identity that last modified the resource.

    LastModifiedByType string

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    createdAt string

    The timestamp of resource creation (UTC).

    createdBy string

    The identity that created the resource.

    createdByType string

    The type of identity that created the resource.

    lastModifiedAt string

    The timestamp of resource last modification (UTC)

    lastModifiedBy string

    The identity that last modified the resource.

    lastModifiedByType string

    The type of identity that last modified the resource.

    created_at str

    The timestamp of resource creation (UTC).

    created_by str

    The identity that created the resource.

    created_by_type str

    The type of identity that created the resource.

    last_modified_at str

    The timestamp of resource last modification (UTC)

    last_modified_by str

    The identity that last modified the resource.

    last_modified_by_type str

    The type of identity that last modified the resource.

    createdAt String

    The timestamp of resource creation (UTC).

    createdBy String

    The identity that created the resource.

    createdByType String

    The type of identity that created the resource.

    lastModifiedAt String

    The timestamp of resource last modification (UTC)

    lastModifiedBy String

    The identity that last modified the resource.

    lastModifiedByType String

    The type of identity that last modified the resource.

    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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi