Aspire.Hosting.Azure.CosmosDB
Official
📦 Aspire.Hosting.Azure.CosmosDB v13.4.0 11 Functions
4 Types
4 types and 0 members
Types
Functions
method
addAzureCosmosDB builder Adds an Azure Cosmos DB connection to the application model.
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 a database to the associated Cosmos DB account 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 Configures the Azure Cosmos DB preview emulator to expose the Data Explorer endpoint.
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 the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.
withDefaultAzureSku(): AzureCosmosDBResource method
withGatewayPort builder Configures the gateway port for the Azure Cosmos DB emulator.
withGatewayPort(port: number): AzureCosmosDBEmulatorResource method
withPartitionCount builder Configures the partition count for the Azure Cosmos DB emulator.
withPartitionCount(count: number): AzureCosmosDBEmulatorResource