Microsoft.AzureActiveDirectory b2cDirectory
Замечания
Клиент B2C можно создать с помощью шаблона ARM или Bicep-файла, но не удается обновить существующий клиент B2C. Кроме того, вы не можете повторно развернуть шаблон с тем же именем клиента. Если необходимо обновить клиент B2C, используйте клиентов B2C — обновление.
Определение ресурсов Bicep
Тип ресурса b2cDirectory можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.AzureActiveDirectory/b2cDirectory, добавьте следующий Bicep в шаблон.
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'
}
}
Значения свойств
B2CResourceSKU
Имя | Описание | Ценность |
---|---|---|
имя | Имя номера SKU для клиента. | PremiumP1 PremiumP2 "Стандартный" |
ярус | Уровень клиента. | "A0" |
CreateTenantProperties
Имя | Описание | Ценность |
---|---|---|
countryCode | Код страны клиента Azure (например, US). Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если код страны не отображается в допустимом расположении данных, выберите его из списка. | струна |
displayName | Отображаемое имя клиента Azure AD B2C. | струна |
isGoLocalTenant | Включите надстройку GoLocal для хранения неактивных данных в определенном географическом месте. Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть параметры расположения локальных данных. | bool |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
Имя | Описание | Ценность |
---|---|---|
createTenantProperties | Эти свойства используются для создания клиента Azure AD B2C. Эти свойства не являются частью ресурса Azure. | CreateTenantProperties |
CreateTenantRequestBodyTags
Имя | Описание | Ценность |
---|
Microsoft.AzureActiveDirectory/b2cDirectory
Имя | Описание | Ценность |
---|---|---|
местоположение | Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации. | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (обязательно) | |
SKU | Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling. | B2CResourceSKU (обязательно) |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
Определение ресурса шаблона ARM
Тип ресурса b2cDirectory можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.AzureActiveDirectory/b2cDirectory, добавьте следующий код JSON в шаблон.
{
"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"
}
}
Значения свойств
B2CResourceSKU
Имя | Описание | Ценность |
---|---|---|
имя | Имя номера SKU для клиента. | PremiumP1 PremiumP2 "Стандартный" |
ярус | Уровень клиента. | "A0" |
CreateTenantProperties
Имя | Описание | Ценность |
---|---|---|
countryCode | Код страны клиента Azure (например, US). Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если код страны не отображается в допустимом расположении данных, выберите его из списка. | струна |
displayName | Отображаемое имя клиента Azure AD B2C. | струна |
isGoLocalTenant | Включите надстройку GoLocal для хранения неактивных данных в определенном географическом месте. Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть параметры расположения локальных данных. | bool |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
Имя | Описание | Ценность |
---|---|---|
createTenantProperties | Эти свойства используются для создания клиента Azure AD B2C. Эти свойства не являются частью ресурса Azure. | CreateTenantProperties |
CreateTenantRequestBodyTags
Имя | Описание | Ценность |
---|
Microsoft.AzureActiveDirectory/b2cDirectory
Имя | Описание | Ценность |
---|---|---|
apiVersion | Версия API | '2023-05-17-preview' |
местоположение | Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации. | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (обязательно) | |
SKU | Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling. | B2CResourceSKU (обязательно) |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
тип | Тип ресурса | "Microsoft.AzureActiveDirectory/b2cDirectory" |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса b2cDirectory можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.AzureActiveDirectory/b2cDirectory, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview"
name = "string"
location = "string"
sku = {
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
createTenantProperties = {
countryCode = "string"
displayName = "string"
isGoLocalTenant = bool
}
}
})
}
Значения свойств
B2CResourceSKU
Имя | Описание | Ценность |
---|---|---|
имя | Имя номера SKU для клиента. | PremiumP1 PremiumP2 "Стандартный" |
ярус | Уровень клиента. | "A0" |
CreateTenantProperties
Имя | Описание | Ценность |
---|---|---|
countryCode | Код страны клиента Azure (например, US). Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если код страны не отображается в допустимом расположении данных, выберите его из списка. | струна |
displayName | Отображаемое имя клиента Azure AD B2C. | струна |
isGoLocalTenant | Включите надстройку GoLocal для хранения неактивных данных в определенном географическом месте. Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть параметры расположения локальных данных. | bool |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
Имя | Описание | Ценность |
---|---|---|
createTenantProperties | Эти свойства используются для создания клиента Azure AD B2C. Эти свойства не являются частью ресурса Azure. | CreateTenantProperties |
CreateTenantRequestBodyTags
Имя | Описание | Ценность |
---|
Microsoft.AzureActiveDirectory/b2cDirectory
Имя | Описание | Ценность |
---|---|---|
местоположение | Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации. | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (обязательно) | |
SKU | Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling. | B2CResourceSKU (обязательно) |
Теги | Теги ресурсов | Словарь имен и значений тегов. |
тип | Тип ресурса | "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview" |