azure-native-v2.azureactivedirectory.CIAMTenant
Explore with Pulumi AI
The Azure AD for customers resource. Azure REST API version: 2023-05-17-preview.
Create CIAMTenant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CIAMTenant(name: string, args: CIAMTenantArgs, opts?: CustomResourceOptions);
@overload
def CIAMTenant(resource_name: str,
args: CIAMTenantArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CIAMTenant(resource_name: str,
opts: Optional[ResourceOptions] = None,
create_tenant_properties: Optional[CreateCIAMTenantPropertiesArgs] = None,
resource_group_name: Optional[str] = None,
sku: Optional[CIAMResourceSKUArgs] = None,
location: Optional[str] = None,
resource_name_: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tenant_id: Optional[str] = None)
func NewCIAMTenant(ctx *Context, name string, args CIAMTenantArgs, opts ...ResourceOption) (*CIAMTenant, error)
public CIAMTenant(string name, CIAMTenantArgs args, CustomResourceOptions? opts = null)
public CIAMTenant(String name, CIAMTenantArgs args)
public CIAMTenant(String name, CIAMTenantArgs args, CustomResourceOptions options)
type: azure-native:azureactivedirectory:CIAMTenant
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. CIAMTenantArgs - 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. CIAMTenantArgs - 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. CIAMTenantArgs - 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. CIAMTenantArgs - 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. CIAMTenantArgs - 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 ciamtenantResource = new AzureNative.Azureactivedirectory.CIAMTenant("ciamtenantResource", new()
{
CreateTenantProperties =
{
{ "countryCode", "string" },
{ "displayName", "string" },
},
ResourceGroupName = "string",
Sku =
{
{ "name", "string" },
{ "tier", "string" },
},
Location = "string",
ResourceName = "string",
Tags =
{
{ "string", "string" },
},
TenantId = "string",
});
example, err := azureactivedirectory.NewCIAMTenant(ctx, "ciamtenantResource", &azureactivedirectory.CIAMTenantArgs{
CreateTenantProperties: map[string]interface{}{
"countryCode": "string",
"displayName": "string",
},
ResourceGroupName: "string",
Sku: map[string]interface{}{
"name": "string",
"tier": "string",
},
Location: "string",
ResourceName: "string",
Tags: map[string]interface{}{
"string": "string",
},
TenantId: "string",
})
var ciamtenantResource = new CIAMTenant("ciamtenantResource", CIAMTenantArgs.builder()
.createTenantProperties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.resourceGroupName("string")
.sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.location("string")
.resourceName("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.tenantId("string")
.build());
ciamtenant_resource = azure_native.azureactivedirectory.CIAMTenant("ciamtenantResource",
create_tenant_properties={
countryCode: string,
displayName: string,
},
resource_group_name=string,
sku={
name: string,
tier: string,
},
location=string,
resource_name_=string,
tags={
string: string,
},
tenant_id=string)
const ciamtenantResource = new azure_native.azureactivedirectory.CIAMTenant("ciamtenantResource", {
createTenantProperties: {
countryCode: "string",
displayName: "string",
},
resourceGroupName: "string",
sku: {
name: "string",
tier: "string",
},
location: "string",
resourceName: "string",
tags: {
string: "string",
},
tenantId: "string",
});
type: azure-native:azureactivedirectory:CIAMTenant
properties:
createTenantProperties:
countryCode: string
displayName: string
location: string
resourceGroupName: string
resourceName: string
sku:
name: string
tier: string
tags:
string: string
tenantId: string
CIAMTenant 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 CIAMTenant resource accepts the following input properties:
- Create
Tenant Properties This property is required. Changes to this property will trigger replacement.
Azure Native. Azure Active Directory. Inputs. Create CIAMTenant Properties - These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Sku
This property is required. Pulumi.Azure Native. Azure Active Directory. Inputs. CIAMResource SKU - SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
- Location
Changes to this property will trigger replacement.
- 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 sub domain of the tenant.
- Dictionary<string, string>
- Resource Tags
- Tenant
Id Changes to this property will trigger replacement.
- An identifier of the Azure AD for customers tenant.
- Create
Tenant Properties This property is required. Changes to this property will trigger replacement.
CIAMTenant Properties Args - These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Sku
This property is required. CIAMResourceSKUArgs - SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
- Location
Changes to this property will trigger replacement.
- 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 sub domain of the tenant.
- map[string]string
- Resource Tags
- Tenant
Id Changes to this property will trigger replacement.
- An identifier of the Azure AD for customers tenant.
- create
Tenant Properties This property is required. Changes to this property will trigger replacement.
CIAMTenant Properties - These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- sku
This property is required. CIAMResourceSKU - SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
- location
Changes to this property will trigger replacement.
- 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 sub domain of the tenant.
- Map<String,String>
- Resource Tags
- tenant
Id Changes to this property will trigger replacement.
- An identifier of the Azure AD for customers tenant.
- create
Tenant Properties This property is required. Changes to this property will trigger replacement.
CIAMTenant Properties - These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- sku
This property is required. CIAMResourceSKU - SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
- location
Changes to this property will trigger replacement.
- 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 sub domain of the tenant.
- {[key: string]: string}
- Resource Tags
- tenant
Id Changes to this property will trigger replacement.
- An identifier of the Azure AD for customers tenant.
- create_
tenant_ properties This property is required. Changes to this property will trigger replacement.
CIAMTenant Properties Args - These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- sku
This property is required. CIAMResourceSKUArgs - SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
- location
Changes to this property will trigger replacement.
- 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 sub domain of the tenant.
- Mapping[str, str]
- Resource Tags
- tenant_
id Changes to this property will trigger replacement.
- An identifier of the Azure AD for customers tenant.
- create
Tenant Properties This property is required. Changes to this property will trigger replacement.
- These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- sku
This property is required. Property Map - SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
- location
Changes to this property will trigger replacement.
- 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 sub domain of the tenant.
- Map<String>
- Resource Tags
- tenant
Id Changes to this property will trigger replacement.
- An identifier of the Azure AD for customers tenant.
Outputs
All input properties are implicitly available as output properties. Additionally, the CIAMTenant resource produces the following output properties:
- Billing
Type string - The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
- Domain
Name string - The domain name of the tenant
- Effective
Start stringDate Utc - The data from which the billing type took effect
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the Azure AD for customers tenant resource.
- Provisioning
State string - 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 Azure AD for customers tenant resource.
- Billing
Type string - The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
- Domain
Name string - The domain name of the tenant
- Effective
Start stringDate Utc - The data from which the billing type took effect
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the Azure AD for customers tenant resource.
- Provisioning
State string - System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the Azure AD for customers tenant resource.
- billing
Type String - The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
- domain
Name String - The domain name of the tenant
- effective
Start StringDate Utc - The data from which the billing type took effect
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the Azure AD for customers tenant resource.
- provisioning
State String - system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the Azure AD for customers tenant resource.
- billing
Type string - The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
- domain
Name string - The domain name of the tenant
- effective
Start stringDate Utc - The data from which the billing type took effect
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the Azure AD for customers tenant resource.
- provisioning
State string - system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the Azure AD for customers tenant resource.
- billing_
type str - The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
- domain_
name str - The domain name of the tenant
- effective_
start_ strdate_ utc - The data from which the billing type took effect
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the Azure AD for customers tenant resource.
- provisioning_
state str - system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the Azure AD for customers tenant resource.
- billing
Type String - The type of billing. Will be MAU for all new customers. Cannot be changed if value is 'MAU'. Learn more about Azure AD for customers billing at aka.ms/b2cBilling.
- domain
Name String - The domain name of the tenant
- effective
Start StringDate Utc - The data from which the billing type took effect
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the Azure AD for customers tenant resource.
- provisioning
State String - system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the Azure AD for customers tenant resource.
Supporting Types
CIAMResourceSKU, CIAMResourceSKUArgs
- Name
This property is required. string | Pulumi.Azure Native. Azure Active Directory. CIAMResource SKUName - The name of the SKU for the tenant.
- Tier
This property is required. string | Pulumi.Azure Native. Azure Active Directory. CIAMResource SKUTier - The tier of the tenant.
- Name
This property is required. string | CIAMResourceSKUName - The name of the SKU for the tenant.
- Tier
This property is required. string | CIAMResourceSKUTier - The tier of the tenant.
- name
This property is required. String | CIAMResourceSKUName - The name of the SKU for the tenant.
- tier
This property is required. String | CIAMResourceSKUTier - The tier of the tenant.
- name
This property is required. string | CIAMResourceSKUName - The name of the SKU for the tenant.
- tier
This property is required. string | CIAMResourceSKUTier - The tier of the tenant.
- name
This property is required. str | CIAMResourceSKUName - The name of the SKU for the tenant.
- tier
This property is required. str | CIAMResourceSKUTier - The tier of the tenant.
- name
This property is required. String | "Standard" | "PremiumP1" | "Premium P2" - The name of the SKU for the tenant.
- tier
This property is required. String | "A0" - The tier of the tenant.
CIAMResourceSKUName, CIAMResourceSKUNameArgs
- Standard
- Standard
- Premium
P1 - PremiumP1
- Premium
P2 - PremiumP2
- CIAMResource
SKUName Standard - Standard
- CIAMResource
SKUName Premium P1 - PremiumP1
- CIAMResource
SKUName Premium P2 - PremiumP2
- Standard
- Standard
- Premium
P1 - PremiumP1
- Premium
P2 - PremiumP2
- Standard
- Standard
- Premium
P1 - PremiumP1
- Premium
P2 - PremiumP2
- STANDARD
- Standard
- PREMIUM_P1
- PremiumP1
- PREMIUM_P2
- PremiumP2
- "Standard"
- Standard
- "Premium
P1" - PremiumP1
- "Premium
P2" - PremiumP2
CIAMResourceSKUResponse, CIAMResourceSKUResponseArgs
CIAMResourceSKUTier, CIAMResourceSKUTierArgs
- A0
- A0The SKU tier used for all Azure AD for customers tenants.
- CIAMResource
SKUTier A0 - A0The SKU tier used for all Azure AD for customers tenants.
- A0
- A0The SKU tier used for all Azure AD for customers tenants.
- A0
- A0The SKU tier used for all Azure AD for customers tenants.
- A0
- A0The SKU tier used for all Azure AD for customers tenants.
- "A0"
- A0The SKU tier used for all Azure AD for customers tenants.
CreateCIAMTenantProperties, CreateCIAMTenantPropertiesArgs
- Country
Code This property is required. string - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. string - The display name of the Azure AD for customers tenant.
- Country
Code This property is required. string - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. string - The display name of the Azure AD for customers tenant.
- country
Code This property is required. String - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. String - The display name of the Azure AD for customers tenant.
- country
Code This property is required. string - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. string - The display name of the Azure AD for customers tenant.
- country_
code This property is required. str - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. str - The display name of the Azure AD for customers tenant.
- country
Code This property is required. String - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. String - The display name of the Azure AD for customers tenant.
CreateCIAMTenantPropertiesResponse, CreateCIAMTenantPropertiesResponseArgs
- Country
Code This property is required. string - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. string - The display name of the Azure AD for customers tenant.
- Country
Code This property is required. string - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. string - The display name of the Azure AD for customers tenant.
- country
Code This property is required. String - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. String - The display name of the Azure AD for customers tenant.
- country
Code This property is required. string - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. string - The display name of the Azure AD for customers tenant.
- country_
code This property is required. str - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. str - The display name of the Azure AD for customers tenant.
- country
Code This property is required. String - Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 This property is required. String - The display name of the Azure AD for customers tenant.
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:CIAMTenant contoso /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{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