CIAM Tenants - Get

Layanan:

Azure AD B2C

Versi API:

2023-05-17-preview

Dapatkan Azure AD untuk sumber daya penyewa pelanggan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/ciamDirectories/{resourceName}?api-version=2023-05-17-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
resourceName	path	True	string maxLength: 26 pattern: ^[a-zA-Z0-9]{1,26}	Sub domain awal penyewa.
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.

Respons

Nama	Jenis	Deskripsi
200 OK	CIAMTenantResource	Azure AD untuk sumber daya penyewa pelanggan berhasil diambil.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get_CIAM_tenant

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso?api-version=2023-05-17-preview

Respon sampel

Kode status:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso",
  "name": "contoso",
  "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    },
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "domainName": "contoso.onmicrosoft.com",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "tags": null,
  "systemData": {
    "createdBy": "contosoAdmin@onmicrosoft.com",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
  }
}

Definisi

Nama	Deskripsi
ciamBillingType	Jenis penagihan. Akan menjadi MAU untuk semua pelanggan baru. Tidak dapat diubah jika nilainya adalah 'MAU'. Pelajari selengkapnya tentang penagihan Azure ACTIVE Directory untuk pelanggan di aka.ms/b2cBilling.
CIAMResourceSKU	Properti SKU Azure ACTIVE Directory untuk penyewa pelanggan. Pelajari selengkapnya tentang penagihan Azure ACTIVE Directory untuk pelanggan di https://aka.ms/ciambilling.
CIAMResourceSKUName	Nama SKU untuk penyewa.
CIAMResourceSKUTier	Tingkat penyewa.
CIAMTenantResource	Sumber daya Azure ACTIVE Directory untuk pelanggan.
ciamTypeValue	Jenis Azure ACTIVE Directory untuk sumber daya penyewa pelanggan.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ProvisioningState	Status Provisi
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

ciamBillingType

Enumeration

Jenis penagihan. Akan menjadi MAU untuk semua pelanggan baru. Tidak dapat diubah jika nilainya adalah 'MAU'. Pelajari selengkapnya tentang penagihan Azure ACTIVE Directory untuk pelanggan di aka.ms/b2cBilling.

Nilai	Deskripsi
MAU	Penggunaan Azure AD untuk pelanggan ditagih ke langganan Azure tertaut dan menggunakan model penagihan pengguna aktif bulanan (MAU).

CIAMResourceSKU

Objek

Properti SKU Azure ACTIVE Directory untuk penyewa pelanggan. Pelajari selengkapnya tentang penagihan Azure ACTIVE Directory untuk pelanggan di https://aka.ms/ciambilling.

Nama	Jenis	Deskripsi
name	CIAMResourceSKUName	Nama SKU untuk penyewa.
tier	CIAMResourceSKUTier	Tingkat penyewa.

CIAMResourceSKUName

Enumeration

Nama SKU untuk penyewa.

Nilai	Deskripsi
PremiumP1
PremiumP2
Standard

CIAMResourceSKUTier

Enumeration

Tingkat penyewa.

Nilai	Deskripsi
A0	Tingkat SKU yang digunakan untuk semua Azure ACTIVE Directory untuk penyewa pelanggan.

CIAMTenantResource

Objek

Sumber daya Azure ACTIVE Directory untuk pelanggan.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi yang mewakili Azure AD untuk sumber daya penyewa pelanggan.
location	string	Lokasi tempat sumber daya dihosting dan data berada. Bisa menjadi salah satu 'Amerika Serikat', 'Eropa', 'Asia Pasifik', atau 'Australia'. Lihat dokumentasi ini untuk informasi selengkapnya.
name	string	Nama Azure ACTIVE Directory untuk sumber daya penyewa pelanggan.
properties.billingConfig.billingType	ciamBillingType	Jenis penagihan. Akan menjadi MAU untuk semua pelanggan baru. Tidak dapat diubah jika nilainya adalah 'MAU'. Pelajari selengkapnya tentang penagihan Azure ACTIVE Directory untuk pelanggan di aka.ms/b2cBilling.
properties.billingConfig.effectiveStartDateUtc	string	Data dari mana jenis penagihan berlaku
properties.createTenantProperties.countryCode	string	Kode negara penyewa Azure (misalnya 'AS'). Lihat https://aka.ms/ciam-data-location 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 Azure AD untuk penyewa pelanggan.
properties.domainName	string	Nama domain penyewa
properties.provisioningState	ProvisioningState	Status Provisi
properties.tenantId	string	Pengidentifikasi Azure AD untuk penyewa pelanggan.
sku	CIAMResourceSKU	Properti SKU Azure ACTIVE Directory untuk penyewa pelanggan. Pelajari selengkapnya tentang penagihan Azure ACTIVE Directory untuk pelanggan di https://aka.ms/ciambilling.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object	Tag Sumber Daya
type	ciamTypeValue	Jenis Azure ACTIVE Directory untuk sumber daya penyewa pelanggan.

ciamTypeValue

Enumeration

Jenis Azure ACTIVE Directory untuk sumber daya penyewa pelanggan.

Nilai	Deskripsi
Microsoft.AzureActiveDirectory/ciamDirectories	Jenis sumber daya untuk Azure AD untuk sumber daya penyewa pelanggan.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Objek

Detail kesalahan.

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

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ProvisioningState

Enumeration

Status Provisi

Nilai	Deskripsi
Canceled
Deleted
Deleting
Failed
Provisioning
Succeeded

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

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