B2C Tenants - Create

Başvuru

Service:: Azure AD B2C

API Version:: 2021-04-01

Hem Azure AD B2C kiracısını hem de aboneliğe bağlı ilgili Azure kaynağını oluşturmak için zaman uyumsuz istek başlatır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı.
resourceName	path	True	string	Azure AD B2C kiracısının ilk etki alanı adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynağın barındırıldığı ve verilerin bulunduğu konum. 'Birleşik Devletler', 'Avrupa', 'Asya Pasifik' veya 'Avustralya' olabilir. Daha fazla bilgi için bu belgelere bakın.
sku	True	B2CResourceSKU	Azure AD B2C kiracısının SKU özellikleri. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.
properties.createTenantProperties.countryCode		string	Azure kiracısının ülke kodu (ör. "ABD"). Geçerli ülke kodlarını ve ilgili veri yerleşimi konumlarını görmek için aka.ms/B2CDataResidency bakın. Geçerli bir veri yerleşimi konumunda ülke kodu görmüyorsanız listeden bir ülke kodu seçin.
properties.createTenantProperties.displayName		string	Azure AD B2C kiracısının görünen adı.
tags		object	Kaynak Etiketleri

Yanıtlar

Name	Tür	Description
200 OK	B2CTenantResource	Tamam - Zaman uyumsuz işlem başarılı olursa Konum üst bilgisindeki URL'nin yanıtı. Kaynak oluşturulur.
202 Accepted		Azure AD B2C kiracı oluşturma isteği kabul edildi. Konum üst bilgisi, işlemin zaman uyumsuz durumunu almak için denetlenecek URL'yi/konumu gösterir. Headers Location: string Retry-After: string
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

B2CTenantResource

Tamam - Zaman uyumsuz işlem başarılı olursa Konum üst bilgisindeki URL'nin yanıtı. Kaynak oluşturulur.

202 Accepted

Azure AD B2C kiracı oluşturma isteği kabul edildi. Konum üst bilgisi, işlemin zaman uyumsuz durumunu almak için denetlenecek URL'yi/konumu gösterir.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
B2CResourceSKU	Azure AD B2C kiracısının SKU özellikleri. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.
B2CResourceSKUName	Kiracının SKU'su adı.
B2CResourceSKUTier	Kiracının katmanı.
B2CTenantResource
BillingConfig	Kiracının faturalama yapılandırması.
BillingType	Faturalama türü. Tüm yeni müşteriler için MAU olacaktır. 'Kimlik Doğrulamaları' ise 'MAU' olarak güncelleştirilebilir. Değer 'MAU' ise değiştirilemez. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.
CloudError	Kaynak yönetimi isteği için hata yanıtı.
createdByType	Kaynağı oluşturan kimliğin türü.
CreateTenantRequestBody	faturalama amacıyla kullanılan Azure AD B2C kiracısını ve ilgili Azure kaynağını oluşturmak için gereken bilgiler.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorResponse	Hata Yanıtı
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
TypeValue	B2C kiracı kaynağının türü.

B2CResourceSKU

Azure AD B2C kiracısının SKU özellikleri. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.

Name	Tür	Description
name	B2CResourceSKUName	Kiracının SKU'su adı.
tier	B2CResourceSKUTier	Kiracının katmanı.

B2CResourceSKUName

Kiracının SKU'su adı.

Name	Tür	Description
PremiumP1	string	Azure AD B2C kullanımı bağlı bir Azure aboneliğine faturalandırılır ve kimlik doğrulaması tabanlı faturalama sayısını kullanır.
PremiumP2	string	Azure AD B2C kullanımı bağlı bir Azure aboneliğine faturalandırılır ve kimlik doğrulaması tabanlı faturalama sayısını kullanır.
Standard	string	Azure AD B2C kullanımı bağlı bir Azure aboneliğine faturalandırılır ve aylık etkin kullanıcılar (MAU) faturalama modelini kullanır.

B2CResourceSKUTier

Kiracının katmanı.

Name	Tür	Description
A0	string	Tüm Azure AD B2C kiracıları için kullanılan SKU katmanı.

B2CTenantResource

Name	Tür	Description
id	string	Azure AD B2C kiracı kaynağını temsil eden tanımlayıcı.
location	string	Kaynağın barındırıldığı ve verilerin bulunduğu konum. 'Birleşik Devletler', 'Avrupa', 'Asya Pasifik' veya 'Avustralya' olabilir. Daha fazla bilgi için bu belgelere bakın.
name	string	Azure AD B2C kiracı kaynağının adı.
properties.billingConfig	BillingConfig	Kiracının faturalama yapılandırması.
properties.tenantId	string	Azure AD B2C kiracısının tanımlayıcısı.
sku	B2CResourceSKU	Azure AD B2C kiracısının SKU özellikleri. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynak Etiketleri
type	TypeValue	B2C kiracı kaynağının türü.

BillingConfig

Kiracının faturalama yapılandırması.

Name	Tür	Description
billingType	BillingType	Faturalama türü. Tüm yeni müşteriler için MAU olacaktır. 'Kimlik Doğrulamaları' ise 'MAU' olarak güncelleştirilebilir. Değer 'MAU' ise değiştirilemez. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.
effectiveStartDateUtc	string	Faturalama türünün geçerli olduğu veriler

BillingType

Faturalama türü. Tüm yeni müşteriler için MAU olacaktır. 'Kimlik Doğrulamaları' ise 'MAU' olarak güncelleştirilebilir. Değer 'MAU' ise değiştirilemez. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.

Name	Tür	Description
Auths	string	Azure AD B2C kullanımı bağlı bir Azure aboneliğine faturalandırılır ve kimlik doğrulaması tabanlı faturalama sayısını kullanır.
MAU	string	Azure AD B2C kullanımı bağlı bir Azure aboneliğine faturalandırılır ve aylık etkin kullanıcılar (MAU) faturalama modelini kullanır.

CloudError

Kaynak yönetimi isteği için hata yanıtı.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

faturalama amacıyla kullanılan Azure AD B2C kiracısını ve ilgili Azure kaynağını oluşturmak için gereken bilgiler.

Name	Tür	Description
location	string	Kaynağın barındırıldığı ve verilerin bulunduğu konum. 'Birleşik Devletler', 'Avrupa', 'Asya Pasifik' veya 'Avustralya' olabilir. Daha fazla bilgi için bu belgelere bakın.
properties.createTenantProperties.countryCode	string	Azure kiracısının ülke kodu (ör. "ABD"). Geçerli ülke kodlarını ve ilgili veri yerleşimi konumlarını görmek için aka.ms/B2CDataResidency bakın. Geçerli bir veri yerleşimi konumunda ülke kodu görmüyorsanız listeden bir ülke kodu seçin.
properties.createTenantProperties.displayName	string	Azure AD B2C kiracısının görünen adı.
sku	B2CResourceSKU	Azure AD B2C kiracısının SKU özellikleri. aka.ms/b2cBilling'da Azure AD B2C faturalaması hakkında daha fazla bilgi edinin.
tags	object	Kaynak Etiketleri

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorResponse

Hata Yanıtı

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorResponse[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

TypeValue

B2C kiracı kaynağının türü.

Name	Tür	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Azure AD B2C kiracı kaynağının kaynak türü.

B2C Tenants - Create

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Create tenant

Sample Request

Sample Response

Tanımlar

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Ek kaynaklar