AzureCosmosExtensions
Class static net8.0
Extension methods for adding Azure Cosmos DB resources to the application model.
namespace Aspire.Hosting;
public static class AzureCosmosExtensions{ // ...} 14 members
Methods14
Section titled MethodsAddAzureCosmosDB(IDistributedApplicationBuilder, string)extensionats exportIResourceBuilder<AzureCosmosDBResource> Adds an Azure Cosmos DB connection to the application model.
AddContainer(IResourceBuilder<AzureCosmosDBDatabaseResource>, string, string, string?)extensionats exportIResourceBuilder<AzureCosmosDBContainerResource> Adds a container to the associated Cosmos DB database resource.
AddContainer(IResourceBuilder<AzureCosmosDBDatabaseResource>, string, IEnumerable<string>, string?)extensionats exportIResourceBuilder<AzureCosmosDBContainerResource> Adds a container to the associated Cosmos DB database resource with hierarchical partition keys.
AddCosmosDatabase(IResourceBuilder<AzureCosmosDBResource>, string, string?)extensionats exportIResourceBuilder<AzureCosmosDBDatabaseResource> Adds a database to the associated Cosmos DB account resource.
AddDatabase(IResourceBuilder<AzureCosmosDBResource>, string)extensionobsoleteats ignoredIResourceBuilder<AzureCosmosDBResource> Adds a database to the associated Cosmos DB account resource.
RunAsEmulator(IResourceBuilder<AzureCosmosDBResource>, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>)extensionats exportIResourceBuilder<AzureCosmosDBResource> Configures an Azure Cosmos DB resource to be emulated using the 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. RunAsPreviewEmulator(IResourceBuilder<AzureCosmosDBResource>, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>)extensionexperimentalats exportIResourceBuilder<AzureCosmosDBResource> Configures an Azure Cosmos DB resource to be emulated using the Azure Cosmos DB Linux-based emulator (preview) 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. WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>)extensionats exportIResourceBuilder<AzureCosmosDBResource> Configures the resource to use access key authentication with Azure Cosmos DB.
WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>, IResourceBuilder<IAzureKeyVaultResource>)extensionats exportIResourceBuilder<AzureCosmosDBResource> Configures the resource to use access key authentication with Azure Cosmos DB.
WithDataExplorer(IResourceBuilder<AzureCosmosDBEmulatorResource>, int?)extensionexperimentalats exportIResourceBuilder<AzureCosmosDBEmulatorResource> Configures the Azure Cosmos DB preview emulator to expose the Data Explorer endpoint.
WithDataVolume(IResourceBuilder<AzureCosmosDBEmulatorResource>, string?)extensionats exportIResourceBuilder<AzureCosmosDBEmulatorResource> Adds a named volume for the data folder to an Azure Cosmos DB emulator resource.
WithDefaultAzureSku(IResourceBuilder<AzureCosmosDBResource>)extensionats exportIResourceBuilder<AzureCosmosDBResource> Configures the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.
WithGatewayPort(IResourceBuilder<AzureCosmosDBEmulatorResource>, int?)extensionats exportIResourceBuilder<AzureCosmosDBEmulatorResource> Configures the gateway port for the Azure Cosmos DB emulator.
WithPartitionCount(IResourceBuilder<AzureCosmosDBEmulatorResource>, int)extensionats exportIResourceBuilder<AzureCosmosDBEmulatorResource> Configures the partition count for the Azure Cosmos DB emulator.