Skip to content
DocsTry Aspire
DocsTry

EntityFrameworkCoreCosmosSettings Properties

ClassProperties7 members
The settings relevant to accessing Azure Cosmos DB database using EntityFrameworkCore.
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 EntityFrameworkCoreCosmosSettings.Credential to establish the connection.
ConnectionStringSection titled ConnectionStringnullablestring?
The connection string of the Azure Cosmos DB server database to connect to.
public string? ConnectionString { 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?
The name of the database to connect to.
public string? DatabaseName { get; set; }
Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
public bool DisableTracing { get; set; }
RegionSection titled Regionnullablestring?
Gets or sets a string value that indicates what Azure region this client will run in.
public string? Region { get; set; }
RequestTimeoutSection titled RequestTimeoutnullableTimeSpan?
Gets or sets the time to wait for the response to come back from the network peer.
public TimeSpan? RequestTimeout { get; set; }