# DocumentDBBuilderExtensions

- Kind: `class`
- Package: [Aspire.Hosting.DocumentDB](/reference/api/csharp/aspire.hosting.documentdb.md)
- Version: `0.111.0`
- Namespace: `Aspire.Hosting`
- 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/DocumentDBBuilderExtensions.cs)

Provides extension methods for adding DocumentDB resources to an `Hosting.IDistributedApplicationBuilder`.

## Definition

```csharp
namespace Aspire.Hosting;

public static class DocumentDBBuilderExtensions
{
    // ...
}
```

## Methods

- [AddDatabase(IResourceBuilder<DocumentDBServerResource>, string, string?)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#adddatabase-iresourcebuilder-documentdbserverresource-string-string) : `IResourceBuilder<DocumentDBDatabaseResource>` `extension` -- Adds a DocumentDB database to the application model.
- [AddDocumentDB(IDistributedApplicationBuilder, string, int?)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#adddocumentdb-idistributedapplicationbuilder-string-int) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Adds a DocumentDB resource to the application model. A container is used for local development.
- [AddDocumentDB(IDistributedApplicationBuilder, string, int?, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#adddocumentdb-idistributedapplicationbuilder-string-int-iresourcebuilder-parameterresource-iresourcebuilder-parameterresource) : `IResourceBuilder<DocumentDBServerResource>` `extension`
- [AllowInsecureTls(IResourceBuilder<DocumentDBServerResource>, bool)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#allowinsecuretls-iresourcebuilder-documentdbserverresource-bool) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Allows insecure TLS connections by adding `tlsInsecure=true` to the connection string. This is enabled by default so the .NET MongoDB driver can connect to the self-signed certificate used by the DocumentDB Local container. Call `AllowInsecureTls(false)` to require valid certificates.
- [UseTls(IResourceBuilder<DocumentDBServerResource>, bool)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#usetls-iresourcebuilder-documentdbserverresource-bool) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Enables TLS for the DocumentDB connection string. TLS is enabled by default because the DocumentDB Local container requires TLS connections. Call `UseTls(false)` to disable TLS if connecting to a non-TLS endpoint.
- [WithDataBindMount(IResourceBuilder<DocumentDBServerResource>, string, bool)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withdatabindmount-iresourcebuilder-documentdbserverresource-string-bool) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Adds a bind mount for the data folder to a DocumentDB container resource.
- [WithDataVolume(IResourceBuilder<DocumentDBServerResource>, string?, bool, string?)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withdatavolume-iresourcebuilder-documentdbserverresource-string-bool-string) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Adds a named volume for the data folder to a DocumentDB container resource.
- [WithDocumentDBVersion(IResourceBuilder<DocumentDBServerResource>, DocumentDBVersion)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withdocumentdbversion-iresourcebuilder-documentdbserverresource-documentdbversion) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Pins the DocumentDB version to a specific release known to this build of the package.
- [WithHostPort(IResourceBuilder<DocumentDBServerResource>, int?)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withhostport-iresourcebuilder-documentdbserverresource-int) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Configures the host port that the DocumentDB resource is exposed on instead of using randomly assigned port.
- [WithInitData(IResourceBuilder<DocumentDBServerResource>, string)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withinitdata-iresourcebuilder-documentdbserverresource-string) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Mounts custom initialization scripts into the DocumentDB Local container.
- [WithLogLevel(IResourceBuilder<DocumentDBServerResource>, DocumentDBLogLevel)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withloglevel-iresourcebuilder-documentdbserverresource-documentdbloglevel) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Configures the DocumentDB Local container log level.
- [WithoutSampleData(IResourceBuilder<DocumentDBServerResource>)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withoutsampledata-iresourcebuilder-documentdbserverresource) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Disables the built-in sample data initialization performed by the DocumentDB Local container.
- [WithOwner(IResourceBuilder<DocumentDBServerResource>, string)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withowner-iresourcebuilder-documentdbserverresource-string) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Configures the owner used by the DocumentDB Local container.
- [WithPostgresVersion(IResourceBuilder<DocumentDBServerResource>, DocumentDBPostgresVersion)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withpostgresversion-iresourcebuilder-documentdbserverresource-documentdbpostgresversion) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Selects the PostgreSQL backend variant of the `documentdb-local` container image.
- [WithTelemetry(IResourceBuilder<DocumentDBServerResource>, bool)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withtelemetry-iresourcebuilder-documentdbserverresource-bool) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Enables or disables DocumentDB Local telemetry.
- [WithTlsCertificate(IResourceBuilder<DocumentDBServerResource>, string, string)](/reference/api/csharp/aspire.hosting.documentdb/documentdbbuilderextensions/methods.md#withtlscertificate-iresourcebuilder-documentdbserverresource-string-string) : `IResourceBuilder<DocumentDBServerResource>` `extension` -- Mounts a custom TLS certificate and key into the DocumentDB Local container.