AzureCosmosDBEmulatorResource

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

AzureCosmosDBEmulatorResource

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

Handle TypeScript

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

interface AzureCosmosDBEmulatorResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  withDataExplorer(port?: number): AzureCosmosDBEmulatorResource;
  withDataVolume(name?: string): AzureCosmosDBEmulatorResource;
  withGatewayPort(port: number): AzureCosmosDBEmulatorResource;
  withPartitionCount(count: number): AzureCosmosDBEmulatorResource;
}

Implements

• IComputeResource
• IResource
• IResourceWithArgs
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport

Methods

method withDataExplorer builder

Exposes the Data Explorer endpoint for the preview emulator

withDataExplorer(port?: number): AzureCosmosDBEmulatorResource

Parameters

port number optional

Returns

AzureCosmosDBEmulatorResource

method withDataVolume builder

Adds a named volume for the data folder to an Azure Cosmos DB emulator resource

withDataVolume(name?: string): AzureCosmosDBEmulatorResource

Parameters

name string optional

Returns

AzureCosmosDBEmulatorResource

method withGatewayPort builder

Sets the host port for the Cosmos DB emulator gateway endpoint

withGatewayPort(port: number): AzureCosmosDBEmulatorResource

Parameters

port number

Returns

AzureCosmosDBEmulatorResource

method withPartitionCount builder

Sets the partition count for the Azure Cosmos DB emulator

withPartitionCount(count: number): AzureCosmosDBEmulatorResource

Parameters

count number

Returns

AzureCosmosDBEmulatorResource