TAureliusTenantCatalog.AddTenant Method
Registers a tenant in the catalog if it does not exist yet, allocating a shard and running the provisioning event.
Remarks
The operation is idempotent and safe to retry: an already active tenant is simply returned, and a tenant left pending by a previous failed provisioning is provisioned again.
Syntax
Unit: Aurelius.Comp.TenantCatalog
function TAureliusTenantCatalog.AddTenant(const TenantId: string; const DisplayName: string; const AShardId: string): TTenantInfo;Parameters
| <-> | Parameter | Type | Description |
|---|---|---|---|
| const | TenantId | string | The unique id of the tenant. |
| const | DisplayName | string | Optional human-readable name of the tenant. |
| const | AShardId | string | Optional shard id. When empty, the Allocator picks a shard among the active ones. |
Returns
The catalog record of the tenant.