Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azureactivedirectory
  5. getCIAMTenant
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azureactivedirectory.getCIAMTenant

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the Azure AD for customers tenant resource. Azure REST API version: 2023-05-17-preview.

Using getCIAMTenant

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCIAMTenant(args: GetCIAMTenantArgs, opts?: InvokeOptions): Promise<GetCIAMTenantResult>
function getCIAMTenantOutput(args: GetCIAMTenantOutputArgs, opts?: InvokeOptions): Output<GetCIAMTenantResult>
Copy
def get_ciam_tenant(resource_group_name: Optional[str] = None,
                    resource_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCIAMTenantResult
def get_ciam_tenant_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    resource_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCIAMTenantResult]
Copy
func LookupCIAMTenant(ctx *Context, args *LookupCIAMTenantArgs, opts ...InvokeOption) (*LookupCIAMTenantResult, error)
func LookupCIAMTenantOutput(ctx *Context, args *LookupCIAMTenantOutputArgs, opts ...InvokeOption) LookupCIAMTenantResultOutput
Copy

> Note: This function is named LookupCIAMTenant in the Go SDK.

public static class GetCIAMTenant 
{
    public static Task<GetCIAMTenantResult> InvokeAsync(GetCIAMTenantArgs args, InvokeOptions? opts = null)
    public static Output<GetCIAMTenantResult> Invoke(GetCIAMTenantInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCIAMTenantResult> getCIAMTenant(GetCIAMTenantArgs args, InvokeOptions options)
public static Output<GetCIAMTenantResult> getCIAMTenant(GetCIAMTenantArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azureactivedirectory:getCIAMTenant
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The initial sub domain of the tenant.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The initial sub domain of the tenant.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The initial sub domain of the tenant.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The initial sub domain of the tenant.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The initial sub domain of the tenant.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The initial sub domain of the tenant.

getCIAMTenant Result

The following output properties are available:

BillingType 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.
CreateTenantProperties Pulumi.AzureNative.AzureActiveDirectory.Outputs.CreateCIAMTenantPropertiesResponse
These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
DomainName string
The domain name of the tenant
EffectiveStartDateUtc string
The data from which the billing type took effect
Id string
An identifier that represents the Azure AD for customers tenant resource.
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.
Name string
The name of the Azure AD for customers tenant resource.
ProvisioningState string
Sku Pulumi.AzureNative.AzureActiveDirectory.Outputs.CIAMResourceSKUResponse
SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
SystemData Pulumi.AzureNative.AzureActiveDirectory.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the Azure AD for customers tenant resource.
Tags Dictionary<string, string>
Resource Tags
TenantId string
An identifier of the Azure AD for customers tenant.
BillingType 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.
CreateTenantProperties CreateCIAMTenantPropertiesResponse
These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
DomainName string
The domain name of the tenant
EffectiveStartDateUtc string
The data from which the billing type took effect
Id string
An identifier that represents the Azure AD for customers tenant resource.
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.
Name string
The name of the Azure AD for customers tenant resource.
ProvisioningState string
Sku CIAMResourceSKUResponse
SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the Azure AD for customers tenant resource.
Tags map[string]string
Resource Tags
TenantId string
An identifier of the Azure AD for customers tenant.
billingType 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.
createTenantProperties CreateCIAMTenantPropertiesResponse
These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
domainName String
The domain name of the tenant
effectiveStartDateUtc String
The data from which the billing type took effect
id String
An identifier that represents the Azure AD for customers tenant resource.
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.
name String
The name of the Azure AD for customers tenant resource.
provisioningState String
sku CIAMResourceSKUResponse
SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the Azure AD for customers tenant resource.
tags Map<String,String>
Resource Tags
tenantId String
An identifier of the Azure AD for customers tenant.
billingType 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.
createTenantProperties CreateCIAMTenantPropertiesResponse
These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
domainName string
The domain name of the tenant
effectiveStartDateUtc string
The data from which the billing type took effect
id string
An identifier that represents the Azure AD for customers tenant resource.
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.
name string
The name of the Azure AD for customers tenant resource.
provisioningState string
sku CIAMResourceSKUResponse
SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the Azure AD for customers tenant resource.
tags {[key: string]: string}
Resource Tags
tenantId string
An identifier of the Azure AD for customers tenant.
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.
create_tenant_properties CreateCIAMTenantPropertiesResponse
These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
domain_name str
The domain name of the tenant
effective_start_date_utc str
The data from which the billing type took effect
id str
An identifier that represents the Azure AD for customers tenant resource.
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.
name str
The name of the Azure AD for customers tenant resource.
provisioning_state str
sku CIAMResourceSKUResponse
SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the Azure AD for customers tenant resource.
tags Mapping[str, str]
Resource Tags
tenant_id str
An identifier of the Azure AD for customers tenant.
billingType 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.
createTenantProperties Property Map
These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource.
domainName String
The domain name of the tenant
effectiveStartDateUtc String
The data from which the billing type took effect
id String
An identifier that represents the Azure AD for customers tenant resource.
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.
name String
The name of the Azure AD for customers tenant resource.
provisioningState String
sku Property Map
SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the Azure AD for customers tenant resource.
tags Map<String>
Resource Tags
tenantId String
An identifier of the Azure AD for customers tenant.

Supporting Types

CIAMResourceSKUResponse

Name This property is required. string
The name of the SKU for the tenant.
Tier This property is required. string
The tier of the tenant.
Name This property is required. string
The name of the SKU for the tenant.
Tier This property is required. string
The tier of the tenant.
name This property is required. String
The name of the SKU for the tenant.
tier This property is required. String
The tier of the tenant.
name This property is required. string
The name of the SKU for the tenant.
tier This property is required. string
The tier of the tenant.
name This property is required. str
The name of the SKU for the tenant.
tier This property is required. str
The tier of the tenant.
name This property is required. String
The name of the SKU for the tenant.
tier This property is required. String
The tier of the tenant.

CreateCIAMTenantPropertiesResponse

CountryCode 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.
DisplayName This property is required. string
The display name of the Azure AD for customers tenant.
CountryCode 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.
DisplayName This property is required. string
The display name of the Azure AD for customers tenant.
countryCode 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.
displayName This property is required. String
The display name of the Azure AD for customers tenant.
countryCode 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.
displayName 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.
countryCode 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.
displayName This property is required. String
The display name of the Azure AD for customers tenant.

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native