Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Home
PowerShell
Tutorials
Introduction
Hello World
Routes
Multiple Content Types
Multi-language Routes (PS/C#/VB)
Route Parameters & Request Data
Route Options (MapRouteOptions)
Route Groups
Static Routes
Serving Static Files
File Server & Directory Browsing
Static Route Overrides
Adding a Favicon
Shared Variable
Using Shared Variables
Logging
Certificates
Endpoints
Authentication
Middleware
Scheduler
Razor
OpenApi
PowerShell Cmdlets
Add-KrAntiforgery
Add-KrApiKeyAuthentication
Add-KrBasicAuthentication
Add-KrClaimPolicy
Add-KrCookiesAuthentication
Add-KrCorsPolicy
Add-KrEnrichFromLogContext
Add-KrEnrichWithEnvironment
Add-KrEnrichWithErrorRecord
Add-KrEnrichWithExceptionDetail
Add-KrEnrichWithProcessId
Add-KrEnrichWithProcessName
Add-KrEnrichWithProperty
Add-KrFavicon
Add-KrFileServer
Add-KrHtmlTemplateRoute
Add-KrJWTAudience
Add-KrJWTBearerAuthentication
Add-KrJWTClaim
Add-KrJWTHeader
Add-KrJWTIssuer
Add-KrJWTSubject
Add-KrListener
Add-KrMapRoute
Add-KrPowerShellRazorPagesRuntime
Add-KrPowerShellRuntime
Add-KrRazorPageService
Add-KrResponseCompression
Add-KrRouteGroup
Add-KrScheduling
Add-KrScriptBlock
Add-KrSignalRHub
Add-KrSinkConsole
Add-KrSinkEventLog
Add-KrSinkFile
Add-KrSinkHttp
Add-KrSinkPowerShell
Add-KrSinkSyslogLocal
Add-KrSinkSyslogTcp
Add-KrSinkSyslogUdp
Add-KrStaticFilesService
Add-KrStaticMapOverride
Add-KrUserClaim
Add-KrWindowsAuthentication
Build-KrClaimPolicy
Build-KrJWT
Close-KrLogger
Copy-KrJWTTokenBuilder
Enable-KrConfiguration
Expand-KrObject
Export-KrCertificate
Get-KrCertificatePurpose
Get-KrDefaultLogger
Get-KrJsonFormatter
Get-KrJWTInfo
Get-KrJWTToken
Get-KrJWTValidationParameter
Get-KrRequestBody
Get-KrRequestCookie
Get-KrRequestForm
Get-KrRequestHeader
Get-KrRequestQuery
Get-KrRequestRouteParam
Get-KrRoot
Get-KrScheduleReport
Get-KrScheduleSnapshot
Get-KrSharedState
Import-KsCertificate
Initialize-KrRoot
Limit-KrJWTNotBefore
Limit-KrJWTValidity
New-KrClaimPolicy
New-KrJWTBuilder
New-KrLevelSwitch
New-KrLogger
New-KrMapRouteOption
New-KrSelfSignedCertificate
New-KrServer
New-KsCertificateRequest
Protect-KrJWT
Protect-KrJWTPayload
Register-KrLogger
Register-KrSchedule
Remove-KrServer
Resolve-KrPath
Resume-KrSchedule
Set-KrDefaultLogger
Set-KrLevelSwitch
Set-KrMinimumLevel
Set-KrPythonRuntime
Set-KrServerLimit
Set-KrServerOption
Set-KrSharedState
Start-KrServer
Stop-KrServer
Suspend-KrSchedule
Test-KrJWT
Test-KrRoute
Test-KsCertificate
Update-KrJWT
Write-KrBinaryResponse
Write-KrBsonResponse
Write-KrCborResponse
Write-KrCsvResponse
Write-KrDebugLog
Write-KrErrorLog
Write-KrErrorResponse
Write-KrFatalLog
Write-KrFileResponse
Write-KrHtmlResponse
Write-KrInformationLog
Write-KrJsonResponse
Write-KrLog
Write-KrRedirectResponse
Write-KrResponse
Write-KrStreamResponse
Write-KrTextResponse
Write-KrVerboseLog
Write-KrWarningLog
Write-KrXmlResponse
Write-KrYamlResponse
C#
C# API
Global namespace
KestrunApiContext enumeration
KestrunRuntimeApiAttribute class
KestrunRuntimeApiAttribute constructor
KestrunRuntimeApiAttribute.Contexts property
KestrunRuntimeApiAttribute.Notes property
KestrunRuntimeApiAttribute.SafeForUntrusted property
Kestrun
FixedTimeEquals class
FixedTimeEquals.Test method (1 of 7)
KestrunHostManager class
KestrunHostManager.Contains method
KestrunHostManager.Create method (1 of 3)
KestrunHostManager.Default property
KestrunHostManager.Destroy method
KestrunHostManager.DestroyAll method
KestrunHostManager.Get method
KestrunHostManager.InstanceNames property
KestrunHostManager.IsRunning method
KestrunHostManager.KestrunRoot property
KestrunHostManager.SetDefault method
KestrunHostManager.StartAsync method
KestrunHostManager.Stop method
KestrunHostManager.StopAllAsync method
KestrunHostManager.StopAsync method
KestrunHostManager.TryGet method
Kestrun.Authentication
ApiKeyAuthenticationOptions class
ApiKeyAuthenticationOptions constructor
ApiKeyAuthenticationOptions.AdditionalHeaderNames property
ApiKeyAuthenticationOptions.AllowQueryStringFallback property
ApiKeyAuthenticationOptions.ChallengeHeaderFormat property
ApiKeyAuthenticationOptions.ClaimPolicyConfig property
ApiKeyAuthenticationOptions.EmitChallengeHeader property
ApiKeyAuthenticationOptions.ExpectedKey property
ApiKeyAuthenticationOptions.ExpectedKeyBytes property
ApiKeyAuthenticationOptions.HeaderName property
ApiKeyAuthenticationOptions.IssueClaims property
ApiKeyAuthenticationOptions.IssueClaimsCodeSettings property
ApiKeyAuthenticationOptions.Logger property
ApiKeyAuthenticationOptions.RequireHttps property
ApiKeyAuthenticationOptions.ValidateCodeSettings property
ApiKeyAuthenticationOptions.ValidateKeyAsync property
ApiKeyAuthHandler class
ApiKeyAuthHandler constructor
ApiKeyAuthHandler.BuildCsValidator method
ApiKeyAuthHandler.BuildPsValidator method
ApiKeyAuthHandler.BuildVBNetValidator method
ApiKeyChallengeFormat enumeration
AuthenticationCodeSettings constructor
AuthenticationCodeSettings record
AuthenticationCodeSettings.Code property
AuthenticationCodeSettings.CSharpVersion property
AuthenticationCodeSettings.ExtraImports property
AuthenticationCodeSettings.ExtraRefs property
AuthenticationCodeSettings.Language property
AuthenticationCodeSettings.VisualBasicVersion property
BasicAuthenticationOptions class
BasicAuthenticationOptions constructor
BasicAuthenticationOptions.Base64Encoded property
BasicAuthenticationOptions.ClaimPolicyConfig property
BasicAuthenticationOptions.HeaderName property
BasicAuthenticationOptions.IssueClaims property
BasicAuthenticationOptions.IssueClaimsCodeSettings property
BasicAuthenticationOptions.Logger property
BasicAuthenticationOptions.Realm property
BasicAuthenticationOptions.RequireHttps property
BasicAuthenticationOptions.SeparatorRegex property
BasicAuthenticationOptions.SuppressWwwAuthenticate property
BasicAuthenticationOptions.ValidateCodeSettings property
BasicAuthenticationOptions.ValidateCredentialsAsync property
BasicAuthHandler class
BasicAuthHandler constructor
BasicAuthHandler.BuildCsValidator method
BasicAuthHandler.BuildPsValidator method
BasicAuthHandler.BuildVBNetValidator method
IAuthenticationCommonOptions interface
IAuthenticationCommonOptions.Logger property
IAuthenticationCommonOptions.ValidateCodeSettings property
IAuthHandler interface
IAuthHandler.BuildCsIssueClaims method
IAuthHandler.BuildPsIssueClaims method
IAuthHandler.BuildVBNetIssueClaims method
IAuthHandler.GetAuthenticationTicketAsync method
IAuthHandler.IssueClaimsPowerShellAsync method
IAuthHandler.ValidatePowerShellAsync method
IClaimsCommonOptions interface
IClaimsCommonOptions.ClaimPolicyConfig property
IClaimsCommonOptions.IssueClaims property
IClaimsCommonOptions.IssueClaimsCodeSettings property
JwtAuthenticationOptions class
JwtAuthenticationOptions constructor
JwtAuthenticationOptions.ClaimPolicy property
JwtAuthenticationOptions.ClaimPolicyConfig property
JwtAuthenticationOptions.IssueClaims property
JwtAuthenticationOptions.IssueClaimsCodeSettings property
JwtAuthenticationOptions.ValidationParameters property
Kestrun.Certificates
CertificateManager class
CertificateManager.CsrOptions constructor
CertificateManager.CsrOptions record
CertificateManager.CsrOptions.CommonName property
CertificateManager.CsrOptions.Country property
CertificateManager.CsrOptions.DnsNames property
CertificateManager.CsrOptions.KeyLength property
CertificateManager.CsrOptions.KeyType property
CertificateManager.CsrOptions.Org property
CertificateManager.CsrOptions.OrgUnit property
CertificateManager.Export method (1 of 2)
CertificateManager.ExportFormat enumeration
CertificateManager.GetPurposes method
CertificateManager.Import method (1 of 4)
CertificateManager.KeyType enumeration
CertificateManager.NewCertificateRequest method
CertificateManager.NewSelfSigned method
CertificateManager.SelfSignedOptions constructor
CertificateManager.SelfSignedOptions record
CertificateManager.SelfSignedOptions.DnsNames property
CertificateManager.SelfSignedOptions.Ephemeral property
CertificateManager.SelfSignedOptions.Exportable property
CertificateManager.SelfSignedOptions.KeyLength property
CertificateManager.SelfSignedOptions.KeyType property
CertificateManager.SelfSignedOptions.Purposes property
CertificateManager.SelfSignedOptions.ValidDays property
CertificateManager.Validate method
CsrResult constructor
CsrResult record
CsrResult.Pem property
CsrResult.PrivateKey property
Kestrun.Claims
ClaimPolicyBuilder class
ClaimPolicyBuilder constructor
ClaimPolicyBuilder.AddPolicy method (1 of 3)
ClaimPolicyBuilder.Build method
ClaimPolicyBuilder.Policies property
ClaimPolicyConfig class
ClaimPolicyConfig constructor
ClaimPolicyConfig.Policies property
ClaimPolicyExtensions class
ClaimPolicyExtensions.ToAuthzDelegate method
ClaimPolicyPostConfigurer class
ClaimPolicyPostConfigurer constructor
ClaimPolicyPostConfigurer.PostConfigure method
ClaimRule constructor (1 of 2)
ClaimRule record
ClaimRule.AllowedValues property
ClaimRule.ClaimType property
KestrunClaimExtensions class
KestrunClaimExtensions.ToClaimUri method
UserIdentityClaim enumeration
Kestrun.Hosting
KestrunContext constructor
KestrunContext record
KestrunContext.Ct property
KestrunContext.HasSession property
KestrunContext.HttpContext property
KestrunContext.Items property
KestrunContext.Request property
KestrunContext.Response property
KestrunContext.Session property
KestrunContext.TryGetSession method
KestrunContext.User property
KestrunHost class
KestrunHost constructor (1 of 2)
KestrunHost.AddControllers method
KestrunHost.AddFeature method
KestrunHost.AddPowerShellRuntime method
KestrunHost.AddScheduling method
KestrunHost.AddService method
KestrunHost.AddSignalR<T> method
KestrunHost.ApplicationName property
KestrunHost.Build method
KestrunHost.ConfigureListener method (1 of 3)
KestrunHost.CreateRunspacePool method
KestrunHost.Dispose method
KestrunHost.EnableConfiguration method
KestrunHost.HostLogger property
KestrunHost.IsConfigured property
KestrunHost.IsRunning property
KestrunHost.KestrunRoot property
KestrunHost.Options property
KestrunHost.RouteGroupStack property
KestrunHost.Run method
KestrunHost.Scheduler property
KestrunHost.StartAsync method
KestrunHost.Stop method
KestrunHost.StopAsync method
KestrunHost.Use method
KestrunHostAuthExtensions class
KestrunHostAuthExtensions.AddApiKeyAuthentication method (1 of 2)
KestrunHostAuthExtensions.AddAuthorization method
KestrunHostAuthExtensions.AddBasicAuthentication method (1 of 2)
KestrunHostAuthExtensions.AddCookieAuthentication method (1 of 2)
KestrunHostAuthExtensions.AddJwtBearerAuthentication method
KestrunHostAuthExtensions.AddOpenIdConnectAuthentication method
KestrunHostAuthExtensions.AddWindowsAuthentication method
KestrunHostAuthExtensions.HasAuthPolicy method
KestrunHostAuthExtensions.HasAuthScheme method
KestrunHostMapExtensions class
KestrunHostMapExtensions.AddHtmlTemplateRoute method (1 of 2)
KestrunHostMapExtensions.AddMapRoute method (1 of 6)
KestrunHostMapExtensions.AddStaticMapOverride method (1 of 4)
KestrunHostMapExtensions.GetMapRouteOptions method
KestrunHostMapExtensions.KestrunHandler delegate
KestrunHostMapExtensions.MapExists method (1 of 2)
KestrunHostRazorExtensions class
KestrunHostRazorExtensions.AddPowerShellRazorPages method (1 of 4)
KestrunHostRazorExtensions.AddRazorPages method (1 of 2)
KestrunHostScriptValidationExtensions class
KestrunHostScriptValidationExtensions.GetCSharpScriptErrors method
KestrunHostScriptValidationExtensions.IsCSharpScriptValid method
KestrunHostScriptValidationExtensions.ValidateCSharpScript method
KestrunHostStaticFilesExtensions class
KestrunHostStaticFilesExtensions.AddDefaultFiles method (1 of 2)
KestrunHostStaticFilesExtensions.AddDirectoryBrowser method
KestrunHostStaticFilesExtensions.AddFavicon method
KestrunHostStaticFilesExtensions.AddFileServer method (1 of 2)
KestrunHostStaticFilesExtensions.AddStaticFiles method (1 of 2)
KestrunHttpMiddlewareExtensions class
KestrunHttpMiddlewareExtensions.AddAntiforgery method (1 of 2)
KestrunHttpMiddlewareExtensions.AddCors method (1 of 2)
KestrunHttpMiddlewareExtensions.AddCorsAllowAll method
KestrunHttpMiddlewareExtensions.AddRateLimiter method (1 of 2)
KestrunHttpMiddlewareExtensions.AddResponseCompression method (1 of 2)
NoopHostLifetime class
NoopHostLifetime constructor
NoopHostLifetime.StopAsync method
NoopHostLifetime.WaitForStartAsync method
Kestrun.Hosting.Options
KestrelOptionsExtensions class
KestrelOptionsExtensions.CopyFromTemplate method
KestrunOptions class
KestrunOptions constructor
KestrunOptions.ApplicationName property
KestrunOptions.Listeners property
KestrunOptions.MaxRunspaces property
KestrunOptions.MaxSchedulerRunspaces property
KestrunOptions.MinRunspaces property
KestrunOptions.ServerLimits property
KestrunOptions.ServerOptions property
ListenerOptions class
ListenerOptions constructor
ListenerOptions.IPAddress property
ListenerOptions.Port property
ListenerOptions.Protocols property
ListenerOptions.UseConnectionLogging property
ListenerOptions.UseHttps property
ListenerOptions.X509Certificate property
MapRouteOptions constructor
MapRouteOptions record
MapRouteOptions.AllowAnonymous property
MapRouteOptions.Arguments property
MapRouteOptions.Code property
MapRouteOptions.CorsPolicyName property
MapRouteOptions.DisableAntiforgery property
MapRouteOptions.ExtraImports property
MapRouteOptions.ExtraRefs property
MapRouteOptions.HttpVerbs property
MapRouteOptions.Language property
MapRouteOptions.OpenAPI property
MapRouteOptions.OpenAPIMetadata constructor
MapRouteOptions.OpenAPIMetadata record
MapRouteOptions.OpenAPIMetadata.Description property
MapRouteOptions.OpenAPIMetadata.GroupName property
MapRouteOptions.OpenAPIMetadata.OperationId property
MapRouteOptions.OpenAPIMetadata.Summary property
MapRouteOptions.OpenAPIMetadata.Tags property
MapRouteOptions.Pattern property
MapRouteOptions.RateLimitPolicyName property
MapRouteOptions.RequirePolicies property
MapRouteOptions.RequireSchemes property
MapRouteOptions.ShortCircuit property
MapRouteOptions.ShortCircuitStatusCode property
MapRouteOptions.ThrowOnDuplicate property
Kestrun.Jwt
JwtAlgorithm enumeration
JwtAlgorithmExtensions class
JwtAlgorithmExtensions.ToJwtString method
JwtBuilderResult class
JwtBuilderResult constructor
JwtBuilderResult.Expires property
JwtBuilderResult.GetValidationParameters method
JwtBuilderResult.IssuedAt property
JwtBuilderResult.Token method
JwtBuilderResult.Validate method
JwtBuilderResult.ValidateAsync method
JwtInspector class
JwtInspector.ReadAllParameters method
JwtParameters class
JwtParameters constructor
JwtParameters.Algorithm property
JwtParameters.Audiences property
JwtParameters.Claims property
JwtParameters.Expires property
JwtParameters.Header property
JwtParameters.IssuedAt property
JwtParameters.Issuer property
JwtParameters.KeyId property
JwtParameters.NotBefore property
JwtParameters.Subject property
JwtParameters.Type property
JwtTokenBuilder class
JwtTokenBuilder constructor
JwtTokenBuilder.AddClaim method
JwtTokenBuilder.AddHeader method
JwtTokenBuilder.Algorithm property
JwtTokenBuilder.Audience property
JwtTokenBuilder.Build method
JwtTokenBuilder.CloneBuilder method
JwtTokenBuilder.EncryptWithCertificate method
JwtTokenBuilder.EncryptWithPemPublic method
JwtTokenBuilder.EncryptWithSecret method
JwtTokenBuilder.EncryptWithSecretB64 method
JwtTokenBuilder.EncryptWithSecretHex method
JwtTokenBuilder.Issuer property
JwtTokenBuilder.New method
JwtTokenBuilder.NotBefore method
JwtTokenBuilder.RenewJwt method (1 of 2)
JwtTokenBuilder.SignWithCertificate method
JwtTokenBuilder.SignWithRsaPem method
JwtTokenBuilder.SignWithSecret method
JwtTokenBuilder.SignWithSecretHex method
JwtTokenBuilder.SignWithSecretPassphrase method
JwtTokenBuilder.ValidFor method
JwtTokenBuilder.WithAudience method
JwtTokenBuilder.WithIssuer method
JwtTokenBuilder.WithSubject method
Kestrun.Languages
CsGlobals constructor (1 of 4)
CsGlobals record
CsGlobals.Context property
CsGlobals.Globals property
CsGlobals.Locals property
Kestrun.Logging
LoggerConfigurationExtensions class
LoggerConfigurationExtensions.Register method
LoggerExtensions class
LoggerExtensions.DebugSanitized method (1 of 2)
LoggerManager class
LoggerManager.Add method
LoggerManager.Clear method
LoggerManager.DefaultLogger property
LoggerManager.DefaultLoggerName property
LoggerManager.Get method
LoggerManager.List method
LoggerManager.New method
LoggerManager.Register method
LoggerManager.Remove method
Kestrun.Logging.Data
ErrorRecordWrapper class
ErrorRecordWrapper constructor
ErrorRecordWrapper.CategoryInfo property
ErrorRecordWrapper.ErrorDetails property
ErrorRecordWrapper.ExceptionDetails property
ErrorRecordWrapper.ExceptionMessage property
ErrorRecordWrapper.FullyQualifiedErrorId property
ErrorRecordWrapper.InvocationInfoWrapper property
ErrorRecordWrapper.PipelineIterationInfo property
ErrorRecordWrapper.ScriptStackTrace property
ErrorRecordWrapper.TargetObject property
ErrorRecordWrapper.ToString method
InvocationInfoWrapper class
InvocationInfoWrapper constructor
InvocationInfoWrapper.BoundParameters property
InvocationInfoWrapper.CommandOrigin property
InvocationInfoWrapper.DisplayScriptPosition property
InvocationInfoWrapper.ExpectingInput property
InvocationInfoWrapper.HistoryId property
InvocationInfoWrapper.InvocationName property
InvocationInfoWrapper.Line property
InvocationInfoWrapper.MyCommand property
InvocationInfoWrapper.OffsetInLine property
InvocationInfoWrapper.PipelineLength property
InvocationInfoWrapper.PipelinePosition property
InvocationInfoWrapper.PositionMessage property
InvocationInfoWrapper.PSCommandPath property
InvocationInfoWrapper.PSScriptRoot property
InvocationInfoWrapper.ScriptLineNumber property
InvocationInfoWrapper.ScriptName property
InvocationInfoWrapper.ToString method
InvocationInfoWrapper.UnboundArguments property
Kestrun.Logging.Enrichers
ErrorRecordEnricher class
ErrorRecordEnricher constructor (1 of 2)
ErrorRecordEnricher.DestructureObjects property
ErrorRecordEnricher.Enrich method
ErrorRecordEnricher.ERR_PROPERTY_NAME_FULL field
ErrorRecordEnricher.II_PROPERTY_NAME_FULL field
Kestrun.Logging.Enrichers.Extensions
ErrorRecordEnricherExtensions class
ErrorRecordEnricherExtensions.WithErrorRecord method
ErrorRecordExtensions class
ErrorRecordExtensions.ToTable method (1 of 2)
Kestrun.Logging.Exceptions
WrapperException class
WrapperException constructor (1 of 4)
WrapperException.ErrorRecordWrapper property
WrapperException.ToString method
Kestrun.Logging.Sinks
PowerShellSink class
PowerShellSink constructor
PowerShellSink.Callback property
PowerShellSink.DEFAULT_OUTPUT_TEMPLATE field
PowerShellSink.Emit method
PowerShellSink.TextFormatter property
Kestrun.Logging.Sinks.Extensions
PowerShellSinkExtensions class
PowerShellSinkExtensions.PowerShell method
Kestrun.Logging.Utils.Console
Padding class
Padding constructor (1 of 2)
Padding.Left property
Padding.LeftString method
Padding.Right property
Padding.RightString method
Table class
Table constructor (1 of 2)
Table.AddRow method
Table.BOTTOM_JOINT field
Table.BOTTOM_LEFT_JOINT field
Table.BOTTOM_RIGHT_JOINT field
Table.HeaderSet property
Table.HORIZONTAL_LINE field
Table.LEFT_JOINT field
Table.MIDDLE_JOINT field
Table.Padding property
Table.Render method
Table.RenderWithoutGrid method
Table.RIGHT_JOINT field
Table.SetHeader method
Table.TOP_JOINT field
Table.TOP_LEFT_JOINT field
Table.TOP_RIGHT_JOINT field
Table.ToString method
Table.VERTICAL_LINE field
Kestrun.Logging.Utils.Console.Extensions
TableExtensions class
TableExtensions.AddPropertyRow method
Kestrun.Middleware
FaviconMiddlewareExtensions class
FaviconMiddlewareExtensions.UseFavicon method
PowerShellRunspaceMiddleware class
PowerShellRunspaceMiddleware constructor
PowerShellRunspaceMiddleware.InvokeAsync method
PowerShellRunspaceMiddlewareExtensions class
PowerShellRunspaceMiddlewareExtensions.UsePowerShellRunspace method
Kestrun.Models
ContentDispositionOptions class
ContentDispositionOptions constructor
ContentDispositionOptions.FileName property
ContentDispositionOptions.ToString method
ContentDispositionOptions.Type property
ContentDispositionType enumeration
KestrunRequest class
KestrunRequest.Authorization property
KestrunRequest.Body property
KestrunRequest.ContentLength property
KestrunRequest.ContentType property
KestrunRequest.Cookies property
KestrunRequest.Form property
KestrunRequest.HasFormContentType property
KestrunRequest.Headers property
KestrunRequest.Host property
KestrunRequest.IsHttps property
KestrunRequest.Method property
KestrunRequest.NewRequest method
KestrunRequest.NewRequestSync method
KestrunRequest.Path property
KestrunRequest.PathBase property
KestrunRequest.Protocol property
KestrunRequest.Query property
KestrunRequest.QueryString property
KestrunRequest.RouteValues property
KestrunRequest.Scheme property
KestrunResponse class
KestrunResponse constructor
KestrunResponse.AcceptCharset property
KestrunResponse.ApplyTo method
KestrunResponse.Body property
KestrunResponse.BodyAsyncThreshold property
KestrunResponse.ContentDisposition property
KestrunResponse.ContentType property
KestrunResponse.Cookies property
KestrunResponse.Encoding property
KestrunResponse.GetHeader method
KestrunResponse.Headers property
KestrunResponse.IsTextBasedContentType method
KestrunResponse.RedirectUrl property
KestrunResponse.Request property
KestrunResponse.StatusCode property
KestrunResponse.TextBasedMimeTypes field
KestrunResponse.WriteBinaryResponse method
KestrunResponse.WriteBsonResponse method
KestrunResponse.WriteBsonResponseAsync method
KestrunResponse.WriteCborResponse method
KestrunResponse.WriteCborResponseAsync method
KestrunResponse.WriteCsvResponse method
KestrunResponse.WriteCsvResponseAsync method
KestrunResponse.WriteErrorResponse method (1 of 2)
KestrunResponse.WriteErrorResponseAsync method (1 of 2)
KestrunResponse.WriteFileResponse method
KestrunResponse.WriteHtmlResponse method
KestrunResponse.WriteHtmlResponseAsync method
KestrunResponse.WriteHtmlResponseFromFile method
KestrunResponse.WriteHtmlResponseFromFileAsync method
KestrunResponse.WriteJsonResponse method (1 of 3)
KestrunResponse.WriteJsonResponseAsync method (1 of 3)
KestrunResponse.WriteRedirectResponse method
KestrunResponse.WriteResponse method
KestrunResponse.WriteResponseAsync method
KestrunResponse.WriteStreamResponse method
KestrunResponse.WriteTextResponse method
KestrunResponse.WriteTextResponseAsync method
KestrunResponse.WriteXmlResponse method
KestrunResponse.WriteXmlResponseAsync method
KestrunResponse.WriteYamlResponse method
KestrunResponse.WriteYamlResponseAsync method
Kestrun.Razor
PowerShellRazorPage class
PowerShellRazorPage.UsePowerShellRazorPages method
PwshKestrunModel class
PwshKestrunModel constructor
PwshKestrunModel.Config property
PwshKestrunModel.Data property
PwshKestrunModel.Query method
Kestrun.Scheduling
JobInfo constructor
JobInfo record
JobInfo.IsCompleted property
JobInfo.IsSuspended property
JobInfo.LastRunAt property
JobInfo.Name property
JobInfo.NextRunAt property
ScheduleReport constructor
ScheduleReport record
ScheduleReport.GeneratedAt property
ScheduleReport.Jobs property
SchedulerService class
SchedulerService constructor
SchedulerService.Cancel method
SchedulerService.CancelAll method
SchedulerService.CancelAsync method
SchedulerService.Dispose method
SchedulerService.GetReport method
SchedulerService.GetReportHashtable method
SchedulerService.GetSnapshot method (1 of 2)
SchedulerService.Pause method
SchedulerService.Resume method
SchedulerService.Schedule method (1 of 8)
SchedulerService.ScheduleAsync method (1 of 2)
Kestrun.Scripting
CompilationErrorException class
CompilationErrorException constructor (1 of 2)
CompilationErrorException.Diagnostics property
CompilationErrorException.GetDetailedErrorMessage method
CompilationErrorException.GetErrors method
CompilationErrorException.GetWarnings method
EndpointConventionBuilderLanguageExtensions class
EndpointConventionBuilderLanguageExtensions.WithLanguage<TBuilder> method
KestrunRunspacePoolManager class
KestrunRunspacePoolManager constructor
KestrunRunspacePoolManager.Acquire method
KestrunRunspacePoolManager.AcquireAsync method
KestrunRunspacePoolManager.Dispose method
KestrunRunspacePoolManager.MaxRunspaces property
KestrunRunspacePoolManager.MinRunspaces property
KestrunRunspacePoolManager.Release method
KestrunRunspacePoolManager.ThreadOptions property
LanguageRuntimeExtensions class
LanguageRuntimeExtensions.UseLanguageRuntime method
RouteHandlerBuilderLanguageExtensions class
RouteHandlerBuilderLanguageExtensions.WithLanguage method
ScriptLanguage enumeration
ScriptLanguageAttribute class
ScriptLanguageAttribute constructor
ScriptLanguageAttribute.Language property
Kestrun.SharedState
SharedStateStore class
SharedStateStore.Get method
SharedStateStore.KeySnapshot method
SharedStateStore.Set method
SharedStateStore.Snapshot method
SharedStateStore.TryGet<T> method
Kestrun.Utilities
AssemblyAutoLoader class
AssemblyAutoLoader.Clear method
AssemblyAutoLoader.PreloadAll method
BuildError class
BuildError.ResponseAsync method
BuildError.Result method
BuildError.Text method
CcUtilities class
CcUtilities.GetLineNumber method
CcUtilities.PreviewFeaturesEnabled method
HostingExtensions class
HostingExtensions.RunUntilShutdownAsync method
HttpVerb enumeration
HttpVerbExtensions class
HttpVerbExtensions.FromMethodString method
HttpVerbExtensions.ToMethodString method
HttpVerbExtensions.TryFromMethodString method
PowerShellModuleLocator class
PowerShellModuleLocator.LocateKestrunModule method
RateLimiterOptionsExtensions class
RateLimiterOptionsExtensions.CopyFrom method
ReadOnlyDictionaryAdapter class
ReadOnlyDictionaryAdapter constructor
ReadOnlyDictionaryAdapter indexer
ReadOnlyDictionaryAdapter.ContainsKey method
ReadOnlyDictionaryAdapter.Count property
ReadOnlyDictionaryAdapter.GetEnumerator method
ReadOnlyDictionaryAdapter.Keys property
ReadOnlyDictionaryAdapter.TryGetValue method
ReadOnlyDictionaryAdapter.Values property
SecureStringUtils class
SecureStringUtils.SpanHandler delegate
SecureStringUtils.ToSecureSpan method
SecureStringUtils.ToSecureString method
VariablesMap class
VariablesMap.GetCommonProperties method
VariablesMap.GetSharedStateStore method
VariablesMap.GetVariablesMap method
XmlHelper class
XmlHelper.ToHashtable method
XmlHelper.ToXml method
YamlHelper class
YamlHelper.ToHashtable method
YamlHelper.ToPSCustomObject method
YamlHelper.ToYaml method
Contributing
Build & Environment
Testing
Style & Quality
Git Workflow
Troubleshooting
Logging & Console Output
Kestrun on GitHub
Repository
C#
C# API
Kestrun.Hosting.Options
ListenerOptions.UseHttps property
ListenerOptions.UseHttps property
Whether HTTPS should be used.
public
bool
UseHttps
{
get
;
set
;
}
See Also
class
ListenerOptions
namespace
Kestrun.Hosting.Options