B2C Tenants - Create

Referensi

Service:: Azure AD B2C

API Version:: 2021-04-01

Memulai permintaan asinkron untuk membuat penyewa Azure AD B2C dan sumber daya Azure terkait yang ditautkan ke langganan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
resourceName	path	True	string	Nama domain awal penyewa Azure AD B2C.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
location	True	string	Lokasi tempat sumber daya dihosting dan data berada. Bisa menjadi salah satu dari 'Amerika Serikat', 'Eropa', 'Asia Pasifik', atau 'Australia'. Lihat dokumentasi ini untuk informasi selengkapnya.
sku	True	B2CResourceSKU	Properti SKU dari penyewa Azure AD B2C. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Kode negara penyewa Azure (misalnya 'AS'). Lihat aka.ms/B2CDataResidency untuk melihat kode negara yang valid dan lokasi residensi data yang sesuai. Jika Anda tidak melihat kode negara di lokasi residensi data yang valid, pilih salah satu dari daftar.
properties.createTenantProperties.displayName		string	Nama tampilan penyewa Azure AD B2C.
tags		object	Tag Sumber Daya

Respons

Nama	Jenis	Deskripsi
200 OK	B2CTenantResource	OK - Respons URL di header Lokasi jika operasi asinkron berhasil. Sumber daya akan dibuat.
202 Accepted		Azure AD permintaan pembuatan penyewa B2C diterima. Header Lokasi menunjukkan URL/lokasi untuk memeriksa untuk mendapatkan status asinkron operasi. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Nama

Jenis

Deskripsi

200 OK

B2CTenantResource

OK - Respons URL di header Lokasi jika operasi asinkron berhasil. Sumber daya akan dibuat.

202 Accepted

Azure AD permintaan pembuatan penyewa B2C diterima. Header Lokasi menunjukkan URL/lokasi untuk memeriksa untuk mendapatkan status asinkron operasi.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
B2CResourceSKU	Properti SKU dari penyewa Azure AD B2C. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.
B2CResourceSKUName	Nama SKU untuk penyewa.
B2CResourceSKUTier	Tingkat penyewa.
B2CTenantResource
BillingConfig	Konfigurasi penagihan untuk penyewa.
BillingType	Jenis penagihan. Akan menjadi MAU untuk semua pelanggan baru. Jika 'Auths', itu dapat diperbarui ke 'MAU'. Tidak dapat diubah jika nilainya adalah 'MAU'. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.
CloudError	Respons kesalahan untuk permintaan manajemen sumber daya.
createdByType	Jenis identitas yang membuat sumber daya.
CreateTenantRequestBody	Informasi yang diperlukan untuk membuat penyewa Azure AD B2C dan sumber daya Azure terkait, yang digunakan untuk tujuan penagihan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons Kesalahan
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TypeValue	Jenis sumber daya penyewa B2C.

B2CResourceSKU

Properti SKU dari penyewa Azure AD B2C. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.

Nama	Jenis	Deskripsi
name	B2CResourceSKUName	Nama SKU untuk penyewa.
tier	B2CResourceSKUTier	Tingkat penyewa.

B2CResourceSKUName

Nama SKU untuk penyewa.

Nama	Jenis	Deskripsi
PremiumP1	string	Azure AD penggunaan B2C ditagih ke langganan Azure tertaut dan menggunakan jumlah tagihan berbasis autentikasi.
PremiumP2	string	Azure AD penggunaan B2C ditagih ke langganan Azure tertaut dan menggunakan jumlah tagihan berbasis autentikasi.
Standard	string	Azure AD penggunaan B2C ditagih ke langganan Azure tertaut dan menggunakan model penagihan pengguna aktif bulanan (MAU).

B2CResourceSKUTier

Tingkat penyewa.

Nama	Jenis	Deskripsi
A0	string	Tingkat SKU yang digunakan untuk semua penyewa Azure AD B2C.

B2CTenantResource

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi yang mewakili sumber daya penyewa Azure AD B2C.
location	string	Lokasi tempat sumber daya dihosting dan data berada. Bisa menjadi salah satu dari 'Amerika Serikat', 'Eropa', 'Asia Pasifik', atau 'Australia'. Lihat dokumentasi ini untuk informasi selengkapnya.
name	string	Nama sumber daya penyewa Azure AD B2C.
properties.billingConfig	BillingConfig	Konfigurasi penagihan untuk penyewa.
properties.tenantId	string	Pengidentifikasi penyewa Azure AD B2C.
sku	B2CResourceSKU	Properti SKU dari penyewa Azure AD B2C. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object	Tag Sumber Daya
type	TypeValue	Jenis sumber daya penyewa B2C.

BillingConfig

Konfigurasi penagihan untuk penyewa.

Nama	Jenis	Deskripsi
billingType	BillingType	Jenis penagihan. Akan menjadi MAU untuk semua pelanggan baru. Jika 'Auths', itu dapat diperbarui ke 'MAU'. Tidak dapat diubah jika nilainya adalah 'MAU'. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.
effectiveStartDateUtc	string	Data dari mana jenis penagihan berlaku

BillingType

Jenis penagihan. Akan menjadi MAU untuk semua pelanggan baru. Jika 'Auths', itu dapat diperbarui ke 'MAU'. Tidak dapat diubah jika nilainya adalah 'MAU'. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.

Nama	Jenis	Deskripsi
Auths	string	Azure AD penggunaan B2C ditagih ke langganan Azure tertaut dan menggunakan jumlah tagihan berbasis autentikasi.
MAU	string	Azure AD penggunaan B2C ditagih ke langganan Azure tertaut dan menggunakan model penagihan pengguna aktif bulanan (MAU).

CloudError

Respons kesalahan untuk permintaan manajemen sumber daya.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

Informasi yang diperlukan untuk membuat penyewa Azure AD B2C dan sumber daya Azure terkait, yang digunakan untuk tujuan penagihan.

Nama	Jenis	Deskripsi
location	string	Lokasi tempat sumber daya dihosting dan data berada. Bisa menjadi salah satu dari 'Amerika Serikat', 'Eropa', 'Asia Pasifik', atau 'Australia'. Lihat dokumentasi ini untuk informasi selengkapnya.
properties.createTenantProperties.countryCode	string	Kode negara penyewa Azure (misalnya 'AS'). Lihat aka.ms/B2CDataResidency untuk melihat kode negara yang valid dan lokasi residensi data yang sesuai. Jika Anda tidak melihat kode negara di lokasi residensi data yang valid, pilih salah satu dari daftar.
properties.createTenantProperties.displayName	string	Nama tampilan penyewa Azure AD B2C.
sku	B2CResourceSKU	Properti SKU dari penyewa Azure AD B2C. Pelajari selengkapnya tentang penagihan Azure AD B2C di aka.ms/b2cBilling.
tags	object	Tag Sumber Daya

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Respons Kesalahan

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

TypeValue

Jenis sumber daya penyewa B2C.

Nama	Jenis	Deskripsi
Microsoft.AzureActiveDirectory/b2cDirectories	string	Jenis sumber daya untuk sumber daya penyewa Azure AD B2C.

B2C Tenants - Create

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

Create tenant

Sample Request

Sample Response

Definisi

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Sumber Daya Tambahan: