CosmosOptions Class

Reference

Definition

Namespace:: Orleans.Persistence.Cosmos

Assembly:: Orleans.Persistence.Cosmos.dll

Package:: Microsoft.Orleans.Persistence.Cosmos v9.0.0

Package:: Microsoft.Orleans.Persistence.Cosmos v9.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Options for Azure Cosmos DB storage.

public abstract class CosmosOptions

type CosmosOptions = class

Public MustInherit Class CosmosOptions

Inheritance: Object
CosmosOptions

Derived: Orleans.Persistence.Cosmos.CosmosGrainStorageOptions

Constructors

CosmosOptions()

Properties

CleanResourcesOnInitialization	Delete the database on initialization. Intended only for testing scenarios.
ClientOptions	The options passed to the Cosmos DB client.
ContainerName	The name of the container to use to store clustering information.
ContainerThroughputProperties	Throughput properties for containers. The default value is `null`, which indicates that the serverless throughput mode will be used.
DatabaseName	The name of the database to use for clustering information. Defaults to `Orleans`.
DatabaseThroughput	Database configured throughput. If set to `null`, which is the default value, it will not be configured.
IsResourceCreationEnabled	Tries to create the database and container used for clustering if it does not exist. Defaults to `false`.
OperationExecutor	The operation executor used to execute operations using the Cosmos DB client.

Methods

ConfigureCosmosClient(Func<IServiceProvider,ValueTask<CosmosClient>>)	Configures the Cosmos DB client.
ConfigureCosmosClient(String, AzureKeyCredential)	Configures the Cosmos DB client.
ConfigureCosmosClient(String, String)	Configures the Cosmos DB client.
ConfigureCosmosClient(String, TokenCredential)	Configures the Cosmos DB client.
ConfigureCosmosClient(String)	Configures the Cosmos DB client.

Applies to

Dela via