B2C Tenants - Create

Referenz

Dienst:: Azure AD B2C

API-Version:: 2021-04-01

Initiiert eine asynchrone Anforderung, um sowohl den Azure AD B2C-Mandanten als auch die entsprechende Azure-Ressource zu erstellen, die mit einem Abonnement verknüpft ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
resourceName	path	True	string	Der ursprüngliche Domänenname des Azure AD B2C-Mandanten.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der Speicherort, an dem die Ressource gehostet wird und sich die Daten befinden. Kann einer von "USA", "Europa", "Asien-Pazifik" oder "Australien" sein. Weitere Informationen finden Sie in dieser Dokumentation .
sku	True	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Ländercode des Azure-Mandanten (z. B. "USA"). Unter aka.ms/B2CDataResidency finden Sie gültige Ländercodes und die entsprechenden Datenresidenzstandorte. Wenn an einem gültigen Datenresidenzstandort keine Ländervorwahl angezeigt wird, wählen Sie eine aus der Liste aus.
properties.createTenantProperties.displayName		string	Der Anzeigename des Azure AD B2C-Mandanten.
tags		object	Ressource Tags

Antworten

Name	Typ	Beschreibung
200 OK	B2CTenantResource	OK: Antwort der URL im Location-Header, wenn der asynchrone Vorgang erfolgreich ist. Die Ressource wird erstellt.
202 Accepted		Azure AD B2C-Mandantenerstellungsanforderung akzeptiert. Der Header Location gibt die URL/den Speicherort an, an dem überprüft werden soll, um die asynchrone status des Vorgangs abzurufen. Header Location: string Retry-After: string
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Name

Typ

Beschreibung

200 OK

B2CTenantResource

OK: Antwort der URL im Location-Header, wenn der asynchrone Vorgang erfolgreich ist. Die Ressource wird erstellt.

202 Accepted

Azure AD B2C-Mandantenerstellungsanforderung akzeptiert. Der Header Location gibt die URL/den Speicherort an, an dem überprüft werden soll, um die asynchrone status des Vorgangs abzurufen.

Header

Location: string
Retry-After: string

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
B2CResourceSKUName	Der Name der SKU für den Mandanten.
B2CResourceSKUTier	Die Ebene des Mandanten.
B2CTenantResource
BillingConfig	Die Abrechnungskonfiguration für den Mandanten.
BillingType	Der Abrechnungstyp. Wird MAU für alle neuen Kunden sein. Wenn "Authentifizierungen", kann er auf "MAU" aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" ist. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreateTenantRequestBody	Die informationen, die zum Erstellen des Azure AD B2C-Mandanten und der entsprechenden Azure-Ressource erforderlich sind, die zu Abrechnungszwecken verwendet wird.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
TypeValue	Der Typ der B2C-Mandantenressource.

B2CResourceSKU

SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.

Name	Typ	Beschreibung
name	B2CResourceSKUName	Der Name der SKU für den Mandanten.
tier	B2CResourceSKUTier	Die Ebene des Mandanten.

B2CResourceSKUName

Der Name der SKU für den Mandanten.

Name	Typ	Beschreibung
PremiumP1	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die Anzahl der Authentifizierungen basierende Abrechnung.
PremiumP2	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die Anzahl der Authentifizierungen basierende Abrechnung.
Standard	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet ein Abrechnungsmodell für monatliche aktive Benutzer (Monthly Active Users, MAU).

B2CResourceSKUTier

Die Ebene des Mandanten.

Name	Typ	Beschreibung
A0	string	Die SKU-Ebene, die für alle Azure AD B2C-Mandanten verwendet wird.

B2CTenantResource

Name	Typ	Beschreibung
id	string	Ein Bezeichner, der die Azure AD B2C-Mandantenressource darstellt.
location	string	Der Speicherort, an dem die Ressource gehostet wird und sich die Daten befinden. Kann einer von "USA", "Europa", "Asien-Pazifik" oder "Australien" sein. Weitere Informationen finden Sie in dieser Dokumentation .
name	string	Der Name der Azure AD B2C-Mandantenressource.
properties.billingConfig	BillingConfig	Die Abrechnungskonfiguration für den Mandanten.
properties.tenantId	string	Ein Bezeichner des Azure AD B2C-Mandanten.
sku	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
systemData	systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object	Ressource Tags
type	TypeValue	Der Typ der B2C-Mandantenressource.

BillingConfig

Die Abrechnungskonfiguration für den Mandanten.

Name	Typ	Beschreibung
billingType	BillingType	Der Abrechnungstyp. Wird MAU für alle neuen Kunden sein. Wenn "Authentifizierungen", kann er auf "MAU" aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" ist. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
effectiveStartDateUtc	string	Die Daten, aus denen der Abrechnungstyp wirksam wurde

BillingType

Der Abrechnungstyp. Wird MAU für alle neuen Kunden sein. Wenn "Authentifizierungen", kann er auf "MAU" aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" ist. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.

Name	Typ	Beschreibung
Auths	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die Anzahl der Authentifizierungen basierende Abrechnung.
MAU	string	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet ein Abrechnungsmodell für monatliche aktive Benutzer (Monthly Active Users, MAU).

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

Die informationen, die zum Erstellen des Azure AD B2C-Mandanten und der entsprechenden Azure-Ressource erforderlich sind, die zu Abrechnungszwecken verwendet wird.

Name	Typ	Beschreibung
location	string	Der Speicherort, an dem die Ressource gehostet wird und sich die Daten befinden. Kann einer von "USA", "Europa", "Asien-Pazifik" oder "Australien" sein. Weitere Informationen finden Sie in dieser Dokumentation .
properties.createTenantProperties.countryCode	string	Ländercode des Azure-Mandanten (z. B. "USA"). Unter aka.ms/B2CDataResidency finden Sie gültige Ländercodes und die entsprechenden Datenresidenzstandorte. Wenn an einem gültigen Datenresidenzstandort keine Ländervorwahl angezeigt wird, wählen Sie eine aus der Liste aus.
properties.createTenantProperties.displayName	string	Der Anzeigename des Azure AD B2C-Mandanten.
sku	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Weitere Informationen zur Azure AD B2C-Abrechnung finden Sie unter aka.ms/b2cBilling.
tags	object	Ressource Tags

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TypeValue

Der Typ der B2C-Mandantenressource.

Name	Typ	Beschreibung
Microsoft.AzureActiveDirectory/b2cDirectories	string	Der Ressourcentyp für die Azure AD B2C-Mandantenressource.

Freigeben über

B2C Tenants - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Create tenant

Beispielanforderung

Beispiel für eine Antwort

Definitionen

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Zusätzliche Ressourcen