Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azureactivedirectory
  5. getB2CTenant
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azureactivedirectory.getB2CTenant

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get the Azure AD B2C tenant resource.

    Uses Azure REST API version 2023-05-17-preview.

    Other available API versions: 2021-04-01, 2023-01-18-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azureactivedirectory [ApiVersion]. See the version guide for details.

    Using getB2CTenant

    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 getB2CTenant(args: GetB2CTenantArgs, opts?: InvokeOptions): Promise<GetB2CTenantResult>
function getB2CTenantOutput(args: GetB2CTenantOutputArgs, opts?: InvokeOptions): Output<GetB2CTenantResult>
    def get_b2_c_tenant(resource_group_name: Optional[str] = None,
                    resource_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetB2CTenantResult
def get_b2_c_tenant_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    resource_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetB2CTenantResult]
    func LookupB2CTenant(ctx *Context, args *LookupB2CTenantArgs, opts ...InvokeOption) (*LookupB2CTenantResult, error)
func LookupB2CTenantOutput(ctx *Context, args *LookupB2CTenantOutputArgs, opts ...InvokeOption) LookupB2CTenantResultOutput

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

    public static class GetB2CTenant 
{
    public static Task<GetB2CTenantResult> InvokeAsync(GetB2CTenantArgs args, InvokeOptions? opts = null)
    public static Output<GetB2CTenantResult> Invoke(GetB2CTenantInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetB2CTenantResult> getB2CTenant(GetB2CTenantArgs args, InvokeOptions options)
public static Output<GetB2CTenantResult> getB2CTenant(GetB2CTenantArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azureactivedirectory:getB2CTenant
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group.
    ResourceName string
    The initial domain name of the Azure AD B2C tenant.
    ResourceGroupName string
    The name of the resource group.
    ResourceName string
    The initial domain name of the Azure AD B2C tenant.
    resourceGroupName String
    The name of the resource group.
    resourceName String
    The initial domain name of the Azure AD B2C tenant.
    resourceGroupName string
    The name of the resource group.
    resourceName string
    The initial domain name of the Azure AD B2C tenant.
    resource_group_name str
    The name of the resource group.
    resource_name str
    The initial domain name of the Azure AD B2C tenant.
    resourceGroupName String
    The name of the resource group.
    resourceName String
    The initial domain name of the Azure AD B2C tenant.

    getB2CTenant Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    An identifier that represents the Azure AD B2C 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 B2C tenant resource.
    Sku Pulumi.AzureNative.AzureActiveDirectory.Outputs.B2CResourceSKUResponse
    SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    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.
    IsGoLocalTenant bool
    Enable GoLocal add-on to store data at rest in the specific Geo. Refer to aka.ms/B2CDataResidency to see local data residency options.
    Tags Dictionary<string, string>
    Resource Tags
    TenantId string
    An identifier of the Azure AD B2C tenant.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    An identifier that represents the Azure AD B2C 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 B2C tenant resource.
    Sku B2CResourceSKUResponse
    SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    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.
    IsGoLocalTenant bool
    Enable GoLocal add-on to store data at rest in the specific Geo. Refer to aka.ms/B2CDataResidency to see local data residency options.
    Tags map[string]string
    Resource Tags
    TenantId string
    An identifier of the Azure AD B2C tenant.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    An identifier that represents the Azure AD B2C 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 B2C tenant resource.
    sku B2CResourceSKUResponse
    SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    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.
    isGoLocalTenant Boolean
    Enable GoLocal add-on to store data at rest in the specific Geo. Refer to aka.ms/B2CDataResidency to see local data residency options.
    tags Map<String,String>
    Resource Tags
    tenantId String
    An identifier of the Azure AD B2C tenant.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    An identifier that represents the Azure AD B2C 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 B2C tenant resource.
    sku B2CResourceSKUResponse
    SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    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.
    isGoLocalTenant boolean
    Enable GoLocal add-on to store data at rest in the specific Geo. Refer to aka.ms/B2CDataResidency to see local data residency options.
    tags {[key: string]: string}
    Resource Tags
    tenantId string
    An identifier of the Azure AD B2C tenant.
    azure_api_version str
    The Azure API version of the resource.
    id str
    An identifier that represents the Azure AD B2C 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 B2C tenant resource.
    sku B2CResourceSKUResponse
    SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    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.
    is_go_local_tenant bool
    Enable GoLocal add-on to store data at rest in the specific Geo. Refer to aka.ms/B2CDataResidency to see local data residency options.
    tags Mapping[str, str]
    Resource Tags
    tenant_id str
    An identifier of the Azure AD B2C tenant.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    An identifier that represents the Azure AD B2C 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 B2C tenant resource.
    sku Property Map
    SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    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.
    isGoLocalTenant Boolean
    Enable GoLocal add-on to store data at rest in the specific Geo. Refer to aka.ms/B2CDataResidency to see local data residency options.
    tags Map<String>
    Resource Tags
    tenantId String
    An identifier of the Azure AD B2C tenant.

    Supporting Types

    B2CResourceSKUResponse

    Name string
    The name of the SKU for the tenant.
    Tier string
    The tier of the tenant.
    Name string
    The name of the SKU for the tenant.
    Tier string
    The tier of the tenant.
    name String
    The name of the SKU for the tenant.
    tier String
    The tier of the tenant.
    name string
    The name of the SKU for the tenant.
    tier string
    The tier of the tenant.
    name str
    The name of the SKU for the tenant.
    tier str
    The tier of the tenant.
    name String
    The name of the SKU for the tenant.
    tier String
    The tier of the tenant.

    B2CTenantResourcePropertiesResponseBillingConfig

    EffectiveStartDateUtc string
    The data from which the billing type took effect
    BillingType string
    The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    EffectiveStartDateUtc string
    The data from which the billing type took effect
    BillingType string
    The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    effectiveStartDateUtc String
    The data from which the billing type took effect
    billingType String
    The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    effectiveStartDateUtc string
    The data from which the billing type took effect
    billingType string
    The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    effective_start_date_utc str
    The data from which the billing type took effect
    billing_type str
    The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.
    effectiveStartDateUtc String
    The data from which the billing type took effect
    billingType String
    The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at aka.ms/b2cBilling.

    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native