B2C Tenants - Create

Riferimento

Service:: Azure AD B2C

API Version:: 2021-04-01

Avvia una richiesta asincrona per creare sia il tenant di Azure AD B2C che la risorsa di Azure corrispondente collegata a una sottoscrizione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
resourceName	path	True	string	Nome di dominio iniziale del tenant di Azure AD B2C.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione in cui la risorsa è ospitata e si trovano i dati. Può essere uno dei "Stati Uniti", "Europa", "Asia Pacifico" o "Australia". Per altre informazioni, vedere questa documentazione .
sku	True	B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Codice paese del tenant di Azure ,ad esempio "US". Fare riferimento a aka.ms/B2CDataResidency per visualizzare i codici paese validi e le località di residenza dei dati corrispondenti. Se non viene visualizzato un codice paese in una località di residenza dei dati valida, scegliere uno dall'elenco.
properties.createTenantProperties.displayName		string	Nome visualizzato del tenant di Azure AD B2C.
tags		object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	B2CTenantResource	OK: risposta dell'URL nell'intestazione Location se l'operazione asincrona ha esito positivo. Verrà creata una risorsa.
202 Accepted		Richiesta di creazione del tenant di Azure AD B2C accettata. L'intestazione Location indica l'URL o la posizione in cui verificare per ottenere lo stato asincrono dell'operazione. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

B2CTenantResource

OK: risposta dell'URL nell'intestazione Location se l'operazione asincrona ha esito positivo. Verrà creata una risorsa.

202 Accepted

Richiesta di creazione del tenant di Azure AD B2C accettata. L'intestazione Location indica l'URL o la posizione in cui verificare per ottenere lo stato asincrono dell'operazione.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.
B2CResourceSKUName	Nome dello SKU per il tenant.
B2CResourceSKUTier	Livello del tenant.
B2CTenantResource
BillingConfig	Configurazione di fatturazione per il tenant.
BillingType	Tipo di fatturazione. Sarà MAU per tutti i nuovi clienti. Se 'Auths', può essere aggiornato a 'MAU'. Impossibile modificare se il valore è 'MAU'. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.
CloudError	Risposta di errore per una richiesta di gestione delle risorse.
createdByType	Tipo di identità che ha creato la risorsa.
CreateTenantRequestBody	Le informazioni necessarie per creare il tenant di Azure AD B2C e la risorsa di Azure corrispondente, usata a scopo di fatturazione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta di errore
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TypeValue	Tipo della risorsa tenant B2C.

B2CResourceSKU

Proprietà SKU del tenant di Azure AD B2C. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.

Nome	Tipo	Descrizione
name	B2CResourceSKUName	Nome dello SKU per il tenant.
tier	B2CResourceSKUTier	Livello del tenant.

B2CResourceSKUName

Nome dello SKU per il tenant.

Nome	Tipo	Descrizione
PremiumP1	string	L'utilizzo di Azure AD B2C viene fatturato a una sottoscrizione di Azure collegata e usa il numero di autenticazioni basate sulla fatturazione.
PremiumP2	string	L'utilizzo di Azure AD B2C viene fatturato a una sottoscrizione di Azure collegata e usa il numero di autenticazioni basate sulla fatturazione.
Standard	string	L'utilizzo di Azure AD B2C viene fatturato a una sottoscrizione di Azure collegata e usa un modello di fatturazione mensile di utenti attivi (MAU).

B2CResourceSKUTier

Livello del tenant.

Nome	Tipo	Descrizione
A0	string	Livello SKU usato per tutti i tenant di Azure AD B2C.

B2CTenantResource

Nome	Tipo	Descrizione
id	string	Identificatore che rappresenta la risorsa tenant di Azure AD B2C.
location	string	Posizione in cui la risorsa è ospitata e si trovano i dati. Può essere uno dei "Stati Uniti", "Europa", "Asia Pacifico" o "Australia". Per altre informazioni, vedere questa documentazione .
name	string	Nome della risorsa tenant di Azure AD B2C.
properties.billingConfig	BillingConfig	Configurazione di fatturazione per il tenant.
properties.tenantId	string	Identificatore del tenant di Azure AD B2C.
sku	B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object	Tag delle risorse
type	TypeValue	Tipo della risorsa tenant B2C.

BillingConfig

Configurazione di fatturazione per il tenant.

Nome	Tipo	Descrizione
billingType	BillingType	Tipo di fatturazione. Sarà MAU per tutti i nuovi clienti. Se 'Auths', può essere aggiornato a 'MAU'. Impossibile modificare se il valore è 'MAU'. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.
effectiveStartDateUtc	string	Dati da cui ha avuto effetto il tipo di fatturazione

BillingType

Tipo di fatturazione. Sarà MAU per tutti i nuovi clienti. Se 'Auths', può essere aggiornato a 'MAU'. Impossibile modificare se il valore è 'MAU'. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.

Nome	Tipo	Descrizione
Auths	string	L'utilizzo di Azure AD B2C viene fatturato a una sottoscrizione di Azure collegata e usa il numero di autenticazioni basate sulla fatturazione.
MAU	string	L'utilizzo di Azure AD B2C viene fatturato a una sottoscrizione di Azure collegata e usa un modello di fatturazione mensile di utenti attivi (MAU).

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API Resource Manager di Azure per restituire i dettagli dell'errore per le operazioni non riuscite. Segue anche il formato di risposta di errore OData.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

Le informazioni necessarie per creare il tenant di Azure AD B2C e la risorsa di Azure corrispondente, usata a scopo di fatturazione.

Nome	Tipo	Descrizione
location	string	Posizione in cui la risorsa è ospitata e si trovano i dati. Può essere uno dei "Stati Uniti", "Europa", "Asia Pacifico" o "Australia". Per altre informazioni, vedere questa documentazione .
properties.createTenantProperties.countryCode	string	Codice paese del tenant di Azure ,ad esempio "US". Fare riferimento a aka.ms/B2CDataResidency per visualizzare i codici paese validi e le località di residenza dei dati corrispondenti. Se non viene visualizzato un codice paese in una località di residenza dei dati valida, scegliere uno dall'elenco.
properties.createTenantProperties.displayName	string	Nome visualizzato del tenant di Azure AD B2C.
sku	B2CResourceSKU	Proprietà SKU del tenant di Azure AD B2C. Per altre informazioni sulla fatturazione di Azure AD B2C, vedere aka.ms/b2cBilling.
tags	object	Tag delle risorse

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

TypeValue

Tipo della risorsa tenant B2C.

Nome	Tipo	Descrizione
Microsoft.AzureActiveDirectory/b2cDirectories	string	Tipo di risorsa per la risorsa tenant di Azure AD B2C.

Share via

B2C Tenants - Create

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

Create tenant

Sample Request

Sample Response

Definizioni

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Risorse aggiuntive