AzureCosmosDBResource

Handle

📦 Aspire.Hosting.Azure.CosmosDB v13.6.0

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

6 members

Methods

methodaddCosmosDatabasebuilder

Adds a database to the associated Cosmos DB account resource.

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

Parameters

namestring

databaseNamestringoptional

Returns

AzureCosmosDBDatabaseResource

methodrunAsClassicEmulatorbuilder

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

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

Parameters

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

Returns

AzureCosmosDBResource

methodrunAsEmulatorbuilder

Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator

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

Parameters

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

Returns

AzureCosmosDBResource

methodrunAsPreviewEmulatorbuilder

Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator. Use runAsEmulator instead.

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

Parameters

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

Returns

AzureCosmosDBResource

methodwithAccessKeyAuthenticationbuilder

Configures Azure Cosmos DB to use access key authentication

withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureCosmosDBResource

Parameters

keyVaultBuilderIAzureKeyVaultResourceoptional

Returns

AzureCosmosDBResource

methodwithDefaultAzureSkubuilder

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

withDefaultAzureSku(): AzureCosmosDBResource

Returns

AzureCosmosDBResource