33 lines
1.5 KiB
C#
33 lines
1.5 KiB
C#
namespace Core.Blueprint.Mongo
|
|
{
|
|
/// <summary>
|
|
/// Represents the settings required to connect to a MongoDB instance, including the connection string,
|
|
/// database name, and audience used for authentication.
|
|
/// </summary>
|
|
public interface IMongoDbSettings
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the connection string used to connect to the MongoDB instance.
|
|
/// The connection string includes details such as server address, port,
|
|
/// authentication credentials, and any additional options needed for connection.
|
|
/// </summary>
|
|
/// <value>A string representing the MongoDB connection string.</value>
|
|
string ConnectionString { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the name of the MongoDB database to connect to.
|
|
/// This value specifies which database to use within the MongoDB instance.
|
|
/// </summary>
|
|
/// <value>A string representing the name of the MongoDB database.</value>
|
|
string Databasename { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the audience (resource identifier) for MongoDB authentication.
|
|
/// This is typically used in token-based authentication schemes (e.g., OAuth or OpenID Connect),
|
|
/// to specify the intended recipient of an access token.
|
|
/// </summary>
|
|
/// <value>A string representing the MongoDB audience (resource identifier for authentication).</value>
|
|
string Audience { get; set; }
|
|
}
|
|
}
|