AzureCosmosDBResource

Handle

📦 Aspire.Hosting.Azure.CosmosDB v13.4.0

interface AzureCosmosDBResource
  extends IAzureResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithParameters,
    IValueProvider,
    IValueWithReferences,
    IAzureNspAssociationTarget,
    IAzurePrivateEndpointTarget,
    IResourceWithAzureFunctionsConfig {
  addCosmosDatabase(
      name: string,
      databaseName?: string): AzureCosmosDBDatabaseResource;
  runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource;
  runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource;
  withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureCosmosDBResource;
  withDefaultAzureSku(): AzureCosmosDBResource;
}

5 members

Methods

method addCosmosDatabase builder

Adds a database to the associated Cosmos DB account resource.

addCosmosDatabase(
    name: string,
    databaseName?: string): AzureCosmosDBDatabaseResource

Parameters

name string

databaseName string optional

Returns

AzureCosmosDBDatabaseResource

method runAsEmulator builder

Configures the Azure Cosmos DB resource to run using the local emulator

runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource

Parameters

configureContainer (obj: AzureCosmosDBEmulatorResource) => Promise<void> optional

Returns

AzureCosmosDBResource

method runAsPreviewEmulator builder

Configures the Azure Cosmos DB resource to run using the preview emulator

runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise<void>): AzureCosmosDBResource

Parameters

configureContainer (obj: AzureCosmosDBEmulatorResource) => Promise<void> optional

Returns

AzureCosmosDBResource

method withAccessKeyAuthentication builder

Configures Azure Cosmos DB to use access key authentication

withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureCosmosDBResource

Parameters

keyVaultBuilder IAzureKeyVaultResource optional

Returns

AzureCosmosDBResource

method withDefaultAzureSku builder

Configures the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.

withDefaultAzureSku(): AzureCosmosDBResource

Returns

AzureCosmosDBResource