github.com/crossplane/upjet@v1.3.0/pkg/registry/testdata/azure/r/aadb2c_directory.html.markdown (about)

     1  <!--
     2  SPDX-FileCopyrightText: 2023 The Crossplane Authors <https://crossplane.io>
     3  
     4  SPDX-License-Identifier: Apache-2.0
     5  -->
     6  
     7  ---
     8  
     9  subcategory: "AAD B2C"
    10  layout: "azurerm"
    11  page_title: "Azure Resource Manager: azurerm_aadb2c_directory"
    12  description: |-
    13    Manages an AAD B2C Directory.
    14  ---
    15  
    16  # azurerm_aadb2c_directory
    17  
    18  Manages an AAD B2C Directory.
    19  
    20  ## Example Usage
    21  
    22  ```hcl
    23  resource "azurerm_aadb2c_directory" "example" {
    24    country_code            = "US"
    25    data_residency_location = "United States"
    26    display_name            = "example-b2c-tenant"
    27    domain_name             = "exampleb2ctenant.onmicrosoft.com"
    28    resource_group_name     = "example-rg"
    29    sku_name                = "PremiumP1"
    30  }
    31  ```
    32  
    33  ## Arguments Reference
    34  
    35  The following arguments are supported:
    36  
    37  * `country_code` - (Optional) Country code of the B2C tenant. The `country_code` should be valid for the specified `data_residency_location`. See [official docs](https://aka.ms/B2CDataResidency) for valid country codes. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
    38  
    39  * `data_residency_location` - (Required) Location in which the B2C tenant is hosted and data resides. The `data_residency_location` should be valid for the specified `country_code`. See [official docs](https://aka.ms/B2CDataResidenc) for more information. Changing this forces a new AAD B2C Directory to be created.
    40  
    41  * `display_name` - (Optional) The initial display name of the B2C tenant. Required when creating a new resource. Changing this forces a new AAD B2C Directory to be created.
    42  
    43  * `domain_name` - (Required) Domain name of the B2C tenant, including the `.onmicrosoft.com` suffix. Changing this forces a new AAD B2C Directory to be created.
    44  
    45  * `resource_group_name` - (Required) The name of the Resource Group where the AAD B2C Directory should exist. Changing this forces a new AAD B2C Directory to be created.
    46  
    47  * `sku_name` - (Required) Billing SKU for the B2C tenant. Must be one of: `PremiumP1` or `PremiumP2` (`Standard` is not supported). See [official docs](https://aka.ms/b2cBilling) for more information.
    48  
    49  * `tags` - (Optional) A mapping of tags which should be assigned to the AAD B2C Directory.
    50  
    51  ## Attributes Reference
    52  
    53  In addition to the Arguments listed above - the following Attributes are exported:
    54  
    55  * `id` - The ID of the AAD B2C Directory.
    56  
    57  * `billing_type` - The type of billing for the AAD B2C tenant. Possible values include: `MAU` or `Auths`.
    58  
    59  * `effective_start_date` - The date from which the billing type took effect. May not be populated until after the first billing cycle.
    60  
    61  * `tenant_id` - The Tenant ID for the AAD B2C tenant.
    62  
    63  ## Timeouts
    64  
    65  The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/docs/configuration/resources.html#timeouts) for certain actions:
    66  
    67  * `create` - (Defaults to 30 minutes) Used when creating the AAD B2C Directory.
    68  * `read` - (Defaults to 5 minutes) Used when retrieving the AAD B2C Directory.
    69  * `update` - (Defaults to 30 minutes) Used when updating the AAD B2C Directory.
    70  * `delete` - (Defaults to 30 minutes) Used when deleting the AAD B2C Directory.
    71  
    72  ## Import
    73  
    74  AAD B2C Directories can be imported using the `resource id`, e.g.
    75  
    76  ```shell
    77  terraform import azurerm_aadb2c_directory.example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/example-resource-group/providers/Microsoft.AzureActiveDirectory/b2cDirectories/directory-name
    78  ```