azure-native-v2.azureactivedirectory.B2CTenant
Explore with Pulumi AI
Azure REST API version: 2021-04-01. Prior API version in Azure Native 1.x: 2019-01-01-preview.
Other available API versions: 2019-01-01-preview, 2023-01-18-preview, 2023-05-17-preview.
Create B2CTenant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new B2CTenant(name: string, args: B2CTenantArgs, opts?: CustomResourceOptions);
@overload
def B2CTenant(resource_name: str,
args: B2CTenantArgs,
opts: Optional[ResourceOptions] = None)
@overload
def B2CTenant(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
sku: Optional[B2CResourceSKUArgs] = None,
country_code: Optional[str] = None,
display_name: Optional[str] = None,
location: Optional[str] = None,
resource_name_: Optional[str] = None,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. B2CTenantArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. B2CTenantArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. B2CTenantArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. B2CTenantArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var b2ctenantResource = new AzureNative.Azureactivedirectory.B2CTenant("b2ctenantResource", new()
{
ResourceGroupName = "string",
Sku =
{
{ "name", "string" },
{ "tier", "string" },
},
CountryCode = "string",
DisplayName = "string",
Location = "string",
ResourceName = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := azureactivedirectory.NewB2CTenant(ctx, "b2ctenantResource", &azureactivedirectory.B2CTenantArgs{
ResourceGroupName: "string",
Sku: map[string]interface{}{
"name": "string",
"tier": "string",
},
CountryCode: "string",
DisplayName: "string",
Location: "string",
ResourceName: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var b2ctenantResource = new B2CTenant("b2ctenantResource", B2CTenantArgs.builder()
.resourceGroupName("string")
.sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.countryCode("string")
.displayName("string")
.location("string")
.resourceName("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
b2ctenant_resource = azure_native.azureactivedirectory.B2CTenant("b2ctenantResource",
resource_group_name=string,
sku={
name: string,
tier: string,
},
country_code=string,
display_name=string,
location=string,
resource_name_=string,
tags={
string: string,
})
const b2ctenantResource = new azure_native.azureactivedirectory.B2CTenant("b2ctenantResource", {
resourceGroupName: "string",
sku: {
name: "string",
tier: "string",
},
countryCode: "string",
displayName: "string",
location: "string",
resourceName: "string",
tags: {
string: "string",
},
});
type: azure-native:azureactivedirectory:B2CTenant
properties:
countryCode: string
displayName: string
location: string
resourceGroupName: string
resourceName: string
sku:
name: string
tier: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The B2CTenant resource accepts the following input properties:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Sku
This property is required. Pulumi.Azure Native. Azure Active Directory. Inputs. B2CResource SKU - SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
- Country
Code 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.
- Display
Name 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.
- Resource
Name Changes to this property will trigger replacement.
- The initial domain name of the Azure AD B2C tenant.
- Dictionary<string, string>
- Resource Tags
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Sku
This property is required. B2CResourceSKUArgs - SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
- Country
Code 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.
- Display
Name 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.
- Resource
Name Changes to this property will trigger replacement.
- The initial domain name of the Azure AD B2C tenant.
- map[string]string
- Resource Tags
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- sku
This property is required. B2CResourceSKU - SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
- country
Code 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.
- display
Name 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.
- resource
Name Changes to this property will trigger replacement.
- The initial domain name of the Azure AD B2C tenant.
- Map<String,String>
- Resource Tags
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- sku
This property is required. B2CResourceSKU - SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
- country
Code 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.
- display
Name 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.
- resource
Name Changes to this property will trigger replacement.
- The initial domain name of the Azure AD B2C tenant.
- {[key: string]: string}
- Resource Tags
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- sku
This property is required. 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 Changes to this property will trigger replacement.
- The initial domain name of the Azure AD B2C tenant.
- Mapping[str, str]
- Resource Tags
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- sku
This property is required. Property Map - SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
- country
Code 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.
- display
Name 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.
- resource
Name Changes to this property will trigger replacement.
- The initial domain name of the Azure AD B2C tenant.
- 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.
- System
Data Pulumi.Azure Native. Azure Active Directory. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the B2C tenant resource.
- Billing
Config Pulumi.Azure Native. Azure Active Directory. Outputs. B2CTenant Resource Properties Response Billing Config - The billing configuration for the tenant.
- Tenant
Id 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.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the B2C tenant resource.
- Billing
Config B2CTenantResource Properties Response Billing Config - The billing configuration for the tenant.
- Tenant
Id 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.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the B2C tenant resource.
- billing
Config B2CTenantResource Properties Response Billing Config - The billing configuration for the tenant.
- tenant
Id 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.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the B2C tenant resource.
- billing
Config B2CTenantResource Properties Response Billing Config - The billing configuration for the tenant.
- tenant
Id 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 SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the B2C tenant resource.
- billing_
config B2CTenantResource Properties Response Billing Config - 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.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the B2C tenant resource.
- billing
Config Property Map - The billing configuration for the tenant.
- tenant
Id String - An identifier of the Azure AD B2C tenant.
Supporting Types
B2CResourceSKU, B2CResourceSKUArgs
- Name
string | Pulumi.
Azure Native. Azure Active Directory. B2CResource SKUName - The name of the SKU for the tenant.
- Tier
string | Pulumi.
Azure Native. Azure Active Directory. B2CResource SKUTier - The tier of the tenant.
- Name
string | B2CResource
SKUName - The name of the SKU for the tenant.
- Tier
string | B2CResource
SKUTier - The tier of the tenant.
- name
String | B2CResource
SKUName - The name of the SKU for the tenant.
- tier
String | B2CResource
SKUTier - The tier of the tenant.
- name
string | B2CResource
SKUName - The name of the SKU for the tenant.
- tier
string | B2CResource
SKUTier - The tier of the tenant.
- name
str | B2CResource
SKUName - The name of the SKU for the tenant.
- tier
str | B2CResource
SKUTier - The tier of the tenant.
- name
String | "Standard" | "Premium
P1" | "Premium P2" - The name of the SKU for the tenant.
- tier String | "A0"
- The tier of the tenant.
B2CResourceSKUName, B2CResourceSKUNameArgs
- Standard
- StandardAzure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
- Premium
P1 - PremiumP1Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- Premium
P2 - PremiumP2Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- B2CResource
SKUName Standard - StandardAzure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
- B2CResource
SKUName Premium P1 - PremiumP1Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- B2CResource
SKUName Premium P2 - PremiumP2Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- Standard
- StandardAzure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
- Premium
P1 - PremiumP1Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- Premium
P2 - PremiumP2Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- Standard
- StandardAzure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
- Premium
P1 - PremiumP1Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- Premium
P2 - PremiumP2Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- STANDARD
- StandardAzure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
- PREMIUM_P1
- PremiumP1Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- PREMIUM_P2
- PremiumP2Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- "Standard"
- StandardAzure AD B2C usage is billed to a linked Azure subscription and uses a monthly active users (MAU) billing model.
- "Premium
P1" - PremiumP1Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
- "Premium
P2" - PremiumP2Azure AD B2C usage is billed to a linked Azure subscription and uses number of authentications based billing.
B2CResourceSKUResponse, B2CResourceSKUResponseArgs
B2CResourceSKUTier, B2CResourceSKUTierArgs
- A0
- A0The SKU tier used for all Azure AD B2C tenants.
- B2CResource
SKUTier A0 - A0The SKU tier used for all Azure AD B2C tenants.
- A0
- A0The SKU tier used for all Azure AD B2C tenants.
- A0
- A0The SKU tier used for all Azure AD B2C tenants.
- A0
- A0The SKU tier used for all Azure AD B2C tenants.
- "A0"
- A0The SKU tier used for all Azure AD B2C tenants.
B2CTenantResourcePropertiesResponseBillingConfig, B2CTenantResourcePropertiesResponseBillingConfigArgs
- Effective
Start Date Utc This property is required. string - The data from which the billing type took effect
- Billing
Type 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 This property is required. string - The data from which the billing type took effect
- Billing
Type 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 This property is required. String - The data from which the billing type took effect
- billing
Type 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 This property is required. string - The data from which the billing type took effect
- billing
Type 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 This property is required. 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.
- effective
Start Date Utc This property is required. String - The data from which the billing type took effect
- billing
Type 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0