CosmosDBWorkflowExtensions.CreateCheckpointStore Method
Definition
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.
Overloads
| Name | Description |
|---|---|
| CreateCheckpointStore(CosmosClient, String, String) |
Creates a Cosmos DB checkpoint store using an existing CosmosClient. |
| CreateCheckpointStore(String, String, String) |
Creates a Cosmos DB checkpoint store using connection string authentication. |
| CreateCheckpointStore<T>(CosmosClient, String, String) |
Creates a generic Cosmos DB checkpoint store using an existing CosmosClient. |
| CreateCheckpointStore<T>(String, String, String) |
Creates a generic Cosmos DB checkpoint store using connection string authentication. |
CreateCheckpointStore(CosmosClient, String, String)
Creates a Cosmos DB checkpoint store using an existing CosmosClient.
public static Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStore CreateCheckpointStore(Microsoft.Azure.Cosmos.CosmosClient cosmosClient, string databaseId, string containerId);static member CreateCheckpointStore : Microsoft.Azure.Cosmos.CosmosClient * string * string -> Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStorePublic Shared Function CreateCheckpointStore (cosmosClient As CosmosClient, databaseId As String, containerId As String) As CosmosCheckpointStoreParameters
- cosmosClient
- CosmosClient
The CosmosClient instance to use for Cosmos DB operations.
- databaseId
- String
The identifier of the Cosmos DB database.
- containerId
- String
The identifier of the Cosmos DB container.
Returns
A new instance of CosmosCheckpointStore.
Exceptions
Thrown when any required parameter is null.
Thrown when any string parameter is null or whitespace.
Applies to
CreateCheckpointStore(String, String, String)
Creates a Cosmos DB checkpoint store using connection string authentication.
public static Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStore CreateCheckpointStore(string connectionString, string databaseId, string containerId);static member CreateCheckpointStore : string * string * string -> Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStorePublic Shared Function CreateCheckpointStore (connectionString As String, databaseId As String, containerId As String) As CosmosCheckpointStoreParameters
- connectionString
- String
The Cosmos DB connection string.
- databaseId
- String
The identifier of the Cosmos DB database.
- containerId
- String
The identifier of the Cosmos DB container.
Returns
A new instance of CosmosCheckpointStore.
Exceptions
Thrown when any string parameter is null or whitespace.
Applies to
CreateCheckpointStore<T>(CosmosClient, String, String)
Creates a generic Cosmos DB checkpoint store using an existing CosmosClient.
public static Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStore<T> CreateCheckpointStore<T>(Microsoft.Azure.Cosmos.CosmosClient cosmosClient, string databaseId, string containerId);static member CreateCheckpointStore : Microsoft.Azure.Cosmos.CosmosClient * string * string -> Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStore<'T>Public Shared Function CreateCheckpointStore(Of T) (cosmosClient As CosmosClient, databaseId As String, containerId As String) As CosmosCheckpointStore(Of T)Type Parameters
- T
The type of objects to store as checkpoint values.
Parameters
- cosmosClient
- CosmosClient
The CosmosClient instance to use for Cosmos DB operations.
- databaseId
- String
The identifier of the Cosmos DB database.
- containerId
- String
The identifier of the Cosmos DB container.
Returns
A new instance of CosmosCheckpointStore<T>.
Exceptions
Thrown when any required parameter is null.
Thrown when any string parameter is null or whitespace.
Applies to
CreateCheckpointStore<T>(String, String, String)
Creates a generic Cosmos DB checkpoint store using connection string authentication.
public static Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStore<T> CreateCheckpointStore<T>(string connectionString, string databaseId, string containerId);static member CreateCheckpointStore : string * string * string -> Microsoft.Agents.AI.Workflows.Checkpointing.CosmosCheckpointStore<'T>Public Shared Function CreateCheckpointStore(Of T) (connectionString As String, databaseId As String, containerId As String) As CosmosCheckpointStore(Of T)Type Parameters
- T
The type of objects to store as checkpoint values.
Parameters
- connectionString
- String
The Cosmos DB connection string.
- databaseId
- String
The identifier of the Cosmos DB database.
- containerId
- String
The identifier of the Cosmos DB container.
Returns
A new instance of CosmosCheckpointStore<T>.
Exceptions
Thrown when any string parameter is null or whitespace.