किरायेदारों से जुड़े काम मैनेज करने के लिए इस्तेमाल किए जाने वाले टेनेंट मैनेजर के बारे में बताता है. इसमें इस तरह का कॉन्टेंट शामिल है:
- मौजूदा प्रोजेक्ट के लिए किरायेदारों को बनाने, अपडेट करने, उनकी सूची बनाने, पाने, और उन्हें मिटाने की सुविधा.
- बताए गए किरायेदार के लिए, पुष्टि से जुड़ी कार्रवाइयां (यूज़र मैनेजमेंट, प्रोवाइडर कॉन्फ़िगरेशन मैनेजमेंट, टोकन की पुष्टि, ईमेल लिंक जनरेट करने वगैरह) के लिए
TenantAwareAuthइंस्टेंस पाना.
हस्ताक्षर:
export declare class TenantManager
तरीके
| तरीका | मॉडिफ़ायर | ब्यौरा |
|---|---|---|
| authForTenant(tenantId) | दिए गए टेनेंट आईडी से जुड़ा TenantAwareAuth इंस्टेंस दिखाता है. |
|
| createTenant(tenantOptions) | नया किरायेदार बनाता है. नए टेनेंट बनाते समय, जो किरायेदार अलग बिलिंग और कोटा इस्तेमाल करते हैं उन्हें अपना प्रोजेक्ट बनाना होगा. साथ ही, उन्हें full_service के तौर पर तय करना होगा. |
|
| deleteTenant(tenantId) | मौजूदा किरायेदार को मिटा देता है. | |
| getTenant(tenantId) | इसमें, दिए गए tenantId के हिसाब से किरायेदार (टेनेंट) का कॉन्फ़िगरेशन मिलता है. |
|
| listTenants(maxresults, pageToken) | pageToken के बताए गए ऑफ़सेट से शुरू होने वाले maxResults साइज़ वाले किरायेदारों (सिर्फ़ एक बैच) की सूची लाता है. इसका इस्तेमाल किसी खास प्रोजेक्ट के सभी टेनेंट को बैच में पाने के लिए किया जाता है. |
|
| updateTenant(tenantId, TenantOptions) | किरायेदार (टेनेंट) के मौजूदा कॉन्फ़िगरेशन को अपडेट करता है. |
TenantManager.authForTenant()
दिए गए टेनेंट आईडी से जुड़ा TenantAwareAuth इंस्टेंस दिखाता है.
हस्ताक्षर:
authForTenant(tenantId: string): TenantAwareAuth;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| किराये पर इस्तेमाल करने वाले का आईडी | स्ट्रिंग | उस किरायेदार का आईडी जिसका TenantAwareAuth इंस्टेंस लौटाना है. |
लौटाए जाने वाले प्रॉडक्ट:
इस टेनेंट आइडेंटिफ़ायर से जुड़ा TenantAwareAuth इंस्टेंस.
TenantManager.createTenant()
नया किरायेदार बनाता है. नए किरायेदार (टेनेंट) बनाते समय, जो किरायेदार अलग बिलिंग और कोटा इस्तेमाल करते हैं उन्हें अपना प्रोजेक्ट बनाना होगा. साथ ही, उन्हें full_service के तौर पर सेट करना होगा.
हस्ताक्षर:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| किराये पर इस्तेमाल करने के विकल्प | CreateTenantRequest | नए टेनेंट कॉन्फ़िगरेशन पर सेट की जाने वाली प्रॉपर्टी. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<टेनेंट>
नए किरायेदार (टेनेंट) के हिसाब से, टेनेंट के कॉन्फ़िगरेशन को पूरा करके प्रॉमिस पूरा किया जाएगा.
TenantManager.deleteTenant()
मौजूदा किरायेदार को मिटा देता है.
हस्ताक्षर:
deleteTenant(tenantId: string): Promise<void>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| किराये पर इस्तेमाल करने वाले का आईडी | स्ट्रिंग | किरायेदार से जुड़ा tenantId, जिसे मिटाना है. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<void>
किरायेदार की जानकारी मिटाए जाने के बाद, पूरा प्रॉमिस पूरा होना चाहिए.
TenantManager.getTenant()
यहां, किराये पर इस्तेमाल करने वाले (टेनेंट) के लिए, दिए गए tenantId के हिसाब से टेनेंट का कॉन्फ़िगरेशन मिलता है.
हस्ताक्षर:
getTenant(tenantId: string): Promise<Tenant>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| किराये पर इस्तेमाल करने वाले का आईडी | स्ट्रिंग | किरायेदार का आइडेंटिफ़ायर, जिसका डेटा फ़ेच करना है. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<टेनेंट>
दिए गए tenantId के लिए, किराये पर इस्तेमाल करने वाले (टेनेंट) के कॉन्फ़िगरेशन के साथ प्रॉमिस पूरा किया जाएगा.
TenantManager.listTenants()
pageToken के बताए गए ऑफ़सेट से शुरू होने वाले maxResults साइज़ वाले किरायेदारों (सिर्फ़ एक बैच) की सूची लाता है. इसका इस्तेमाल किसी खास प्रोजेक्ट के सभी टेनेंट को बैच में पाने के लिए किया जाता है.
हस्ताक्षर:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| ज़्यादा से ज़्यादा नतीजे | नंबर | पेज का साइज़, 1,000 (अगर इसके बारे में जानकारी नहीं है). इस सीमा को भी अपलोड करने की अनुमति है. |
| पेज टोकन | स्ट्रिंग | अगला पेज टोकन. अगर इसके बारे में नहीं बताया गया है, तो बिना किसी ऑफ़सेट के शुरू होने वाले टेनेंट दिखाता है. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<ListTenantsresults>
एक प्रॉमिस जो टेनेंट के डाउनलोड किए गए बैच और अगले पेज टोकन के साथ पूरा होता है.
TenantManager.updateTenant()
किरायेदार (टेनेंट) के मौजूदा कॉन्फ़िगरेशन को अपडेट करता है.
हस्ताक्षर:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| किराये पर इस्तेमाल करने वाले का आईडी | स्ट्रिंग | किरायेदार से जुड़ा tenantId, जिसे मिटाना है. |
| किराये पर इस्तेमाल करने के विकल्प | UpdateTenantRequest | दिए गए किरायेदारों पर अपडेट की जाने वाली प्रॉपर्टी. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<टेनेंट>
टेनेंट डेटा को अपडेट करने से किया गया प्रॉमिस.