B2C Tenants - Update

Ссылка

Служба:: Azure AD B2C

Версия API:: 2021-04-01

Обновите ресурс клиента B2C Azure AD.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}?api-version=2021-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
resourceName	path	True	string	Начальное доменное имя клиента Azure AD B2C.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Текст запроса

Имя	Тип	Описание
properties.billingConfig	BillingConfig	Конфигурация выставления счетов для клиента.
properties.tenantId	string	Идентификатор клиента Azure AD B2C.
sku	B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.
tags	object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	B2CTenantResource	Обновлен ресурс клиента Azure AD B2C.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update tenant

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com?api-version=2021-04-01

{
  "sku": {
    "name": "PremiumP1"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU"
    }
  },
  "tags": {
    "key": "value"
  }
}

const { ExternalIdentitiesConfigurationClient } = require("@azure/arm-azureadexternalidentities");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update the Azure AD B2C tenant resource.
 *
 * @summary Update the Azure AD B2C tenant resource.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/updateTenant.json
 */
async function updateTenant() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "contosoResourceGroup";
  const resourceName = "contoso.onmicrosoft.com";
  const updateTenantRequestBody = {
    billingConfig: { billingType: "MAU" },
    sku: { name: "PremiumP1" },
    tags: { key: "value" },
  };
  const options = { updateTenantRequestBody };
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const result = await client.b2CTenants.update(resourceGroupName, resourceName, options);
  console.log(result);
}

updateTenant().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "sku": {
    "name": "PremiumP1",
    "tier": "A0"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com",
  "name": "contoso.onmicrosoft.com",
  "location": "United States",
  "tags": {
    "key": "value"
  }
}

Определения

Имя	Описание
B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.
B2CResourceSKUName	Имя номера SKU для клиента.
B2CResourceSKUTier	Уровень клиента.
B2CTenantResource
B2CTenantUpdateRequest	Текст запроса для обновления ресурса клиента Azure AD B2C.
BillingConfig	Конфигурация выставления счетов для клиента.
BillingType	Тип выставления счетов. Будет MAU для всех новых клиентов. Если "Проверка подлинности", ее можно обновить до "MAU". Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.
CloudError	Ответ об ошибке для запроса на управление ресурсами.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Сообщение об ошибке
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
TypeValue	Тип ресурса клиента B2C.

B2CResourceSKU

Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.

Имя	Тип	Описание
name	B2CResourceSKUName	Имя номера SKU для клиента.
tier	B2CResourceSKUTier	Уровень клиента.

B2CResourceSKUName

Имя номера SKU для клиента.

Имя	Тип	Описание
PremiumP1	string	Azure AD использование B2C оплачивается в связанной подписке Azure и использует количество выставления счетов на основе проверки подлинности.
PremiumP2	string	Azure AD использование B2C оплачивается в связанной подписке Azure и использует количество выставления счетов на основе проверки подлинности.
Standard	string	Azure AD использование B2C оплачивается в связанной подписке Azure и использует модель выставления счетов для активных пользователей (MAU).

B2CResourceSKUTier

Уровень клиента.

Имя	Тип	Описание
A0	string	Уровень SKU, используемый для всех клиентов Azure AD B2C.

B2CTenantResource

Имя	Тип	Описание
id	string	Идентификатор, представляющий ресурс клиента Azure AD B2C.
location	string	Расположение, в котором размещен ресурс и находятся данные. Может быть одним из "США", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации .
name	string	Имя ресурса клиента Azure AD B2C.
properties.billingConfig	BillingConfig	Конфигурация выставления счетов для клиента.
properties.tenantId	string	Идентификатор клиента Azure AD B2C.
sku	B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
tags	object	Теги ресурсов
type	TypeValue	Тип ресурса клиента B2C.

B2CTenantUpdateRequest

Текст запроса для обновления ресурса клиента Azure AD B2C.

Имя	Тип	Описание
properties.billingConfig	BillingConfig	Конфигурация выставления счетов для клиента.
properties.tenantId	string	Идентификатор клиента Azure AD B2C.
sku	B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.
tags	object	Теги ресурсов

BillingConfig

Конфигурация выставления счетов для клиента.

Имя	Тип	Описание
billingType	BillingType	Тип выставления счетов. Будет MAU для всех новых клиентов. Если "Проверка подлинности", ее можно обновить до "MAU". Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.
effectiveStartDateUtc	string	Данные, из которых вступил в силу тип выставления счетов

BillingType

Тип выставления счетов. Будет MAU для всех новых клиентов. Если "Проверка подлинности", ее можно обновить до "MAU". Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов Azure AD B2C см. на странице aka.ms/b2cBilling.

Имя	Тип	Описание
Auths	string	Azure AD использование B2C оплачивается в связанной подписке Azure и использует количество выставления счетов на основе проверки подлинности.
MAU	string	Azure AD использование B2C оплачивается в связанной подписке Azure и использует модель выставления счетов для активных пользователей (MAU).

CloudError

Ответ об ошибке для запроса на управление ресурсами.

Имя	Тип	Описание
error	ErrorResponse	Сообщение об ошибке Общие ответы об ошибках для всех API-интерфейсов Azure Resource Manager возвращать сведения об ошибках для неудачных операций. (Это также соответствует формату ответа об ошибке OData.)

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.

TypeValue

Тип ресурса клиента B2C.

Имя	Тип	Описание
Microsoft.AzureActiveDirectory/b2cDirectories	string	Тип ресурса для Azure AD ресурса клиента B2C.

Поделиться через