Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AzureCosmosDBResource

Handle
📦 Aspire.Hosting.Azure.CosmosDB v17.0.0
type AzureCosmosDBResource interface {
ExpressionValue
Resource
ResourceWithConnectionString
ResourceWithEndpoints
}

Methods

methodAddCosmosDatabasebuilder
Adds a database to the associated Cosmos DB account resource.
AddCosmosDatabase(
name string,
options ...*AddCosmosDatabaseOptions,
) AzureCosmosDBDatabaseResource
namestringThe name of the database resource.
options...*AddCosmosDatabaseOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*AddCosmosDatabaseOptions argument.

DatabaseName*stringThe name of the database. If not provided, this defaults to the same value as name.
AzureCosmosDBDatabaseResource

The resource builder.

Returns a handle; failures surface later via Err().

Configures the Azure Cosmos DB resource to run using the classic emulator
RunAsClassicEmulator(options ...*RunAsClassicEmulatorOptions) AzureCosmosDBResource
options...*RunAsClassicEmulatorOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*RunAsClassicEmulatorOptions argument.

ConfigureContainerfunc(obj AzureCosmosDBEmulatorResource)callbackCallback that exposes underlying container used for emulation to allow for customization.
AzureCosmosDBResource

The resource builder.

Returns a handle; failures surface later via Err().

methodRunAsEmulatorbuilder
Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator
RunAsEmulator(options ...*RunAsEmulatorOptions) AzureCosmosDBResource
options...*RunAsEmulatorOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*RunAsEmulatorOptions argument.

ConfigureContainerfunc(obj AzureCosmosDBEmulatorResource)callbackCallback that exposes underlying container used for emulation to allow for customization.
AzureCosmosDBResource

The resource builder.

Returns a handle; failures surface later via Err().

Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator. Use runAsEmulator instead.
RunAsPreviewEmulator(options ...*RunAsPreviewEmulatorOptions) AzureCosmosDBResource
options...*RunAsPreviewEmulatorOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*RunAsPreviewEmulatorOptions argument.

ConfigureContainerfunc(obj AzureCosmosDBEmulatorResource)callbackCallback that exposes underlying container used for emulation to allow for customization.
AzureCosmosDBResource

The resource builder.

Returns a handle; failures surface later via Err().

Configures Azure Cosmos DB to use access key authentication
WithAccessKeyAuthentication(options ...*WithAccessKeyAuthenticationOptions) AzureCosmosDBResource
options...*WithAccessKeyAuthenticationOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithAccessKeyAuthenticationOptions argument.

KeyVaultBuilder*AzureKeyVaultResource
AzureCosmosDBResource

Returns a handle; failures surface later via Err().

methodWithDefaultAzureSkubuilder
Configures the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.
WithDefaultAzureSku() AzureCosmosDBResource
AzureCosmosDBResource

The resource builder.

Returns a handle; failures surface later via Err().