B2C Tenants - Create

Reference

Služba:: Azure AD B2C

Verze rozhraní API:: 2021-04-01

Inicializuje asynchronní požadavek na vytvoření tenanta Azure AD B2C a odpovídajícího prostředku Azure propojeného s předplatným.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků.
resourceName	path	True	string	Počáteční název domény tenanta Azure AD B2C.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění, ve kterém je prostředek hostovaný a kde se nacházejí data. Může to být "USA", "Evropa", "Asie a Tichomoří" nebo "Austrálie". Další informace najdete v této dokumentaci .
sku	True	B2CResourceSKU	Vlastnosti skladové položky tenanta Azure AD B2C. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Kód země tenanta Azure (např. USA). Platné kódy zemí a odpovídající umístění rezidence dat najdete v aka.ms/B2CDataResidency . Pokud v platném umístění rezidence dat nevidíte kód země, vyberte ho ze seznamu.
properties.createTenantProperties.displayName		string	Zobrazovaný název tenanta Azure AD B2C.
tags		object	Značky prostředku

Odpovědi

Name	Typ	Description
200 OK	B2CTenantResource	OK – odpověď adresy URL v hlavičce Location, pokud je asynchronní operace úspěšná. Vytvoří se prostředek.
202 Accepted		Azure AD žádost o vytvoření tenanta B2C byla přijata. Hlavička Location označuje adresu URL nebo umístění, ve kterém chcete zjistit asynchronní stav operace. Hlavičky Location: string Retry-After: string
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

B2CTenantResource

OK – odpověď adresy URL v hlavičce Location, pokud je asynchronní operace úspěšná. Vytvoří se prostředek.

202 Accepted

Azure AD žádost o vytvoření tenanta B2C byla přijata. Hlavička Location označuje adresu URL nebo umístění, ve kterém chcete zjistit asynchronní stav operace.

Hlavičky

Location: string
Retry-After: string

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázková odpověď

Stavový kód:: 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
}

Stavový kód:: 202

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/operations/99999999-9999-9999-9999-999999999999
Retry-After: 60

Definice

Name	Description
B2CResourceSKU	Vlastnosti skladové položky tenanta Azure AD B2C. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.
B2CResourceSKUName	Název skladové položky pro tenanta.
B2CResourceSKUTier	Úroveň tenanta.
B2CTenantResource
BillingConfig	Konfigurace fakturace pro tenanta
BillingType	Typ fakturace. Bude MAU pro všechny nové zákazníky. Pokud "Auths" (Ověřování), můžete ho aktualizovat na MAU. Nelze ji změnit, pokud je hodnota MAU. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.
CloudError	Chybová odpověď pro žádost o správu prostředků.
createdByType	Typ identity, která prostředek vytvořila.
CreateTenantRequestBody	Informace potřebné k vytvoření Azure AD tenanta B2C a odpovídajícího prostředku Azure, který se používá pro účely fakturace.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TypeValue	Typ prostředku tenanta B2C.

B2CResourceSKU

Vlastnosti skladové položky tenanta Azure AD B2C. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.

Name	Typ	Description
name	B2CResourceSKUName	Název skladové položky pro tenanta.
tier	B2CResourceSKUTier	Úroveň tenanta.

B2CResourceSKUName

Název skladové položky pro tenanta.

Name	Typ	Description
PremiumP1	string	Azure AD využití B2C se účtuje do propojeného předplatného Azure a využívá se k fakturaci na základě ověřování.
PremiumP2	string	Azure AD využití B2C se účtuje do propojeného předplatného Azure a využívá se k fakturaci na základě ověřování.
Standard	string	Azure AD využití B2C se účtuje do propojeného předplatného Azure a používá fakturační model s měsíčními aktivními uživateli (MAU).

B2CResourceSKUTier

Úroveň tenanta.

Name	Typ	Description
A0	string	Úroveň skladové položky používaná pro všechny tenanty Azure AD B2C.

B2CTenantResource

Name	Typ	Description
id	string	Identifikátor, který představuje prostředek tenanta Azure AD B2C.
location	string	Umístění, ve kterém je prostředek hostovaný a kde se nacházejí data. Může to být "USA", "Evropa", "Asie a Tichomoří" nebo "Austrálie". Další informace najdete v této dokumentaci .
name	string	Název prostředku tenanta Azure AD B2C.
properties.billingConfig	BillingConfig	Konfigurace fakturace pro tenanta
properties.tenantId	string	Identifikátor tenanta Azure AD B2C.
sku	B2CResourceSKU	Vlastnosti skladové položky tenanta Azure AD B2C. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
tags	object	Značky prostředku
type	TypeValue	Typ prostředku tenanta B2C.

BillingConfig

Konfigurace fakturace pro tenanta

Name	Typ	Description
billingType	BillingType	Typ fakturace. Bude MAU pro všechny nové zákazníky. Pokud "Auths" (Ověřování), můžete ho aktualizovat na MAU. Nelze ji změnit, pokud je hodnota MAU. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.
effectiveStartDateUtc	string	Data, ze kterých se typ fakturace projevil

BillingType

Typ fakturace. Bude MAU pro všechny nové zákazníky. Pokud "Auths" (Ověřování), můžete ho aktualizovat na MAU. Nelze ji změnit, pokud je hodnota MAU. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.

Name	Typ	Description
Auths	string	Azure AD využití B2C se účtuje do propojeného předplatného Azure a využívá se k fakturaci na základě ověřování.
MAU	string	Azure AD využití B2C se účtuje do propojeného předplatného Azure a používá fakturační model s měsíčními aktivními uživateli (MAU).

CloudError

Chybová odpověď pro žádost o správu prostředků.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (Tento formát také odpovídá formátu odpovědi na chybu OData.)

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

Informace potřebné k vytvoření Azure AD tenanta B2C a odpovídajícího prostředku Azure, který se používá pro účely fakturace.

Name	Typ	Description
location	string	Umístění, ve kterém je prostředek hostovaný a kde se nacházejí data. Může to být "USA", "Evropa", "Asie a Tichomoří" nebo "Austrálie". Další informace najdete v této dokumentaci .
properties.createTenantProperties.countryCode	string	Kód země tenanta Azure (např. USA). Platné kódy zemí a odpovídající umístění rezidence dat najdete v aka.ms/B2CDataResidency . Pokud v platném umístění rezidence dat nevidíte kód země, vyberte ho ze seznamu.
properties.createTenantProperties.displayName	string	Zobrazovaný název tenanta Azure AD B2C.
sku	B2CResourceSKU	Vlastnosti skladové položky tenanta Azure AD B2C. Další informace o fakturaci Azure AD B2C najdete na aka.ms/b2cBilling.
tags	object	Značky prostředku

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TypeValue

Typ prostředku tenanta B2C.

Name	Typ	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Typ prostředku pro prostředek tenanta Azure AD B2C.

Sdílet prostřednictvím

B2C Tenants - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Create tenant

Ukázkový požadavek

Ukázková odpověď

Definice

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Další materiály