# TenantDescriptor

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.tenantdescriptor/
> Summary: TenantDescriptor: A registered tenant.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Abstractions.dll</code></div>

A registered tenant.

```csharp
public sealed record TenantDescriptor : IEquatable<TenantDescriptor>
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.tenantdescriptor/">TenantDescriptor</a></dd><dt>Implements</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable&lt;TenantDescriptor&gt;</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Remarks

A tenant registration is **not required**. The `tenant_id`
in other tables is the same text as this table's `slug` value, but it
carries no foreign key: a tenant with no registration must not error at
run time. The registration only provides a name and description to the
tenant picker in the UI.

## Constructors

### <a id="Tracon_TenantDescriptor__ctor"></a> TenantDescriptor\(\)

```csharp
public TenantDescriptor()
```

## Properties

### <a id="Tracon_TenantDescriptor_CreatedAt"></a> CreatedAt

The creation time (UTC).

```csharp
public DateTimeOffset CreatedAt { get; init; }
```

#### Property Value

 [DateTimeOffset](https://learn.microsoft.com/dotnet/api/system.datetimeoffset)

### <a id="Tracon_TenantDescriptor_DisplayName"></a> DisplayName

The name shown in the UI.

```csharp
public required string DisplayName { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Tracon_TenantDescriptor_Id"></a> Id

The tenant identifier. A time-ordered UUID (v7).

```csharp
public required Guid Id { get; init; }
```

#### Property Value

 [Guid](https://learn.microsoft.com/dotnet/api/system.guid)

### <a id="Tracon_TenantDescriptor_Slug"></a> Slug

The tenant key. The same text as the `tenant_id` column in other
tables, and `ITenantContext.TenantId` returns this value.

```csharp
public required string Slug { get; init; }
```

#### Property Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Methods

### <a id="Tracon_TenantDescriptor_Equals_System_Object_"></a> Equals\(object?\)

```csharp
public override bool Equals(object? obj)
```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_TenantDescriptor_Equals_Tracon_TenantDescriptor_"></a> Equals\(TenantDescriptor?\)

```csharp
public bool Equals(TenantDescriptor? other)
```

#### Parameters

`other` [TenantDescriptor](/api/tracon.tenantdescriptor/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_TenantDescriptor_GetHashCode"></a> GetHashCode\(\)

```csharp
public override int GetHashCode()
```

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="Tracon_TenantDescriptor_ToString"></a> ToString\(\)

```csharp
public override string ToString()
```

#### Returns

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Operators

### <a id="Tracon_TenantDescriptor_op_Equality_Tracon_TenantDescriptor_Tracon_TenantDescriptor_"></a> operator ==\(TenantDescriptor?, TenantDescriptor?\)

```csharp
public static bool operator ==(TenantDescriptor? left, TenantDescriptor? right)
```

#### Parameters

`left` [TenantDescriptor](/api/tracon.tenantdescriptor/)?

`right` [TenantDescriptor](/api/tracon.tenantdescriptor/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_TenantDescriptor_op_Inequality_Tracon_TenantDescriptor_Tracon_TenantDescriptor_"></a> operator \!=\(TenantDescriptor?, TenantDescriptor?\)

```csharp
public static bool operator !=(TenantDescriptor? left, TenantDescriptor? right)
```

#### Parameters

`left` [TenantDescriptor](/api/tracon.tenantdescriptor/)?

`right` [TenantDescriptor](/api/tracon.tenantdescriptor/)?

#### Returns

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)