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