B2C Tenants - Create

Référence

Service:: Azure AD B2C

Version d'API:: 2021-04-01

Lance une demande asynchrone pour créer à la fois le locataire Azure AD B2C et la ressource Azure correspondante liée à un abonnement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources.
resourceName	path	True	string	Nom de domaine initial du locataire Azure AD B2C.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement dans lequel la ressource est hébergée et où résident les données. Il peut s’agir de l’un des « États-Unis », « Europe », « Asie-Pacifique » ou « Australie ». Pour plus d’informations, consultez cette documentation .
sku	True	B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Code de pays du locataire Azure (par exemple, « US »). Reportez-vous à aka.ms/B2CDataResidency pour voir les codes de pays valides et les emplacements de résidence des données correspondants. Si vous ne voyez pas de code de pays dans un emplacement de résidence de données valide, choisissez-en un dans la liste.
properties.createTenantProperties.displayName		string	Nom d’affichage du locataire Azure AD B2C.
tags		object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	B2CTenantResource	OK - Réponse de l’URL dans l’en-tête Location si l’opération asynchrone réussit. La ressource sera créée.
202 Accepted		Demande de création de locataire Azure AD B2C acceptée. L’en-tête Location indique l’URL/l’emplacement dans lequel case activée obtenir le status asynchrone de l’opération. En-têtes Location: string Retry-After: string
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Nom

Type

Description

200 OK

B2CTenantResource

OK - Réponse de l’URL dans l’en-tête Location si l’opération asynchrone réussit. La ressource sera créée.

202 Accepted

Demande de création de locataire Azure AD B2C acceptée. L’en-tête Location indique l’URL/l’emplacement dans lequel case activée obtenir le status asynchrone de l’opération.

En-têtes

Location: string
Retry-After: string

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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
}

Code d’état:: 202

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

Définitions

Nom	Description
B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
B2CResourceSKUName	Nom de la référence SKU du locataire.
B2CResourceSKUTier	Niveau du locataire.
B2CTenantResource
BillingConfig	Configuration de facturation pour le locataire.
BillingType	Type de facturation. Sera MAU pour tous les nouveaux clients. Si « Auths », il peut être mis à jour vers « MAU ». Impossible de modifier si la valeur est « MAU ». Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
CloudError	Réponse d’erreur pour une demande de gestion des ressources.
createdByType	Type d’identité qui a créé la ressource.
CreateTenantRequestBody	Informations nécessaires pour créer le locataire Azure AD B2C et la ressource Azure correspondante, qui sont utilisées à des fins de facturation.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TypeValue	Type de la ressource de locataire B2C.

B2CResourceSKU

Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.

Nom	Type	Description
name	B2CResourceSKUName	Nom de la référence SKU du locataire.
tier	B2CResourceSKUTier	Niveau du locataire.

B2CResourceSKUName

Nom de la référence SKU du locataire.

Nom	Type	Description
PremiumP1	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise le nombre de facturations basées sur les authentifications.
PremiumP2	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise le nombre de facturations basées sur les authentifications.
Standard	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise un modèle de facturation mensuel des utilisateurs actifs (MAU).

B2CResourceSKUTier

Niveau du locataire.

Nom	Type	Description
A0	string	Niveau de référence SKU utilisé pour tous les locataires Azure AD B2C.

B2CTenantResource

Nom	Type	Description
id	string	Identificateur qui représente la ressource de locataire Azure AD B2C.
location	string	Emplacement dans lequel la ressource est hébergée et où résident les données. Il peut s’agir de l’un des « États-Unis », « Europe », « Asie-Pacifique » ou « Australie ». Pour plus d’informations, consultez cette documentation .
name	string	Nom de la ressource de locataire Azure AD B2C.
properties.billingConfig	BillingConfig	Configuration de facturation pour le locataire.
properties.tenantId	string	Identificateur du locataire Azure AD B2C.
sku	B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Balises de ressource
type	TypeValue	Type de la ressource de locataire B2C.

BillingConfig

Configuration de facturation pour le locataire.

Nom	Type	Description
billingType	BillingType	Type de facturation. Sera MAU pour tous les nouveaux clients. Si « Auths », il peut être mis à jour vers « MAU ». Impossible de modifier si la valeur est « MAU ». Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
effectiveStartDateUtc	string	Données à partir desquelles le type de facturation a pris effet

BillingType

Type de facturation. Sera MAU pour tous les nouveaux clients. Si « Auths », il peut être mis à jour vers « MAU ». Impossible de modifier si la valeur est « MAU ». Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.

Nom	Type	Description
Auths	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise le nombre de facturations basées sur les authentifications.
MAU	string	L’utilisation d’Azure AD B2C est facturée à un abonnement Azure lié et utilise un modèle de facturation mensuel des utilisateurs actifs (MAU).

CloudError

Réponse d’erreur pour une demande de gestion des ressources.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

Informations nécessaires pour créer le locataire Azure AD B2C et la ressource Azure correspondante, qui sont utilisées à des fins de facturation.

Nom	Type	Description
location	string	Emplacement dans lequel la ressource est hébergée et où résident les données. Il peut s’agir de l’un des « États-Unis », « Europe », « Asie-Pacifique » ou « Australie ». Pour plus d’informations, consultez cette documentation .
properties.createTenantProperties.countryCode	string	Code de pays du locataire Azure (par exemple, « US »). Reportez-vous à aka.ms/B2CDataResidency pour voir les codes de pays valides et les emplacements de résidence des données correspondants. Si vous ne voyez pas de code de pays dans un emplacement de résidence de données valide, choisissez-en un dans la liste.
properties.createTenantProperties.displayName	string	Nom d’affichage du locataire Azure AD B2C.
sku	B2CResourceSKU	Propriétés de la référence SKU du locataire Azure AD B2C. Pour en savoir plus sur la facturation Azure AD B2C , consultez aka.ms/b2cBilling.
tags	object	Balises de ressource

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

TypeValue

Type de la ressource de locataire B2C.

Nom	Type	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Type de ressource pour la ressource de locataire Azure AD B2C.

Partager via

B2C Tenants - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create tenant

Exemple de requête

Exemple de réponse

Définitions

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Ressources supplémentaires