Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

AzureCosmosDBResource

Class net8.0
📦 Aspire.Hosting.Azure.CosmosDB v13.2.0
A resource that represents an Azure Cosmos DB. 
namespace Aspire.Hosting;


public class AzureCosmosDBResource
    : Aspire.Hosting.Azure.AzureProvisioningResource,
      Aspire.Hosting.ApplicationModel.IManifestExpressionProvider,
      Aspire.Hosting.ApplicationModel.IResource,
      Aspire.Hosting.ApplicationModel.IResourceWithConnectionString,
      Aspire.Hosting.ApplicationModel.IResourceWithEndpoints,
      Aspire.Hosting.ApplicationModel.IValueProvider,
      Aspire.Hosting.ApplicationModel.IValueWithReferences,
      Aspire.Hosting.Azure.IAzurePrivateEndpointTarget,
      Aspire.Hosting.Azure.IResourceWithAzureFunctionsConfig
{
    // ...
}
AzureProvisioningResourceIManifestExpressionProviderIResourceIResourceWithConnectionStringIResourceWithEndpointsIValueProviderIValueWithReferencesIAzurePrivateEndpointTargetIResourceWithAzureFunctionsConfig
Inherits
AzureProvisioningResource→AzureCosmosDBResource
Implements
  • IManifestExpressionProvider
  • IResource
  • IResourceWithConnectionString
  • IResourceWithEndpoints
  • IValueProvider
  • IValueWithReferences
  • IAzurePrivateEndpointTarget
  • IResourceWithAzureFunctionsConfig
Source
12 members

Constructors1

Section titled Constructors
AzureCosmosDBResource(string, Action<AzureResourceInfrastructure>)
A resource that represents an Azure Cosmos DB.
View all constructors

Properties9

Section titled Properties
AccountKeyget
ReferenceExpression?
Gets the account key expression for the Cosmos DB account.
ConnectionStringgetobsolete
BicepSecretOutputReference
Gets the "connectionString" reference from the secret outputs of the Azure Cosmos DB resource.
ConnectionStringExpressionget
ReferenceExpression
Gets the connection string template for the manifest for the Azure Cosmos DB resource.
ConnectionStringOutputget
BicepOutputReference
Gets the "connectionString" output reference from the bicep template for the Azure Cosmos DB resource. This is used when Entra ID authentication is used. The connection string is an output of the bicep template.
Idget
BicepOutputReference
Gets the "id" output reference for the resource.
IsEmulatorget
bool
Gets a value indicating whether the Azure Cosmos DB resource is running in the local emulator.
NameOutputReferenceget
BicepOutputReference
Gets the "name" output reference for the resource.
UriExpressionget
ReferenceExpression
Gets the account endpoint URI expression for the Cosmos DB account.
UseAccessKeyAuthenticationget
bool
Gets a value indicating whether the resource uses access key authentication.
View all properties

Methods2

Section titled Methods
AddAsExistingResource(AzureResourceInfrastructure)
ProvisionableResource
AddRoleAssignments(IAddRoleAssignmentsContext)
View all methods
Connect with us

Community

SHA — b06aea4 © Microsoft