B2C Tenants - Create

Referentie

Service:: Azure AD B2C

API Version:: 2021-04-01

Start een asynchrone aanvraag om zowel de Azure AD B2C-tenant als de bijbehorende Azure-resource te maken die is gekoppeld aan een abonnement.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
resourceName	path	True	string	De oorspronkelijke domeinnaam van de Azure AD B2C-tenant.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De locatie waar de resource wordt gehost en waar de gegevens zich bevinden. Kan een van de 'Verenigde Staten', 'Europa', 'Azië en Stille Oceaan' of 'Australië' zijn. Raadpleeg deze documentatie voor meer informatie.
sku	True	B2CResourceSKU	SKU-eigenschappen van de Azure AD B2C-tenant. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Landcode van de Azure-tenant (bijvoorbeeld 'VS'). Raadpleeg aka.ms/B2CDataResidency om geldige landcodes en bijbehorende locaties voor gegevenslocatie weer te geven. Als u geen landcode ziet op een geldige locatie voor gegevenslocatie, kiest u er een in de lijst.
properties.createTenantProperties.displayName		string	De weergavenaam van de Azure AD B2C-tenant.
tags		object	Resourcelabels

Antwoorden

Name	Type	Description
200 OK	B2CTenantResource	OK: antwoord van de URL in locatieheader als de asynchrone bewerking is geslaagd. De resource wordt gemaakt.
202 Accepted		Azure AD aanvraag voor het maken van B2C-tenants is geaccepteerd. De locatieheader geeft de URL/locatie aan waarop moet worden gecontroleerd om de asynchrone status van de bewerking op te halen. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

B2CTenantResource

OK: antwoord van de URL in locatieheader als de asynchrone bewerking is geslaagd. De resource wordt gemaakt.

202 Accepted

Azure AD aanvraag voor het maken van B2C-tenants is geaccepteerd. De locatieheader geeft de URL/locatie aan waarop moet worden gecontroleerd om de asynchrone status van de bewerking op te halen.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

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

Sample Response

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

Definities

Name	Description
B2CResourceSKU	SKU-eigenschappen van de Azure AD B2C-tenant. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.
B2CResourceSKUName	De naam van de SKU voor de tenant.
B2CResourceSKUTier	De laag van de tenant.
B2CTenantResource
BillingConfig	De factureringsconfiguratie voor de tenant.
BillingType	Het type facturering. Wordt MAU voor alle nieuwe klanten. Als 'Auths', kan deze worden bijgewerkt naar 'MAU'. Kan niet worden gewijzigd als de waarde 'MAU' is. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.
CloudError	Een foutreactie voor een resourcebeheeraanvraag.
createdByType	Het type identiteit waarmee de resource is gemaakt.
CreateTenantRequestBody	De informatie die nodig is voor het maken van de Azure AD B2C-tenant en de bijbehorende Azure-resource, die wordt gebruikt voor factureringsdoeleinden.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
TypeValue	Het type van de B2C-tenantresource.

B2CResourceSKU

SKU-eigenschappen van de Azure AD B2C-tenant. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.

Name	Type	Description
name	B2CResourceSKUName	De naam van de SKU voor de tenant.
tier	B2CResourceSKUTier	De laag van de tenant.

B2CResourceSKUName

De naam van de SKU voor de tenant.

Name	Type	Description
PremiumP1	string	Azure AD B2C-gebruik wordt gefactureerd aan een gekoppeld Azure-abonnement en wordt gebruikgemaakt van het aantal verificaties op basis van facturering.
PremiumP2	string	Azure AD B2C-gebruik wordt gefactureerd aan een gekoppeld Azure-abonnement en wordt gebruikgemaakt van het aantal verificaties op basis van facturering.
Standard	string	Azure AD B2C-gebruik wordt gefactureerd voor een gekoppeld Azure-abonnement en maakt gebruik van een factureringsmodel voor maandelijks actieve gebruikers (MAU).

B2CResourceSKUTier

De laag van de tenant.

Name	Type	Description
A0	string	De SKU-laag die wordt gebruikt voor alle Azure AD B2C-tenants.

B2CTenantResource

Name	Type	Description
id	string	Een id die de Azure AD B2C-tenantresource vertegenwoordigt.
location	string	De locatie waar de resource wordt gehost en waar de gegevens zich bevinden. Kan een van de 'Verenigde Staten', 'Europa', 'Azië en Stille Oceaan' of 'Australië' zijn. Raadpleeg deze documentatie voor meer informatie.
name	string	De naam van de Azure AD B2C-tenantresource.
properties.billingConfig	BillingConfig	De factureringsconfiguratie voor de tenant.
properties.tenantId	string	Een id van de Azure AD B2C-tenant.
sku	B2CResourceSKU	SKU-eigenschappen van de Azure AD B2C-tenant. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.
systemData	systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
tags	object	Resourcelabels
type	TypeValue	Het type van de B2C-tenantresource.

BillingConfig

De factureringsconfiguratie voor de tenant.

Name	Type	Description
billingType	BillingType	Het type facturering. Wordt MAU voor alle nieuwe klanten. Als 'Auths', kan deze worden bijgewerkt naar 'MAU'. Kan niet worden gewijzigd als de waarde 'MAU' is. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.
effectiveStartDateUtc	string	De gegevens waaruit het factureringstype van kracht is geworden

BillingType

Het type facturering. Wordt MAU voor alle nieuwe klanten. Als 'Auths', kan deze worden bijgewerkt naar 'MAU'. Kan niet worden gewijzigd als de waarde 'MAU' is. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.

Name	Type	Description
Auths	string	Azure AD B2C-gebruik wordt gefactureerd aan een gekoppeld Azure-abonnement en wordt gebruikgemaakt van het aantal verificaties op basis van facturering.
MAU	string	Azure AD B2C-gebruik wordt gefactureerd voor een gekoppeld Azure-abonnement en maakt gebruik van een factureringsmodel voor maandelijks actieve gebruikers (MAU).

CloudError

Een foutreactie voor een resourcebeheeraanvraag.

Name	Type	Description
error	ErrorResponse	Foutreactie Algemene foutreactie voor alle Azure Resource Manager API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de OData-foutreactieindeling.)

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

De informatie die nodig is voor het maken van de Azure AD B2C-tenant en de bijbehorende Azure-resource, die wordt gebruikt voor factureringsdoeleinden.

Name	Type	Description
location	string	De locatie waar de resource wordt gehost en waar de gegevens zich bevinden. Kan een van de 'Verenigde Staten', 'Europa', 'Azië en Stille Oceaan' of 'Australië' zijn. Raadpleeg deze documentatie voor meer informatie.
properties.createTenantProperties.countryCode	string	Landcode van de Azure-tenant (bijvoorbeeld 'VS'). Raadpleeg aka.ms/B2CDataResidency om geldige landcodes en bijbehorende locaties voor gegevenslocatie weer te geven. Als u geen landcode ziet op een geldige locatie voor gegevenslocatie, kiest u er een in de lijst.
properties.createTenantProperties.displayName	string	De weergavenaam van de Azure AD B2C-tenant.
sku	B2CResourceSKU	SKU-eigenschappen van de Azure AD B2C-tenant. Meer informatie over Azure AD B2C-facturering vindt u op aka.ms/b2cBilling.
tags	object	Resourcelabels

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

TypeValue

Het type van de B2C-tenantresource.

Name	Type	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Het resourcetype voor Azure AD B2C-tenantresource.

B2C Tenants - Create

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Scopes

Voorbeelden

Create tenant

Sample Request

Sample Response

Definities

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Aanvullende resources