# DocumentDBVersion

- Kind: `enum`
- Package: [Aspire.Hosting.DocumentDB](/reference/api/csharp/aspire.hosting.documentdb.md)
- Version: `0.111.0`
- Namespace: `Aspire.Hosting.ApplicationModel`
- Target framework: `net10.0`
- Source: [GitHub](https://github.com/microsoft/azure-databases-aspire/blob/d8d44d4322ce04a98c27e15113a2ecacf12152d8//home/runner/work/azure-databases-aspire/azure-databases-aspire/src/Aspire.Hosting.DocumentDB/DocumentDBVersion.cs)

Curated set of DocumentDB versions known to this build of the package. Each member maps to a published `documentdb-local` container tag of the form `pgN-X.Y.Z`.

## Definition

```csharp
namespace Aspire.Hosting.ApplicationModel;

public enum DocumentDBVersion
```

## Remarks

This enum is append-only. Members are added by the `check-documentdb-version` workflow when a new upstream version is published. Existing members and their explicit numeric values must never be renamed, removed, or reordered, as that would be a binary breaking change for callers compiled against earlier versions of this package. Members that should no longer be used are marked `ObsoleteAttribute` rather than removed.

Use with [DocumentDBBuilderExtensions.WithDocumentDBVersion(IResourceBuilder<DocumentDBServerResource>, DocumentDBVersion)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withdocumentdbversion-iresourcebuilder-documentdbserverresource-documentdbversion) to pin a specific version. Use [DocumentDBVersions](/reference/api/csharp/aspire.hosting.documentdb/documentdbversions.md) to enumerate all known versions or read the latest version known to this build.

## Enum Members

| Name | Value | Description |
| --- | --- | --- |
| V0_109_0 | 1 | DocumentDB 0.109.0. |
| V0_110_0 | 2 | DocumentDB 0.110.0. |
| V0_111_0 | 3 | DocumentDB 0.111.0. |
