B2C Tenants - Create

Dienst:: Azure AD B2C

API-Version:: 2021-04-01

Initiiert eine asynchrone Anforderung zum Erstellen des Azure AD B2C-Mandanten und der entsprechenden Azure-Ressource, 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 Daten befinden. Dies kann eine der "Vereinigten Staaten", "Europa", "Asien-Pazifik" oder "Australien" sein. Weitere Informationen finden Sie in dieser Dokumentation.
sku	True	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Ländercode des Azure-Mandanten (z. B. "US"). Siehe aka.ms/B2CDataResidency, um gültige Ländercodes und entsprechende Datenspeicherorte anzuzeigen. Wenn in einem gültigen Datenspeicherort kein Ländercode angezeigt wird, wählen Sie einen aus der Liste aus.
properties.createTenantProperties.displayName		string	Der Anzeigename des Azure AD B2C-Mandanten.
tags		object	Ressourcentags

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-Mandantenanforderung zum Erstellen einer akzeptierten Anforderung. Der Location-Header gibt die URL/den Speicherort an, in der überprüft werden soll, um den asynchronen Status des Vorgangs abzurufen. Header Location: string Retry-After: string
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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-Mandantenanforderung zum Erstellen einer akzeptierten Anforderung. Der Location-Header gibt die URL/den Speicherort an, in der überprüft werden soll, um den asynchronen Status des Vorgangs abzurufen.

Header

Location: string
Retry-After: string

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Beispielanforderung

HTTP

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"
    }
  }
}

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. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei 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	Die Art der Abrechnung. Wird MAU für alle neuen Kunden sein. Wenn 'Auths', kann sie auf 'MAU' aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" lautet. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CreateTenantRequestBody	Die Zum Erstellen des Azure AD B2C-Mandanten und der entsprechenden Azure-Ressource erforderlichen Informationen, die für Abrechnungszwecke verwendet werden.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TypeValue	Der Typ der B2C-Mandantenressource.

B2CResourceSKU

Objekt

SKU-Eigenschaften des Azure AD B2C-Mandanten. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.

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

B2CResourceSKUName

Enumeration

Der Name der SKU für den Mandanten.

Wert	Beschreibung
Standard	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet ein monatliches Abrechnungsmodell für aktive Benutzer (MAU).
PremiumP1	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die Anzahl der Authentifizierungsbasierten Abrechnungen.
PremiumP2	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die Anzahl der Authentifizierungsbasierten Abrechnungen.

B2CResourceSKUTier

Enumeration

Die Ebene des Mandanten.

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

B2CTenantResource

Objekt

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 Daten befinden. Dies kann eine der "Vereinigten Staaten", "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. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object	Ressourcentags
type	TypeValue	Der Typ der B2C-Mandantenressource.

BillingConfig

Objekt

Die Abrechnungskonfiguration für den Mandanten.

Name	Typ	Beschreibung
billingType	BillingType	Die Art der Abrechnung. Wird MAU für alle neuen Kunden sein. Wenn 'Auths', kann sie auf 'MAU' aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" lautet. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.
effectiveStartDateUtc	string	Die Daten, aus denen der Abrechnungstyp wirksam wurde

BillingType

Enumeration

Die Art der Abrechnung. Wird MAU für alle neuen Kunden sein. Wenn 'Auths', kann sie auf 'MAU' aktualisiert werden. Kann nicht geändert werden, wenn der Wert "MAU" lautet. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.

Wert	Beschreibung
MAU	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet ein monatliches Abrechnungsmodell für aktive Benutzer (MAU).
Auths	Die Azure AD B2C-Nutzung wird einem verknüpften Azure-Abonnement in Rechnung gestellt und verwendet die Anzahl der Authentifizierungsbasierten Abrechnungen.

CloudError

Objekt

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

CreateTenantRequestBody

Objekt

Die Zum Erstellen des Azure AD B2C-Mandanten und der entsprechenden Azure-Ressource erforderlichen Informationen, die für Abrechnungszwecke verwendet werden.

Name	Typ	Beschreibung
location	string	Der Speicherort, an dem die Ressource gehostet wird und sich Daten befinden. Dies kann eine der "Vereinigten Staaten", "Europa", "Asien-Pazifik" oder "Australien" sein. Weitere Informationen finden Sie in dieser Dokumentation.
properties.createTenantProperties.countryCode	string	Ländercode des Azure-Mandanten (z. B. "US"). Siehe aka.ms/B2CDataResidency, um gültige Ländercodes und entsprechende Datenspeicherorte anzuzeigen. Wenn in einem gültigen Datenspeicherort kein Ländercode angezeigt wird, wählen Sie einen aus der Liste aus.
properties.createTenantProperties.displayName	string	Der Anzeigename des Azure AD B2C-Mandanten.
sku	B2CResourceSKU	SKU-Eigenschaften des Azure AD B2C-Mandanten. Erfahren Sie mehr über die Azure AD B2C-Abrechnung bei aka.ms/b2cBilling.
tags	object	Ressourcentags

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorResponse

Objekt

Fehlerantwort

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

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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

Enumeration

Der Typ der B2C-Mandantenressource.

Wert	Beschreibung
Microsoft.AzureActiveDirectory/b2cDirectories	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