ITenantDeprovisioningStep<TKey> interface
Namespace: Tenantry.Pro · Package: Tenantry.Pro · API reference
A step of offboarding a tenant (ITenantDeprovisioner<TKey>): export its data, archive it, tell another system. Add one with IProBuilder<TKey>.AddDeprovisioningStep<TStep>; the application's steps run before Tenantry drops anything.
public interface ITenantDeprovisioningStep<TKey> where TKey : IEquatable<TKey>, IParsable<TKey>Type parameters
TKey: The tenant identifier type.
Methods
AppliesTo(TenantDeprovisioningContext<TKey>)
Whether the step applies to the tenant; one that does not is reported as skipped. By default, every tenant.
bool AppliesTo(TenantDeprovisioningContext<TKey> context)Parameters:
contextTenantDeprovisioningContext<TKey>: The tenant being offboarded, its scope and its isolation.
Returns: bool: true to run the step.
ExecuteAsync(TenantDeprovisioningContext<TKey>, CancellationToken)
Runs the step. An exception fails it, and stops the steps after it.
Task ExecuteAsync(TenantDeprovisioningContext<TKey> context, CancellationToken cancellationToken)Parameters:
contextTenantDeprovisioningContext<TKey>: The tenant being offboarded, its scope and its isolation.cancellationTokenCancellationToken: Cancels the step.
Returns: Task: A task that completes when the step is done.
ITenantDeprovisioner<TKey> interface
Offboards a tenant, the reverse of ITenantProvisioner<TKey>tenantry-pro-itenantprovisioner.md: runs the deprovisioning steps and reports each one.
ITenantPropagationAdapter interface
An extension point: for code that extends the package, such as another package that builds on it.