Skip to content

Parameters

Template repo: ConnectSoft.BaseTemplate

  • Short name: connectsoft-base
  • Identity: ConnectSoft.BaseTemplate
  • Source name: ConnectSoft.BaseTemplate
  • Default name: ConnectSoft.MyMicroservice1
  • Source modifiers: 81

Authoritative metadata: .template.config/template.json.

Template Symbols

Symbol Type Data type Default Choices Description
ArtifactKind parameter choice solution Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Controls whether the output is a materialized solution or an extensible template artifact.
IsMaterializedSolution computed ``
IsTemplateArtifact computed ``
AuthoringMode generated ``
Framework parameter choice net10.0 Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count The target framework for the project.
IfDebug generated ``
ElseDirective generated ``
EndIf generated ``
currentYear generated ``
buildDefinitionNumber parameter string `` Custom Azure DevOps build definition number for CI/CD integration. Leave empty to use default.
HttpPort parameter integer `` Port number to use for the HTTP endpoint in launchSettings.json.
HttpPortGenerated generated ``
HttpPortReplacer generated ``
HttpsPort parameter integer `` Port number to use for the HTTPS endpoint in launchSettings.json.
HttpsPortGenerated generated ``
HttpsPortReplacer generated ``
Docker parameter bool true Adds an optimised Dockerfile to add the ability to build a Docker image and docker related projects and resources.
RunSettingsFileName computed ``
UseLocalRedis computed ``
UseLocalMongoDb computed ``
AggregateRootName parameter string BaseAggregateRoot The name of the aggregate root entity.
AggregateRootObjectId parameter string ObjectId The name of the aggregate root object identifier (primary key).
FeatureAName parameter string FeatureA The name of the first feature.
FeatureADescription parameter string FeatureADescription The description of the first feature.
GenerateFeatureA computed ``
FeatureAUseCaseAName parameter string FeatureAUseCaseA The name of the use case A in the feature A.
GenerateFeatureAUseCaseA computed ``
FeatureAUseCaseADescription parameter string FeatureAUseCaseA's description The description of the use case A in the feature A.
FeatureAUseCaseBName parameter string FeatureAUseCaseB The name of the use case B in the feature A.
GenerateFeatureAUseCaseB computed ``
FeatureAUseCaseBDescription parameter string FeatureAUseCaseB's description The description of the use case B in the feature A.
FeatureBName parameter string FeatureB The name of the second feature.
FeatureBDescription parameter string FeatureBDescription The description of the second feature.
GenerateFeatureB computed ``
FeatureBUseCaseAName parameter string FeatureBUseCaseA The name of the use case A in the feature B.
GenerateFeatureBUseCaseA computed ``
FeatureBUseCaseADescription parameter string FeatureBUseCaseA's description The description of the use case A in the feature B.
FeatureBUseCaseBName parameter string FeatureBUseCaseB The name of the use case B in the feature B.
GenerateFeatureBUseCaseB computed ``
FeatureBUseCaseBDescription parameter string FeatureBUseCaseB's description The description of the use case B in the feature B.
Logging parameter choice Serilog Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count The logging framework to use.
Serilog computed ``
Log4Net computed ``
UseApplicationInsights parameter bool false Monitor internal information about how your application is running, as well as external user information using the Microsoft Azure cloud.
OpenTelemetry parameter bool true Instrument, generate, collect, and export telemetry data (metrics, logs, and traces) using the Open Telemetry standard. When enabled, you can choose between OtelCollector (recommended) or DirectExport mode.
ObservabilityStack parameter choice OtelCollector Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select the observability stack architecture. Only applicable when OpenTelemetry is enabled.
ObservabilityBackend parameter choice PrometheusGrafana Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select observability backend(s) to use. Only applicable when ObservabilityStack is OtelCollector.
UseOtelCollector computed ``
UseDirectExport computed ``
UseElkStack computed ``
UsePrometheusGrafana computed ``
UseSeqBackend computed ``
UseAzureMonitorBackend computed ``
UseApplicationInsightsBackend computed ``
UseJaegerBackend computed ``
ResourceMonitoring parameter bool true Resource monitoring involves the continuous measurement of resource utilization over a specified period.
HealthCheck parameter bool true Enables the use of healthchecks.
HealthCheckPath parameter string /health HealthCheck path. Only necessary if HealthCheck is enabled.
HealthCheckPublisher parameter choice Seq Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you health checks publisher type. HealthChecks include a push model to send HealthCheckReport results into configured consumers.
UseSeqAsHealthChecksPublisher computed ``
UseApplicationInsightsAsHealthChecksPublisher computed ``
HealthCheckUI parameter bool true Enables the use of healthchecks ui.
HealthCheckUIPath parameter string health-ui HealthCheck UI path. Only necessary if HealthCheck and HealthCheckUI is enabled.
HealthCheckUIStorageProvider parameter choice InMemory Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you health checks UI storage provider.
UseInMemoryHealthCheckUIStorageProvider computed ``
UseSqlServerHealthCheckUIStorageProvider computed ``
DistributedCache parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Adds distributed caching.
DistributedCacheRedis computed ``
DistributedCacheInMemory computed ``
DistributedCacheNone computed ``
Redis computed ``
FeatureFlags parameter bool true The Microsoft.FeatureManagement library enables developers to use feature flags and dynamic features inside of their applications. Feature flags can be used to turn features on or off dynamically.
FeatureFlagsProvider parameter choice AppSettings Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count The feature flags provider to use.
UseAzureAppConfigurationAsFeatureFlagsProvider computed ``
AdditionalConfigurationProvider parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Configuration providers read configuration data from key-value pairs using various built in configuration sources such appsettings, environment variables, command line. This options provide additional custom providers.
UseAzureAppConfigurationAsAdditionalConfigurationProvider computed ``
AdditionalConfigurationProviderNone computed ``
UseAuditNet parameter bool true Use Audit.Net framework for audit trail implementation.
PersistenceModelType parameter choice NHibernate Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you persistence model type.
UseNHibernate computed ``
UseMongoDb computed ``
UseDapper computed ``
PersistenceModelTypeNone computed ``
NHibernateDialectType parameter choice SqlServer Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you NHibernate dialect.
UseSqlServerNHibernateDialect computed ``
UsePostgreSQLNHibernateDialect computed ``
UseMySqlNHibernateDialect computed ``
DapperDialectType parameter choice SqlServer Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your Dapper ADO.NET provider / dialect.
UseSqlServerDapperDialect computed ``
UsePostgreSQLDapperDialect computed ``
UseMySqlDapperDialect computed ``
DapperPostgreSqlProviderReplace generated ``
DapperPostgreSqlConnectionStringKeyReplace generated ``
DapperMySqlProviderReplace generated ``
DapperMySqlConnectionStringKeyReplace generated ``
NHibernateSecondLevelCacheType parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you nhibernate second level cache.
UseRedisAsNHibernateSecondLevelCache computed ``
DatabaseName parameter string MicroserviceDatabase The database name used in connection string (when NHibernate used) or MongoDb database name (when MongoDb selected).
Migrations parameter bool true Enable database migrations - a structured way to alter database schema and manage migrations in version control system.
UseMigrations computed ``
ActorModelType parameter choice Orleans Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you actor model type.
UseOrleans computed ``
UseDapr computed ``
UseAkka computed ``
ActorModelTypeNone computed ``
OrleansGrainPersistence parameter choice AdoNet Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select Orleans grain persistence provider type.
UseOrleansAdoNetGrainPersistence computed ``
UseOrleansAzureBlobStorageGrainPersistence computed ``
ActorAName parameter string BankAccountActor The name of the first actor.
ActorADescription parameter string Bank account actor The description of the first actor.
ActorAOperationAName parameter string Withdraw The name of the operation A in the actor A.
ActorAOperationADescription parameter string Withdraw the given amount from the bank account The description of the operation A in the actor A.
ServiceModelType parameter choice Grpc Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select you service model type.
UseGrpc computed ``
UseGrpcHosting computed ``
UseRestApi computed ``
UseGraphQL computed ``
UseCoreWCF computed ``
UseServiceFabric computed ``
UseSignalR computed ``
UseAzureFunction computed ``
ServiceModelTypeNone computed ``
SignalRBackplane parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select SignalR backplane (scale-out transport).
UseSignalRBackplaneRedis computed ``
UseRedisSignalRBackplane computed ``
UseNoneSignalRBackplane computed ``
CORS parameter bool true Browser security prevents a web page from making AJAX requests to another domain.
Swagger parameter bool true Swagger is a format for describing the endpoints in your API and letting you try out your site using its user interface.
Scalar parameter bool true Scalar is an open-source, offline-first platform for building interactive API documentation and clients from OpenAPI specs, with support for testing, theming, and framework integrations.
RateLimiting parameter bool true Enable ASP.NET Core middleware for enforcing rate limiting in an application.
RequestTimeout parameter bool true Enable ASP.NET Core middleware for enforcing request timeout limits in an application.
Compression parameter bool true Enable ASP.NET Core response compression middleware to compress HTTP responses, reducing bandwidth usage and improving performance.
UseIdentityPlatform parameter bool true Enable ConnectSoft Identity Platform integration for normalized identity context, trusted gateway headers, tenant-required requests, and shared identity transport constants.
MessagingModelType parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your messaging and flow model type.
UseNServiceBus computed ``
UseMassTransit computed ``
MessagingModelTypeNone computed ``
NServiceBusEndpointName parameter string SampleEndpoint NServiceBus endpoint name. Only necessary if NServiceBus is selected.
NServiceBusPersistence parameter choice SQL Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your NServicebus persistence. Only necessary if NServiceBus is selected.
UseNServiceBusSQLPersistence computed ``
UseNServiceBusMongoDBPersistence computed ``
UseNServiceBusCosmosDBPersistence computed ``
NServiceBusTransport parameter choice SqlServer Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your NServicebus transport. Only necessary if NServiceBus is selected.
UseNServiceBusSqlServerTransport computed ``
UseNServiceBusRabbitMQTransport computed ``
NServiceBusDatabaseName parameter string NserviceBusMicroserviceDatabase The nservicebus transport or/and persistence database name used in connection strings.
MassTransitPersistence parameter choice NHibernate Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your MassTransit persistence. Only necessary if MassTransit is selected.
UseMassTransitNHibernatePersistence computed ``
UseMassTransitMongoDBPersistence computed ``
UseMassTransitCosmosDBPersistence computed ``
UseMassTransitDapperPersistence computed ``
MassTransitTransport parameter choice RabbitMQ Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your MassTransit transport. Only necessary if MassTransit is selected.
UseMassTransitSqlServerTransport computed ``
UseMassTransitRabbitMQTransport computed ``
UseMassTransitAzureServiceBusTransport computed ``
SchedulerModelType parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select your scheduler model type.
UseHangFire computed ``
UseQuartz computed ``
SchedulerModelTypeNone computed ``
EnableMicrosoftExtensionsAI parameter bool true Enable Microsoft.Extensions.AI abstraction for AI-related features.
EnableMicrosoftExtensionsAIEvaluation parameter bool false Enable Microsoft.Extensions.AI.Evaluation for AI output quality assessment (NLP, Quality, Safety).
UseMicrosoftExtensionsAI computed ``
UseMicrosoftExtensionsAIEvaluation computed ``
UseOpenAI computed ``
UseOllama computed ``
UseAzureOpenAI computed ``
UseMicrosoftAgentFrameworkOpenAI computed ``
UseMicrosoftAgentFrameworkAzureAI computed ``
MicrosoftExtensionsAIServiceProvider parameter choice OpenAI Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select the AI service provider to use
UseMicrosoftExtensionsAIOpenAIProvider computed ``
UseMicrosoftExtensionsAIAzureOpenAIProvider computed ``
UseMicrosoftExtensionsAIAzureAIInferenceProvider computed ``
UseMicrosoftExtensionsAIOllamaProvider computed ``
MicrosoftExtensionsAIEmbeddingProvider parameter choice None Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select the embedding generator provider(s) to use for vector operations
UseMicrosoftExtensionsAIOpenAIEmbeddingProvider computed ``
UseMicrosoftExtensionsAIAzureOpenAIEmbeddingProvider computed ``
UseMicrosoftExtensionsAIAzureAIInferenceEmbeddingProvider computed ``
UseMicrosoftExtensionsAIOllamaEmbeddingProvider computed ``
UseMicrosoftExtensionsAIEmbedding computed ``
UseVectorStore parameter bool false Enable vector store support for semantic search and RAG capabilities
VectorStoreProviderType parameter choice InMemory Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Select the vector store provider type
UseVectorStoreInMemory computed ``
UseVectorStoreAzureAISearch computed ``
UseVectorStoreSqlServer computed ``
UseVectorStorePgVector computed ``
UseVectorStoreQdrant computed ``
UseMCP parameter bool false Enable Model Context Protocol (MCP) support.
UseMicrosoftAgentFramework parameter bool true Adds Microsoft Agent Framework SDK that provides a unified framework for building AI agents and multi-agent workflows with support for OpenAI, Azure OpenAI, and other AI providers.
EnableMicrosoftAgentFrameworkWorkflows parameter bool false Include Microsoft Agent Framework Workflows packages (Microsoft.Agents.AI.Workflows) when Agent Framework is enabled.
UseMicrosoftAgentFrameworkWorkflows computed ``
EnableSemanticKernelAzureAISearchConnector parameter bool false Include Semantic Kernel Azure AI Search connector package (in addition to selecting Azure AI Search as the vector store provider).
EnableSemanticKernelSqlServerConnector parameter bool false Include Semantic Kernel SQL Server connector package (in addition to selecting SQL Server as the vector store provider).
UseSemanticKernelAzureAISearchConnector computed ``
UseSemanticKernelSqlServerConnector computed ``
EnableVectorIngestion parameter bool false Enable vector data ingestion pipeline for chunking, embedding, and indexing content.
UseVectorIngestion computed ``
IngestionChunkerType parameter choice Token Length, LongLength, Rank, SyncRoot, IsReadOnly, IsFixedSize, IsSynchronized, Count Default chunking strategy for vector data ingestion
UseVectorIngestionHost parameter bool false Enable background hosted service for vector data ingestion.
UseVectorIngestionTokenChunker computed ``
UseVectorIngestionMarkdownChunker computed ``
UseVectorIngestionParagraphChunker computed ``
UseAgentFrameworkRag parameter bool false Enable Agent Framework RAG (TextSearchProvider) demo wiring for the ProductManager agent and IRetrievalService adapter.
UseAgentSkills parameter bool false Include sample Agent Skills (SKILL.md) and AgentSkills configuration.

Validation

Regenerate this page from the current manifest whenever template symbols, defaults, choices, source modifiers, or short names change.

See Also