B2C Tenants - Create

Referencia

Szolgáltatás:: Azure AD B2C

API-verzió:: 2021-04-01

Aszinkron kérést kezdeményez a Azure AD B2C-bérlő és az előfizetéshez társított megfelelő Azure-erőforrás létrehozásához.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
resourceName	path	True	string	A Azure AD B2C-bérlő kezdeti tartományneve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Az ügyfélkéréshez használni kívánt API verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Az erőforrás tárolási helye és az adatok helye. Lehet az egyik "Egyesült Államok", "Európa", "Ázsia csendes-óceáni" vagy "Ausztrália". További információért tekintse meg ezt a dokumentációt .
sku	True	B2CResourceSKU	A Azure AD B2C-bérlő termékváltozat-tulajdonságai. További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Az Azure-bérlő országkódja (pl. "USA"). Az érvényes országkódok és a megfelelő adattárolási helyek megtekintéséhez tekintse meg a aka.ms/B2CDataResidency . Ha nem lát országkódot érvényes adattárolási helyen, válasszon egyet a listából.
properties.createTenantProperties.displayName		string	A Azure AD B2C-bérlő megjelenítendő neve.
tags		object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	B2CTenantResource	OK – Az URL-cím válasza a Hely fejlécben, ha az aszinkron művelet sikeres. Létrejön az erőforrás.
202 Accepted		Azure AD B2C-bérlő létrehozási kérése elfogadva. A Hely fejléc azt az URL-címet/helyet jelzi, amelyben ellenőrizni szeretné a művelet aszinkron állapotának lekérését. Fejlécek Location: string Retry-After: string
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Name

Típus

Description

200 OK

B2CTenantResource

OK – Az URL-cím válasza a Hely fejlécben, ha az aszinkron művelet sikeres. Létrejön az erőforrás.

202 Accepted

Azure AD B2C-bérlő létrehozási kérése elfogadva. A Hely fejléc azt az URL-címet/helyet jelzi, amelyben ellenőrizni szeretné a művelet aszinkron állapotának lekérését.

Fejlécek

Location: string
Retry-After: string

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Mintaválasz

Állapotkó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
}

Állapotkó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

Definíciók

Name	Description
B2CResourceSKU	A Azure AD B2C-bérlő termékváltozat-tulajdonságai. További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.
B2CResourceSKUName	A bérlő termékváltozatának neve.
B2CResourceSKUTier	A bérlő szintje.
B2CTenantResource
BillingConfig	A bérlő számlázási konfigurációja.
BillingType	A számlázás típusa. A MAU lesz minden új ügyfél számára. Ha "Hitelesítések", akkor a "MAU"-ra frissíthető. Nem módosítható, ha az érték "MAU". További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.
CloudError	Hibaválasz egy erőforrás-kezelési kérelemhez.
createdByType	Az erőforrást létrehozó identitás típusa.
CreateTenantRequestBody	A számlázási célokra használt Azure AD B2C-bérlő és a kapcsolódó Azure-erőforrás létrehozásához szükséges információk.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TypeValue	A B2C bérlői erőforrás típusa.

B2CResourceSKU

A Azure AD B2C-bérlő termékváltozat-tulajdonságai. További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.

Name	Típus	Description
name	B2CResourceSKUName	A bérlő termékváltozatának neve.
tier	B2CResourceSKUTier	A bérlő szintje.

B2CResourceSKUName

A bérlő termékváltozatának neve.

Name	Típus	Description
PremiumP1	string	Azure AD B2C-használat számlázása egy társított Azure-előfizetéshez történik, és a hitelesítésen alapuló számlázást használja.
PremiumP2	string	Azure AD B2C-használat számlázása egy társított Azure-előfizetéshez történik, és a hitelesítésen alapuló számlázást használja.
Standard	string	Azure AD B2C-használat számlázása egy társított Azure-előfizetéshez történik, és havi aktív felhasználói (MAU) számlázási modellt használ.

B2CResourceSKUTier

A bérlő szintje.

Name	Típus	Description
A0	string	Az összes Azure AD B2C-bérlőhöz használt termékváltozat-szint.

B2CTenantResource

Name	Típus	Description
id	string	A B2C-bérlő erőforrásának Azure AD azonosító.
location	string	Az erőforrás tárolási helye és az adatok helye. Lehet az egyik "Egyesült Államok", "Európa", "Ázsia csendes-óceáni" vagy "Ausztrália". További információért tekintse meg ezt a dokumentációt .
name	string	A Azure AD B2C-bérlői erőforrás neve.
properties.billingConfig	BillingConfig	A bérlő számlázási konfigurációja.
properties.tenantId	string	A Azure AD B2C-bérlő azonosítója.
sku	B2CResourceSKU	A Azure AD B2C-bérlő termékváltozat-tulajdonságai. További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék
type	TypeValue	A B2C bérlői erőforrás típusa.

BillingConfig

A bérlő számlázási konfigurációja.

Name	Típus	Description
billingType	BillingType	A számlázás típusa. A MAU lesz minden új ügyfél számára. Ha "Hitelesítések", akkor a "MAU"-ra frissíthető. Nem módosítható, ha az érték "MAU". További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.
effectiveStartDateUtc	string	Azok az adatok, amelyekből a számlázási típus érvénybe lépett

BillingType

A számlázás típusa. A MAU lesz minden új ügyfél számára. Ha "Hitelesítések", akkor a "MAU"-ra frissíthető. Nem módosítható, ha az érték "MAU". További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.

Name	Típus	Description
Auths	string	Azure AD B2C-használat számlázása egy társított Azure-előfizetéshez történik, és a hitelesítésen alapuló számlázást használja.
MAU	string	Azure AD B2C-használat számlázása egy társított Azure-előfizetéshez történik, és havi aktív felhasználói (MAU) számlázási modellt használ.

CloudError

Hibaválasz egy erőforrás-kezelési kérelemhez.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

A számlázási célokra használt Azure AD B2C-bérlő és a kapcsolódó Azure-erőforrás létrehozásához szükséges információk.

Name	Típus	Description
location	string	Az erőforrás tárolási helye és az adatok helye. Lehet az egyik "Egyesült Államok", "Európa", "Ázsia csendes-óceáni" vagy "Ausztrália". További információért tekintse meg ezt a dokumentációt .
properties.createTenantProperties.countryCode	string	Az Azure-bérlő országkódja (pl. "USA"). Az érvényes országkódok és a megfelelő adattárolási helyek megtekintéséhez tekintse meg a aka.ms/B2CDataResidency . Ha nem lát országkódot érvényes adattárolási helyen, válasszon egyet a listából.
properties.createTenantProperties.displayName	string	A Azure AD B2C-bérlő megjelenítendő neve.
sku	B2CResourceSKU	A Azure AD B2C-bérlő termékváltozat-tulajdonságai. További információ Azure AD B2C-számlázásról a aka.ms/b2cBilling.
tags	object	Erőforráscímkék

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TypeValue

A B2C bérlői erőforrás típusa.

Name	Típus	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	A B2C-bérlő erőforrásának Azure AD erőforrástípusa.

Megosztás a következőn keresztül:

B2C Tenants - Create

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Create tenant

Mintakérelem

Mintaválasz

Definíciók

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

További források