AzureCosmosDBResource

Classnet10.0

📦 Aspire.Hosting.Azure.CosmosDB v13.6.0

A resource that represents an Azure Cosmos DB.

namespace Aspire.Hosting;

public class AzureCosmosDBResource
    : Aspire.Hosting.Azure.AzureProvisioningResource,
      Aspire.Hosting.ApplicationModel.IExpressionValue,
      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.IAzureNspAssociationTarget,
      Aspire.Hosting.Azure.IAzurePrivateEndpointTarget,
      Aspire.Hosting.Azure.IResourceWithAzureFunctionsConfig
{
    // ...
}

AzureProvisioningResourceIExpressionValueIManifestExpressionProviderIResourceIResourceWithConnectionStringIResourceWithEndpointsIValueProviderIValueWithReferencesIAzureNspAssociationTargetIAzurePrivateEndpointTargetIResourceWithAzureFunctionsConfig

12 members

Constructors1

AzureCosmosDBResource(string, Action<AzureResourceInfrastructure>)

A resource that represents an Azure Cosmos DB.

View all constructors

Properties9

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

AddAsExistingResource(AzureResourceInfrastructure)

ProvisionableResource

Adds a new Primitives.ProvisionableResource into infra. The new resource represents a reference to the current Azure.AzureProvisioningResource via https://learn.microsoft.com/azure/azure-resource-manager/bicep/existing-resource.

AddRoleAssignments(IAddRoleAssignmentsContext)

Adds role assignments to this Azure resource.

View all methods