TenantManager class

Menentukan tenant manager yang digunakan untuk membantu mengelola operasi terkait penyewa. Hal ini mencakup:

  • Kemampuan untuk membuat, memperbarui, mencantumkan, mendapatkan, dan menghapus tenant untuk project pokok.
  • Mendapatkan instance TenantAwareAuth untuk menjalankan operasi terkait Auth (pengelolaan pengguna, pengelolaan konfigurasi penyedia, verifikasi token, pembuatan link email, dll.) dalam konteks tenant tertentu.

Tanda Tangan:

export declare class TenantManager

Metode

Metode Pengubah Deskripsi
authForTenant(tenantId) Menampilkan instance TenantAwareAuth yang terikat ke ID tenant yang diberikan.
createTenant(tenantOptions) Membuat tenant baru. Saat membuat tenant baru, tenant yang menggunakan penagihan dan kuota terpisah akan memerlukan project mereka sendiri dan harus ditentukan sebagai full_service.
deleteTenant(tenantId) Menghapus tenant yang ada.
getTenant(tenantId) Mendapatkan konfigurasi tenant untuk tenant yang sesuai dengan tenantId yang ditentukan.
listTenants(maxResults, pageToken) Mengambil daftar tenant (khusus batch tunggal) dengan ukuran maxResults mulai dari offset seperti yang ditentukan oleh pageToken. Ini digunakan untuk mengambil semua tenant dari project tertentu dalam batch.
updateTenant(tenantId, tenantOptions) Memperbarui konfigurasi tenant yang ada.

TenantManager.authForTenant()

Menampilkan instance TenantAwareAuth yang terikat ke ID tenant yang diberikan.

Tanda Tangan:

authForTenant(tenantId: string): TenantAwareAuth;

Parameter

Parameter Jenis Deskripsi
IDtenant string ID tenant yang instance TenantAwareAuth-nya akan ditampilkan.

Hasil:

TenantAwareAuth

Instance TenantAwareAuth yang sesuai dengan ID tenant ini.

TenantManager.createTenant()

Membuat tenant baru. Saat membuat tenant baru, tenant yang menggunakan penagihan dan kuota terpisah akan memerlukan project mereka sendiri dan harus ditetapkan sebagai full_service.

Tanda Tangan:

createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;

Parameter

Parameter Jenis Deskripsi
tenantOptions CreateTenantRequest Properti yang akan ditetapkan pada konfigurasi tenant baru yang akan dibuat.

Hasil:

Janji<Tenant>

Promise terpenuhi dengan konfigurasi tenant yang sesuai dengan tenant yang baru dibuat.

TenantManager.deleteTenant()

Menghapus tenant yang ada.

Tanda Tangan:

deleteTenant(tenantId: string): Promise<void>;

Parameter

Parameter Jenis Deskripsi
IDtenant string tenantId yang sesuai dengan tenant yang akan dihapus.

Hasil:

Janji<void>

Promise kosong terpenuhi setelah tenant dihapus.

TenantManager.getTenant()

Mendapatkan konfigurasi tenant untuk tenant yang sesuai dengan tenantId yang ditentukan.

Tanda Tangan:

getTenant(tenantId: string): Promise<Tenant>;

Parameter

Parameter Jenis Deskripsi
IDtenant string ID tenant yang sesuai dengan tenant yang datanya akan diambil.

Hasil:

Janji<Tenant>

Promise dipenuhi dengan konfigurasi tenant ke tenantId yang disediakan.

TenantManager.listTenants()

Mengambil daftar tenant (khusus batch tunggal) dengan ukuran maxResults mulai dari offset seperti yang ditentukan oleh pageToken. Ini digunakan untuk mengambil semua tenant dari project tertentu dalam batch.

Tanda Tangan:

listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;

Parameter

Parameter Jenis Deskripsi
maxResults angka Ukuran halaman, 1000 jika tidak ditentukan. Jumlah ini juga merupakan batas maksimum yang diizinkan.
pageToken string Token halaman berikutnya. Jika tidak ditentukan, menampilkan tenant yang dimulai tanpa offset apa pun.

Hasil:

Promise<ListTenantsResult>

Promise yang di-resolve dengan batch tenant yang didownload dan token halaman berikutnya.

TenantManager.updateTenant()

Memperbarui konfigurasi tenant yang ada.

Tanda Tangan:

updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;

Parameter

Parameter Jenis Deskripsi
IDtenant string tenantId yang sesuai dengan tenant yang akan dihapus.
tenantOptions UpdateTenantRequest Properti yang akan diperbarui pada tenant yang disediakan.

Hasil:

Janji<Tenant>

Promise terpenuhi dengan pembaruan data tenant.