Kiracıyla ilgili operasyonların yönetilmesine yardımcı olmak için kullanılan kiracı yöneticisini tanımlar. Bu içerir:
- Temel proje için kiracı oluşturma, güncelleme, listeleme, alma ve silme yeteneği.
- Belirli bir kiracı bağlamında Kimlik Doğrulama ile ilgili işlemleri (kullanıcı yönetimi, sağlayıcı yapılandırma yönetimi, belirteç doğrulama, e-posta bağlantısı oluşturma vb.) çalıştırmak için bir
TenantAwareAuth
örneği alma.
İmza:
export declare class TenantManager
Yöntemler
Yöntem | Değiştiriciler | Tanım |
---|---|---|
authForTenant(kiracıKimliği) | Verilen kiracı kimliğine bağlı bir TenantAwareAuth örneğini döndürür. | |
createTenant(tenantOptions) | Yeni bir kiracı oluşturur. Yeni kiracılar oluştururken, ayrı faturalandırma ve kota kullanan kiracıların kendi projelerini gerektirmesi ve full_service olarak tanımlanması gerekir. | |
deleteTenant(kiracıKimliği) | Mevcut bir kiracıyı siler. | |
getTenant(kiracıId) | Belirli bir tenantId karşılık gelen kiracı için kiracı yapılandırmasını alır. | |
listTenants(maxResults, pageToken) | pageToken tarafından belirtilen uzaklıktan başlayarak maxResults boyutuna sahip kiracıların listesini (yalnızca tek toplu iş) alır. Bu, belirli bir projenin tüm kiracılarını toplu olarak almak için kullanılır. | |
updateTenant(tenantId, tenantOptions) | Mevcut bir kiracı yapılandırmasını güncelleştirir. |
TenantManager.authForTenant()
Verilen kiracı kimliğine bağlı bir TenantAwareAuth
örneğini döndürür.
İmza:
authForTenant(tenantId: string): TenantAwareAuth;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kiracı kimliği | sicim | TenantAwareAuth örneğinin döndürüleceği kiracı kimliği. |
İadeler:
Bu kiracı tanımlayıcısına karşılık gelen TenantAwareAuth
örneği.
TenantManager.createTenant()
Yeni bir kiracı oluşturur. Yeni kiracılar oluştururken, ayrı faturalandırma ve kota kullanan kiracıların kendi projelerini gerektirmesi ve full_service
olarak tanımlanması gerekir. .
İmza:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kiracıSeçenekler | Kiracı Talebi Oluştur | Oluşturulacak yeni kiracı yapılandırmasında ayarlanacak özellikler. |
İadeler:
Söz < Kiracı >
Yeni oluşturulan kiracıya karşılık gelen kiracı yapılandırmasıyla yerine getirilen bir söz.
TenantManager.deleteTenant()
Mevcut bir kiracıyı siler.
İmza:
deleteTenant(tenantId: string): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kiracı kimliği | sicim | Silinecek kiracıya karşılık gelen tenantId . |
İadeler:
Söz<void>
Kiracı silindikten sonra yerine getirilen boş bir söz.
TenantManager.getTenant()
Belirli bir kiracı tenantId
karşılık gelen kiracı için kiracı yapılandırmasını alır .
İmza:
getTenant(tenantId: string): Promise<Tenant>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kiracı kimliği | sicim | Verileri alınacak kiracıya karşılık gelen kiracı tanımlayıcısı. |
İadeler:
Söz < Kiracı >
Sağlanan tenantId
kiracı yapılandırmasıyla yerine getirilen bir söz .
TenantManager.listTenants()
pageToken
tarafından belirtilen uzaklıktan başlayarak maxResults
boyutuna sahip kiracıların listesini (yalnızca tek toplu iş) alır . Bu, belirli bir projenin tüm kiracılarını toplu olarak almak için kullanılır.
İmza:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
maxSonuçlar | sayı | Sayfa boyutu, tanımlanmamışsa 1000. Bu aynı zamanda izin verilen maksimum sınırdır. |
sayfaToken | sicim | Sonraki sayfa jetonu. Belirtilmediği takdirde herhangi bir mahsup olmadan başlayan kiracıları döndürür. |
İadeler:
Söz< ListeKiracılarSonuç >
Bir dizi indirilen kiracı ve sonraki sayfa jetonuyla çözülen bir söz.
TenantManager.updateTenant()
Mevcut bir kiracı yapılandırmasını güncelleştirir.
İmza:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kiracı kimliği | sicim | Silinecek kiracıya karşılık gelen tenantId . |
kiracıSeçenekler | Kiracı Talebi Güncelleme | Sağlanan kiracıda güncelleştirilecek özellikler. |
İadeler:
Söz < Kiracı >
Kiracı verilerinin güncellenmesiyle yerine getirilen bir söz.