TenantManager class

Mendefinisikan manajer penyewa yang digunakan untuk membantu mengelola operasi terkait penyewa. Ini termasuk:

  • Kemampuan untuk membuat, memperbarui, membuat daftar, mendapatkan dan menghapus penyewa untuk proyek yang mendasarinya.
  • Mendapatkan instans TenantAwareAuth untuk menjalankan operasi terkait Auth (manajemen pengguna, manajemen konfigurasi penyedia, verifikasi token, pembuatan tautan email, dll) dalam konteks penyewa tertentu.

Tanda tangan:

export declare class TenantManager

Metode

metode Pengubah Keterangan
authForTenant(tenantId) Mengembalikan instans TenantAwareAuth yang terikat ke ID penyewa tertentu.
buatPenyewa(penyewaOpsi) Membuat penyewa baru. Saat membuat penyewa baru, penyewa yang menggunakan penagihan dan kuota terpisah akan memerlukan proyek mereka sendiri dan harus didefinisikan sebagai full_service .
hapusPenyewa(Idpenyewa) Menghapus penyewa yang ada.
dapatkanPenyewa(Idpenyewa) Mendapatkan konfigurasi penyewa untuk penyewa yang sesuai dengan tenantId tertentu.
daftarPenyewa(hasil maksimal, pageToken) Mengambil daftar penyewa (hanya batch tunggal) dengan ukuran maxResults mulai dari offset seperti yang ditentukan oleh pageToken . Ini digunakan untuk mengambil semua penyewa proyek tertentu secara berkelompok.
perbaruiTenant(tenantId, tenantOptions) Memperbarui konfigurasi penyewa yang ada.

TenantManager.authForTenant()

Mengembalikan instans TenantAwareAuth yang terikat ke ID penyewa tertentu.

Tanda tangan:

authForTenant(tenantId: string): TenantAwareAuth;

Parameter

Parameter Jenis Keterangan
penyewaId rangkaian ID penyewa yang instance TenantAwareAuth -nya akan dikembalikan.

Pengembalian:

PenyewaAwareAuth

Instans TenantAwareAuth yang sesuai dengan pengidentifikasi penyewa ini.

TenantManager.createTenant()

Membuat penyewa baru. Saat membuat penyewa baru, penyewa yang menggunakan penagihan dan kuota terpisah akan memerlukan proyek mereka sendiri dan harus didefinisikan sebagai full_service .

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
opsi penyewa Buat Permintaan Penyewa Properti yang akan diatur pada konfigurasi penyewa baru yang akan dibuat.

Pengembalian:

Janji< Penyewa >

Janji yang dipenuhi dengan konfigurasi penyewa yang sesuai dengan penyewa yang baru dibuat.

TenantManager.deleteTenant()

Menghapus penyewa yang ada.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
penyewaId rangkaian tenantId yang sesuai dengan penyewa yang akan dihapus.

Pengembalian:

Janji<batal>

Janji kosong terpenuhi setelah penyewa dihapus.

TenantManager.getTenant()

Mendapatkan konfigurasi penyewa untuk penyewa yang sesuai dengan tenantId tertentu .

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
penyewaId rangkaian Pengidentifikasi penyewa yang sesuai dengan penyewa yang datanya akan diambil.

Pengembalian:

Janji< Penyewa >

Janji yang dipenuhi dengan konfigurasi penyewa ke tenantId yang disediakan .

TenantManager.listTenants()

Mengambil daftar penyewa (hanya batch tunggal) dengan ukuran maxResults mulai dari offset seperti yang ditentukan oleh pageToken . Ini digunakan untuk mengambil semua penyewa proyek tertentu secara berkelompok.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
Hasil maksimal nomor Ukuran halaman, 1000 jika tidak ditentukan. Ini juga merupakan batas maksimum yang diperbolehkan.
halamanToken rangkaian Token halaman berikutnya. Jika tidak ditentukan, mengembalikan penyewa yang dimulai tanpa offset apa pun.

Pengembalian:

Janji< ListTenantsResult >

Janji yang diselesaikan dengan sekumpulan penyewa yang diunduh dan token halaman berikutnya.

TenantManager.updateTenant()

Memperbarui konfigurasi penyewa yang ada.

Tanda tangan:

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

Parameter

Parameter Jenis Keterangan
penyewaId rangkaian tenantId yang sesuai dengan penyewa yang akan dihapus.
opsi penyewa PerbaruiPermintaanPenyewa Properti yang akan diperbarui pada penyewa yang disediakan.

Pengembalian:

Janji< Penyewa >

Janji dipenuhi dengan pembaruan data penyewa.