Watch Aspire live streamsDocsTry Aspire

MicrosoftAzureCosmosSettings Properties

ClassProperties7 members
The settings relevant to accessing Azure Cosmos DB.
AccountEndpointSection titled AccountEndpointnullableUri?
A Uri referencing the Azure Cosmos DB Endpoint. This is likely to be similar to "https://{account_name}.documents.azure.com".
public Uri? AccountEndpoint { get; set; }
Must not contain shared access signature. Used along with MicrosoftAzureCosmosSettings.Credential to establish the connection.
ConnectionStringSection titled ConnectionStringnullablestring?
Gets or sets the connection string of the Azure Cosmos database to connect to.
public string? ConnectionString { get; set; }
ContainerNameSection titled ContainerNamenullablestring?
Gets or sets the name of the container to connect to.
public string? ContainerName { get; set; }
CredentialSection titled CredentialnullableTokenCredential?
Gets or sets the credential used to authenticate to the Azure Cosmos DB endpoint.
public TokenCredential? Credential { get; set; }
DatabaseNameSection titled DatabaseNamenullablestring?
Gets or sets the name of the database to connect to.
public string? DatabaseName { get; set; }
DisableHealthChecksSection titled DisableHealthChecksbool
Gets or sets a boolean value that indicates whether the Azure Cosmos DB health check is disabled or not.
public bool DisableHealthChecks { get; set; }
Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
public bool DisableTracing { get; set; }