AzureCosmosDBResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Azure.CosmosDB / AzureCosmosDBResource

AzureCosmosDBResource

Docs Reference TypeScript APIs Aspire.Hosting.Azure.CosmosDB AzureCosmosDBResource

Handle TypeScript

📦 Aspire.Hosting.Azure.CosmosDB v13.2.0-preview.1.26159.1

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

Implements

• IAzureResource
• IManifestExpressionProvider
• IResource
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithParameters
• IValueProvider
• IValueWithReferences
• IAzurePrivateEndpointTarget
• IResourceWithAzureFunctionsConfig

Search members of AzureCosmosDBResource…

method

6 members Clear filters

Methods

method addCosmosDatabase builder

Adds an Azure Cosmos DB database 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) => void): AzureCosmosDBResource

Parameters

configureContainer (obj: AzureCosmosDBEmulatorResource) => void optional

Returns

AzureCosmosDBResource

method runAsPreviewEmulator builder

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

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

Parameters

configureContainer (obj: AzureCosmosDBEmulatorResource) => void optional

Returns

AzureCosmosDBResource

method withAccessKeyAuthentication builder

Configures Azure Cosmos DB to use access key authentication

withAccessKeyAuthentication(): AzureCosmosDBResource

Returns

AzureCosmosDBResource

method withAccessKeyAuthenticationWithKeyVault builder

Configures Azure Cosmos DB access key authentication using a specified Azure Key Vault resource

withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureCosmosDBResource

Parameters

keyVaultBuilder IAzureKeyVaultResource

Returns

AzureCosmosDBResource

method withDefaultAzureSku builder

Configures Azure Cosmos DB to use the default Azure SKU

withDefaultAzureSku(): AzureCosmosDBResource

Returns

AzureCosmosDBResource