Skip to content
Docs Try Aspire
Docs Try

Aspire.Hosting.Azure.CosmosDB

Official
📦 Aspire.Hosting.Azure.CosmosDB v13.3.0
11 Functions
4 Types

Types

Functions

method addAzureCosmosDB builder
Adds an Azure Cosmos DB resource
addAzureCosmosDB(name: string): AzureCosmosDBResource
method addContainer builder
Adds an Azure Cosmos DB container resource
addContainer(name: string, partitionKeyPaths: string|string[], containerName?: string): AzureCosmosDBContainerResource
method addCosmosDatabase builder
Adds an Azure Cosmos DB database resource
addCosmosDatabase(name: string, databaseName?: string): AzureCosmosDBDatabaseResource
method runAsEmulator builder
Configures the Azure Cosmos DB resource to run using the local emulator
runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource
method runAsPreviewEmulator builder
Configures the Azure Cosmos DB resource to run using the preview emulator
runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource
method withAccessKeyAuthentication builder
Configures Azure Cosmos DB to use access key authentication
withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureCosmosDBResource
method withDataExplorer builder
Exposes the Data Explorer endpoint for the preview emulator
withDataExplorer(port?: number): AzureCosmosDBEmulatorResource
method withDataVolume builder
Adds a named volume for the data folder to an Azure Cosmos DB emulator resource
withDataVolume(name?: string): AzureCosmosDBEmulatorResource
method withDefaultAzureSku builder
Configures Azure Cosmos DB to use the default Azure SKU
withDefaultAzureSku(): AzureCosmosDBResource
method withGatewayPort builder
Sets the host port for the Cosmos DB emulator gateway endpoint
withGatewayPort(port: number): AzureCosmosDBEmulatorResource
method withPartitionCount builder
Sets the partition count for the Azure Cosmos DB emulator
withPartitionCount(count: number): AzureCosmosDBEmulatorResource