Microsoft.AzureActiveDirectory b2cDirectories
Anmärkningar
Du kan skapa en B2C-klientorganisation med en ARM-mall eller en Bicep-fil, men du kan inte uppdatera en befintlig B2C-klientorganisation. Du kan inte heller distribuera om en mall med samma klientnamn. Om du behöver uppdatera en B2C-klient använder du B2C-klienter – Uppdatera.
Bicep-resursdefinition
Resurstypen b2cDirectories kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.AzureActiveDirectory/b2cDirectories-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview' = {
location: 'string'
name: 'string'
properties: {
createTenantProperties: {
countryCode: 'string'
displayName: 'string'
isGoLocalTenant: bool
}
}
sku: {
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Egenskapsvärden
B2CResourceSKU
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på SKU:n för klientorganisationen. | "PremiumP1" "PremiumP2" "Standard" |
| Nivå | Klientorganisationens nivå. | "A0" |
CreateTenantProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| countryCode | Landskod för Azure-klientorganisation (t.ex. "USA"). Se aka.ms/B2CDataResidency för att se giltiga landskoder och motsvarande datahemplatser. Om du inte ser någon landskod på en giltig plats för datahemvist väljer du en i listan. | sträng |
| displayName | Visningsnamnet för Azure AD B2C-klientorganisationen. | sträng |
| isGoLocalTenant | Aktivera GoLocal-tillägg för att lagra vilande data i den specifika geo-platsen. Se aka.ms/B2CDataResidency för att se alternativ för lokal dataplacering. | Bool |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| createTenantProperties | De här egenskaperna används för att skapa Azure AD B2C-klientorganisationen. De här egenskaperna ingår inte i Azure-resursen. | CreateTenantProperties |
CreateTenantRequestBodyTags
| Namn | Beskrivning | Värde |
|---|
Microsoft.AzureActiveDirectory/b2cDirectories
| Namn | Beskrivning | Värde |
|---|---|---|
| plats | Platsen där resursen finns och data finns. Kan vara ett av "USA", "Europa", "Asien och Stillahavsområdet" eller "Australien". Mer information finns i den här dokumentationen. | sträng (krävs) |
| Namn | Resursnamnet | sträng (krävs) |
| Egenskaper | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (krävs) | |
| Sku | SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling. | B2CResourceSKU (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
Resursdefinition för ARM-mall
Resurstypen b2cDirectories kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.AzureActiveDirectory/b2cDirectories-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.AzureActiveDirectory/b2cDirectories",
"apiVersion": "2023-05-17-preview",
"name": "string",
"location": "string",
"properties": {
"createTenantProperties": {
"countryCode": "string",
"displayName": "string",
"isGoLocalTenant": "bool"
}
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Egenskapsvärden
B2CResourceSKU
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på SKU:n för klientorganisationen. | "PremiumP1" "PremiumP2" "Standard" |
| Nivå | Klientorganisationens nivå. | "A0" |
CreateTenantProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| countryCode | Landskod för Azure-klientorganisation (t.ex. "USA"). Se aka.ms/B2CDataResidency för att se giltiga landskoder och motsvarande datahemplatser. Om du inte ser någon landskod på en giltig plats för datahemvist väljer du en i listan. | sträng |
| displayName | Visningsnamnet för Azure AD B2C-klientorganisationen. | sträng |
| isGoLocalTenant | Aktivera GoLocal-tillägg för att lagra vilande data i den specifika geo-platsen. Se aka.ms/B2CDataResidency för att se alternativ för lokal dataplacering. | Bool |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| createTenantProperties | De här egenskaperna används för att skapa Azure AD B2C-klientorganisationen. De här egenskaperna ingår inte i Azure-resursen. | CreateTenantProperties |
CreateTenantRequestBodyTags
| Namn | Beskrivning | Värde |
|---|
Microsoft.AzureActiveDirectory/b2cDirectories
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | "2023-05-17-preview" |
| plats | Platsen där resursen finns och data finns. Kan vara ett av "USA", "Europa", "Asien och Stillahavsområdet" eller "Australien". Mer information finns i den här dokumentationen. | sträng (krävs) |
| Namn | Resursnamnet | sträng (krävs) |
| Egenskaper | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (krävs) | |
| Sku | SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling. | B2CResourceSKU (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
| typ | Resurstypen | "Microsoft.AzureActiveDirectory/b2cDirectories" |
Användningsexempel
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen b2cDirectories kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.AzureActiveDirectory/b2cDirectories-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
createTenantProperties = {
countryCode = "string"
displayName = "string"
isGoLocalTenant = bool
}
}
sku = {
name = "string"
tier = "string"
}
}
}
Egenskapsvärden
B2CResourceSKU
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på SKU:n för klientorganisationen. | "PremiumP1" "PremiumP2" "Standard" |
| Nivå | Klientorganisationens nivå. | "A0" |
CreateTenantProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| countryCode | Landskod för Azure-klientorganisation (t.ex. "USA"). Se aka.ms/B2CDataResidency för att se giltiga landskoder och motsvarande datahemplatser. Om du inte ser någon landskod på en giltig plats för datahemvist väljer du en i listan. | sträng |
| displayName | Visningsnamnet för Azure AD B2C-klientorganisationen. | sträng |
| isGoLocalTenant | Aktivera GoLocal-tillägg för att lagra vilande data i den specifika geo-platsen. Se aka.ms/B2CDataResidency för att se alternativ för lokal dataplacering. | Bool |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| createTenantProperties | De här egenskaperna används för att skapa Azure AD B2C-klientorganisationen. De här egenskaperna ingår inte i Azure-resursen. | CreateTenantProperties |
CreateTenantRequestBodyTags
| Namn | Beskrivning | Värde |
|---|
Microsoft.AzureActiveDirectory/b2cDirectories
| Namn | Beskrivning | Värde |
|---|---|---|
| plats | Platsen där resursen finns och data finns. Kan vara ett av "USA", "Europa", "Asien och Stillahavsområdet" eller "Australien". Mer information finns i den här dokumentationen. | sträng (krävs) |
| Namn | Resursnamnet | sträng (krävs) |
| Egenskaper | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (krävs) | |
| Sku | SKU-egenskaper för Azure AD B2C-klientorganisationen. Läs mer om Azure AD B2C-fakturering på aka.ms/b2cBilling. | B2CResourceSKU (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
| typ | Resurstypen | "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview" |