B2C Tenants - Create

Referencia

Servicio:: Azure AD B2C

Versión de la API:: 2021-04-01

Inicia una solicitud asincrónica para crear el inquilino de Azure AD B2C y el recurso de Azure correspondiente vinculado a una suscripción.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
resourceName	path	True	string	Nombre de dominio inicial del inquilino de Azure AD B2C.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	La ubicación en la que se hospeda el recurso y los datos residen. Puede ser uno de los "Estados Unidos", "Europa", "Asia Pacífico" o "Australia". Consulte esta documentación para obtener más información.
sku	True	B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Código de país del inquilino de Azure (por ejemplo, "US"). Consulte aka.ms/B2CDataResidency para ver los códigos de país válidos y las ubicaciones de residencia de datos correspondientes. Si no ve un código de país en una ubicación de residencia de datos válida, elija uno de la lista.
properties.createTenantProperties.displayName		string	Nombre para mostrar del inquilino de Azure AD B2C.
tags		object	Etiquetas del recurso

Respuestas

Nombre	Tipo	Description
200 OK	B2CTenantResource	Aceptar: respuesta de la dirección URL en el encabezado Ubicación si la operación asincrónica se realiza correctamente. Se creará el recurso.
202 Accepted		Solicitud de creación de inquilinos de Azure AD B2C aceptada. El encabezado Location indica la dirección URL o ubicación en la que se va a comprobar el estado asincrónico de la operación. Encabezados Location: string Retry-After: string
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Nombre

Tipo

Description

200 OK

B2CTenantResource

Aceptar: respuesta de la dirección URL en el encabezado Ubicación si la operación asincrónica se realiza correctamente. Se creará el recurso.

202 Accepted

Solicitud de creación de inquilinos de Azure AD B2C aceptada. El encabezado Location indica la dirección URL o ubicación en la que se va a comprobar el estado asincrónico de la operación.

Encabezados

Location: string
Retry-After: string

Other Status Codes

CloudError

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Create tenant

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

{
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    }
  }
}

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

/**
 * This sample demonstrates how to Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 *
 * @summary Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/createTenant.json
 */
async function createTenant() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "contosoResourceGroup";
  const resourceName = "contoso.onmicrosoft.com";
  const createTenantRequestBody = {
    countryCode: "US",
    displayName: "Contoso",
    location: "United States",
    sku: { name: "Standard", tier: "A0" },
  };
  const options = { createTenantRequestBody };
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const result = await client.b2CTenants.beginCreateAndWait(
    resourceGroupName,
    resourceName,
    options
  );
  console.log(result);
}

createTenant().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

Respuesta de muestra

status code:: 200

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "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": null
}

status code:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/operations/99999999-9999-9999-9999-999999999999
Retry-After: 60

Definiciones

Nombre	Description
B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
B2CResourceSKUName	Nombre de la SKU para el inquilino.
B2CResourceSKUTier	Nivel del inquilino.
B2CTenantResource
BillingConfig	Configuración de facturación para el inquilino.
BillingType	Tipo de facturación. Será MAU para todos los clientes nuevos. Si es "Auths", se puede actualizar a "MAU". No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
CloudError	Respuesta de error para una solicitud de administración de recursos.
createdByType	Tipo de identidad que creó el recurso.
CreateTenantRequestBody	La información necesaria para crear el inquilino de Azure AD B2C y el recurso de Azure correspondiente, que se usa con fines de facturación.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
TypeValue	Tipo del recurso de inquilino B2C.

B2CResourceSKU

Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.

Nombre	Tipo	Description
name	B2CResourceSKUName	Nombre de la SKU para el inquilino.
tier	B2CResourceSKUTier	Nivel del inquilino.

B2CResourceSKUName

Nombre de la SKU para el inquilino.

Nombre	Tipo	Description
PremiumP1	string	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa el número de autenticaciones basadas en la facturación.
PremiumP2	string	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa el número de autenticaciones basadas en la facturación.
Standard	string	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa un modelo de facturación de usuarios activos mensuales (MAU).

B2CResourceSKUTier

Nivel del inquilino.

Nombre	Tipo	Description
A0	string	Nivel de SKU usado para todos los inquilinos de Azure AD B2C.

B2CTenantResource

Nombre	Tipo	Description
id	string	Identificador que representa el recurso de inquilino de Azure AD B2C.
location	string	La ubicación en la que se hospeda el recurso y los datos residen. Puede ser uno de los "Estados Unidos", "Europa", "Asia Pacífico" o "Australia". Consulte esta documentación para obtener más información.
name	string	Nombre del recurso de inquilino de Azure AD B2C.
properties.billingConfig	BillingConfig	Configuración de facturación para el inquilino.
properties.tenantId	string	Identificador del inquilino de Azure AD B2C.
sku	B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
tags	object	Etiquetas del recurso
type	TypeValue	Tipo del recurso de inquilino B2C.

BillingConfig

Configuración de facturación para el inquilino.

Nombre	Tipo	Description
billingType	BillingType	Tipo de facturación. Será MAU para todos los clientes nuevos. Si es "Auths", se puede actualizar a "MAU". No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
effectiveStartDateUtc	string	Datos a partir de los cuales el tipo de facturación surtió efecto

BillingType

Tipo de facturación. Será MAU para todos los clientes nuevos. Si es "Auths", se puede actualizar a "MAU". No se puede cambiar si el valor es 'MAU'. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.

Nombre	Tipo	Description
Auths	string	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa el número de autenticaciones basadas en la facturación.
MAU	string	El uso de Azure AD B2C se factura a una suscripción de Azure vinculada y usa un modelo de facturación de usuarios activos mensuales (MAU).

CloudError

Respuesta de error para una solicitud de administración de recursos.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

La información necesaria para crear el inquilino de Azure AD B2C y el recurso de Azure correspondiente, que se usa con fines de facturación.

Nombre	Tipo	Description
location	string	La ubicación en la que se hospeda el recurso y los datos residen. Puede ser uno de los "Estados Unidos", "Europa", "Asia Pacífico" o "Australia". Consulte esta documentación para obtener más información.
properties.createTenantProperties.countryCode	string	Código de país del inquilino de Azure (por ejemplo, "US"). Consulte aka.ms/B2CDataResidency para ver los códigos de país válidos y las ubicaciones de residencia de datos correspondientes. Si no ve un código de país en una ubicación de residencia de datos válida, elija uno de la lista.
properties.createTenantProperties.displayName	string	Nombre para mostrar del inquilino de Azure AD B2C.
sku	B2CResourceSKU	Propiedades de SKU del inquilino de Azure AD B2C. Obtenga más información sobre la facturación de Azure AD B2C en aka.ms/b2cBilling.
tags	object	Etiquetas del recurso

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TypeValue

Tipo del recurso de inquilino B2C.

Nombre	Tipo	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Tipo de recurso para el recurso de inquilino de Azure AD B2C.

Compartir a través de

B2C Tenants - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create tenant

Solicitud de ejemplo

Respuesta de muestra

Definiciones

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Recursos adicionales