AzureCosmosExtensions

Classstaticnet10.0

📦 Aspire.Hosting.Azure.CosmosDB v13.6.0

Extension methods for adding Azure Cosmos DB resources to the application model.

namespace Aspire.Hosting;

public static class AzureCosmosExtensions
{
    // ...
}

15 members

Methods15

AddAzureCosmosDB(IDistributedApplicationBuilder, string)extensionats export

IResourceBuilder<AzureCosmosDBResource>

Adds an Azure Cosmos DB connection to the application model.

AddContainer(IResourceBuilder<AzureCosmosDBDatabaseResource>, string, string, string?)extensionats ignored

IResourceBuilder<AzureCosmosDBContainerResource>

Adds a container to the associated Cosmos DB database resource.

AddContainer(IResourceBuilder<AzureCosmosDBDatabaseResource>, string, IEnumerable<string>, string?)extensionats ignored

IResourceBuilder<AzureCosmosDBContainerResource>

Adds a container to the associated Cosmos DB database resource with hierarchical partition keys.

AddCosmosDatabase(IResourceBuilder<AzureCosmosDBResource>, string, string?)extensionats export

IResourceBuilder<AzureCosmosDBDatabaseResource>

Adds a database to the associated Cosmos DB account resource.

AddDatabase(IResourceBuilder<AzureCosmosDBResource>, string)extensionobsoleteats ignored

IResourceBuilder<AzureCosmosDBResource>

Adds a database to the associated Cosmos DB account resource.

RunAsClassicEmulator(IResourceBuilder<AzureCosmosDBResource>, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>)extensionats export

IResourceBuilder<AzureCosmosDBResource>

Configures an Azure Cosmos DB resource to be emulated using the classic Azure Cosmos DB emulator with the NoSQL API. This resource requires an AzureCosmosDBResource to be added to the application model. For more information on the Azure Cosmos DB emulator, see https://learn.microsoft.com/azure/cosmos-db/emulator#authentication.

RunAsEmulator(IResourceBuilder<AzureCosmosDBResource>, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>)extensionats export

IResourceBuilder<AzureCosmosDBResource>

Configures an Azure Cosmos DB resource to be emulated using the Azure Cosmos DB Linux-based (vNext) emulator with the NoSQL API. This resource requires an AzureCosmosDBResource to be added to the application model. For more information on the Azure Cosmos DB emulator, see https://learn.microsoft.com/azure/cosmos-db/emulator-linux.

RunAsPreviewEmulator(IResourceBuilder<AzureCosmosDBResource>, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>)extensionobsoleteats export

IResourceBuilder<AzureCosmosDBResource>

Configures an Azure Cosmos DB resource to be emulated using the Azure Cosmos DB Linux-based (vNext) emulator with the NoSQL API.

WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>)extensionats ignored

IResourceBuilder<AzureCosmosDBResource>

Configures the resource to use access key authentication with Azure Cosmos DB.

WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>, IResourceBuilder<IAzureKeyVaultResource>)extensionats ignored

IResourceBuilder<AzureCosmosDBResource>

Configures the resource to use access key authentication with Azure Cosmos DB.

WithDataExplorer(IResourceBuilder<AzureCosmosDBEmulatorResource>, int?)extensionats export

IResourceBuilder<AzureCosmosDBEmulatorResource>

Configures the Azure Cosmos DB Linux-based (vNext) emulator to expose the Data Explorer endpoint.

WithDataVolume(IResourceBuilder<AzureCosmosDBEmulatorResource>, string?)extensionats export

IResourceBuilder<AzureCosmosDBEmulatorResource>

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

WithDefaultAzureSku(IResourceBuilder<AzureCosmosDBResource>)extensionats export

IResourceBuilder<AzureCosmosDBResource>

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

WithGatewayPort(IResourceBuilder<AzureCosmosDBEmulatorResource>, int?)extensionats export

IResourceBuilder<AzureCosmosDBEmulatorResource>

Configures the gateway port for the Azure Cosmos DB emulator.

WithPartitionCount(IResourceBuilder<AzureCosmosDBEmulatorResource>, int)extensionats export

IResourceBuilder<AzureCosmosDBEmulatorResource>

Configures the partition count for the Azure Cosmos DB emulator.

View all methods