B2C Tenants - Create

Referentie

Service:: Azure AD B2C

API-versie:: 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 initiële domeinnaam van de Azure AD B2C-tenant.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
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 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 Azure-tenant (bijvoorbeeld 'VS'). Raadpleeg aka.ms/B2CDataResidency om geldige landcodes en bijbehorende locaties voor gegevenslocatie te bekijken. Als u geen landcode in een geldige locatie voor gegevenslocatie ziet, kiest u er een in de lijst.
properties.createTenantProperties.displayName		string	De weergavenaam van de Azure AD B2C-tenant.
tags		object	Resourcetags

Antwoorden

Name	Type	Description
200 OK	B2CTenantResource	OK: antwoord van de URL in de locatieheader als de asynchrone bewerking is geslaagd. De resource wordt gemaakt.
202 Accepted		Aanvraag voor maken van Azure AD B2C-tenant geaccepteerd. De locatieheader geeft de URL/locatie aan waarop moet worden gecontroleerd of de asynchrone status van de bewerking wordt weergegeven. Kopteksten 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 de locatieheader als de asynchrone bewerking is geslaagd. De resource wordt gemaakt.

202 Accepted

Aanvraag voor maken van Azure AD B2C-tenant geaccepteerd. De locatieheader geeft de URL/locatie aan waarop moet worden gecontroleerd of de asynchrone status van de bewerking wordt weergegeven.

Kopteksten

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
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeeldrespons

Statuscode:: 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
}

Statuscode:: 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. Zal MAU zijn voor alle nieuwe klanten. Als 'Verificaties' is, 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 foutbericht voor een aanvraag voor resourcebeheer.
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 de laatste wijziging van de resource.
TypeValue	Het type B2C-tenantresource.

B2CResourceSKU

Object

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

Inventarisatie

De naam van de SKU voor de tenant.

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

B2CResourceSKUTier

Inventarisatie

De laag van de tenant.

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

B2CTenantResource

Object

Name	Type	Description
id	string	Een id die de Azure AD B2C-tenantresource vertegenwoordigt.
location	string	De locatie waar de resource wordt gehost en 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 de laatste wijziging van de resource.
tags	object	Resourcetags
type	TypeValue	Het type B2C-tenantresource.

BillingConfig

Object

De factureringsconfiguratie voor de tenant.

Name	Type	Description
billingType	BillingType	Het type facturering. Zal MAU zijn voor alle nieuwe klanten. Als 'Verificaties' is, 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

BillingType

Inventarisatie

Het type facturering. Zal MAU zijn voor alle nieuwe klanten. Als 'Verificaties' is, 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.

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

CloudError

Object

Een foutbericht voor een aanvraag voor resourcebeheer.

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

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

CreateTenantRequestBody

Object

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 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 Azure-tenant (bijvoorbeeld 'VS'). Raadpleeg aka.ms/B2CDataResidency om geldige landcodes en bijbehorende locaties voor gegevenslocatie te bekijken. Als u geen landcode in een geldige locatie voor gegevenslocatie ziet, 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	Resourcetags

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

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

ErrorResponse

Object

Foutreactie

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

systemData

Object

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

Name	Type	Description
createdAt	string (date-time)	De 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 (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TypeValue

Inventarisatie

Het type B2C-tenantresource.

Waarde	Description
Microsoft.AzureActiveDirectory/b2cDirectories	Het resourcetype voor Azure AD B2C-tenantresource.

Delen via

B2C Tenants - Create

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Create tenant

Voorbeeldaanvraag

Voorbeeldrespons

Definities

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Aanvullende resources