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
File Server Caching Headers
Response Caching & Conditional Requests
Shared Variable
Using Shared Variables
Managing Shared State
Logging
Simple Logging
Multiple Loggers & Levels
Enrichment & Correlation IDs
Sinks (Console/File/JSON)
Sinks (HTTP/EventLog/Syslog)
Hot Reload (Update Logger)
Apache Common Access Log
Certificates
Create a Self‑Signed Certificate
Generate a CSR (Certificate Signing Request)
Import, Export, Validate & EKU
Endpoints
Basic Server
Multiple Listeners
HTTPS & Certificates
Named Pipes (Windows)
Unix Sockets
Mixed HTTP Protocols
URI Endpoint
Authentication
Basic (PowerShell)
Basic (C# / VB.NET)
API Key
JWT Tokens
Cookies
Windows Authentication
Claims & Policies
Client Certificate
OpenID Connect (Okta)
Multiple Schemes
GitHub Authentication
Full Demo
OpenID Connect (Duende Demo)
Full Demo
Responses
Text & JSON
Structured (XML / YAML / CSV)
Binary & Stream
HTML Templates & Files
Special Formats (BSON / CBOR)
Redirects
Errors
Caching & Revalidation
Content Negotiation
Low-Level Response Stream
OpenApi
Hello World
Component Schemas
RequestBody Components
Parameter Components
Response Components
Complete Components
Tags and External Docs
Document Information
Scheduler
Scheduling Quickstart
Scheduling with CRON
Scheduling Report
Razor
Razor Pages Quickstart
Razor Pages with Antiforgery
Pages
Index
About
Status
Quotes
Contact
AppInfo
Cancel
Shared Layout
ViewStart
ViewImports
Server Configuration
Server Limits
Server Options
Lifecycle
Start/Stop Patterns
Middleware
Antiforgery Protection
Response Compression
HTTPS Redirection
SignalR
Host Filtering
Forwarded Headers
CORS
Health
Health Quickstart
Script Probe
HTTP Probe
Process Probe
C# Inline Probe
Disk Probe
Health Response Format
Status Code Pages
Default Status Code Pages
Custom Options
Custom Handler (PowerShell)
Custom Handler (C# Inline)
Content Format
Redirects
Re-execute
Exception Handling
Exception Handling Path
VB.NET Handler
C# Inline Handler
ProblemDetails Fallback
Developer Exception Page
Sessions
Basic Sessions
Sessions with Redis
Sessions with SQL Server
Tasks
Basic Tasks
PowerShell Cmdlets
Add-KrAntiforgeryMiddleware
Add-KrAntiforgeryTokenRoute
Add-KrApiDocumentationRoute
Add-KrApiKeyAuthentication
Add-KrBasicAuthentication
Add-KrCacheMiddleware
Add-KrCacheResponse
Add-KrClaimPolicy
Add-KrCommonAccessLogMiddleware
Add-KrCompressionMiddleware
Add-KrCookiesAuthentication
Add-KrCorsPolicy
Add-KrDistributedRedisCache
Add-KrDistributedSqlServerCache
Add-KrEndpoint
Add-KrEnrichEnvironment
Add-KrEnrichErrorRecord
Add-KrEnrichExceptionDetail
Add-KrEnrichFromLogContext
Add-KrEnrichProcessId
Add-KrEnrichProcessName
Add-KrEnrichProperty
Add-KrFaviconMiddleware
Add-KrFileServerMiddleware
Add-KrForwardedHeader
Add-KrGitHubAuthentication
Add-KrHealthEndpoint
Add-KrHealthHttpProbe
Add-KrHealthProbe
Add-KrHealthProcessProbe
Add-KrHostFiltering
Add-KrHsts
Add-KrHtmlTemplateRoute
Add-KrHttpsRedirection
Add-KrJWTAudience
Add-KrJWTBearerAuthentication
Add-KrJWTClaim
Add-KrJWTHeader
Add-KrJWTIssuer
Add-KrJWTSubject
Add-KrListenUnixSocket
Add-KrMapRoute
Add-KrNamedPipeListener
Add-KrOAuth2Authentication
Add-KrOpenApiContact
Add-KrOpenApiExternalDoc
Add-KrOpenApiInfo
Add-KrOpenApiLicense
Add-KrOpenApiRoute
Add-KrOpenApiServer
Add-KrOpenApiTag
Add-KrOpenIdConnectAuthentication
Add-KrPowerShellRazorPagesRuntime
Add-KrRazorPageService
Add-KrRouteGroup
Add-KrScheduling
Add-KrScriptBlock
Add-KrSession
Add-KrSignalRHubMiddleware
Add-KrSinkConsole
Add-KrSinkEventLog
Add-KrSinkFile
Add-KrSinkHttp
Add-KrSinkPowerShell
Add-KrSinkSyslogLocal
Add-KrSinkSyslogTcp
Add-KrSinkSyslogUdp
Add-KrStaticFilesMiddleware
Add-KrTasksService
Add-KrUserClaim
Add-KrWindowsAuthentication
Build-KrClaimPolicy
Build-KrJWT
Build-KrOpenApiDocument
Clear-KrEnvironmentOverride
Clear-KrSession
Close-KrLogger
ConvertFrom-KrJwkJsonToCertificate
ConvertFrom-KrYaml
ConvertTo-KrBase64Url
ConvertTo-KrJwkJson
ConvertTo-KrYaml
Copy-KrJWTTokenBuilder
Enable-KrConfiguration
Enable-KrExceptionHandling
Enable-KrStatusCodePage
Expand-KrObject
Export-KrCertificate
Export-KrOpenApiDocument
Get-KrBuiltTargetFrameworkVersion
Get-KrCertificatePurpose
Get-KrDefaultLogger
Get-KrEnvironment
Get-KrFeatureSupport
Get-KrJwkThumbprint
Get-KrJWTInfo
Get-KrJWTToken
Get-KrJWTValidationParameter
Get-KrLoggerLevelSwitch
Get-KrOpenApiDocument
Get-KrRequestBody
Get-KrRequestCookie
Get-KrRequestForm
Get-KrRequestHeader
Get-KrRequestQuery
Get-KrRequestRouteParam
Get-KrRoot
Get-KrScheduleReport
Get-KrScheduleSnapshot
Get-KrServer
Get-KrSessionByte
Get-KrSessionInt32
Get-KrSessionString
Get-KrSharedState
Get-KrSignalRConnectedClient
Get-KrSinkJsonFormatter
Get-KrTask
Get-KrTaskResult
Get-KrTaskState
Get-KrVersion
Import-KrCertificate
Initialize-KrRoot
Invoke-KrChallenge
Invoke-KrCookieSignIn
Invoke-KrCookieSignOut
Invoke-KrWebRequest
Kestrun Module
Limit-KrJWTNotBefore
Limit-KrJWTValidity
New-KrCertificateRequest
New-KrClaimPolicy
New-KrCookieBuilder
New-KrCorsPolicyBuilder
New-KrJWTBuilder
New-KrLogger
New-KrMapRouteOption
New-KrOpenApiExternalDoc
New-KrOpenApiLink
New-KrOpenApiServer
New-KrOpenApiServerVariable
New-KrPrivateKeyJwt
New-KrProbeResult
New-KrSelfSignedCertificate
New-KrServer
New-KrTask
Protect-KrJWT
Protect-KrJWTPayload
Push-KrLogContextProperty
Register-KrLogger
Register-KrSchedule
Remove-KrServer
Remove-KrSession
Remove-KrSharedState
Remove-KrTask
Resolve-KrPath
Resume-KrSchedule
Send-KrSignalREvent
Send-KrSignalRGroupMessage
Send-KrSignalRLog
Set-KrCorsCredential
Set-KrCorsExposedHeader
Set-KrCorsHeader
Set-KrCorsMethod
Set-KrCorsOrigin
Set-KrCorsPreflightMaxAge
Set-KrDefaultLogger
Set-KrEnvironment
Set-KrLoggerLevel
Set-KrLoggerLevelSwitch
Set-KrPythonRuntime
Set-KrServerHttpsOptions
Set-KrServerLimit
Set-KrServerNamedPipeOptions
Set-KrServerOptions
Set-KrSessionByte
Set-KrSessionInt32
Set-KrSessionString
Set-KrSharedState
Set-KrTaskName
Start-KrServer
Start-KrTask
Stop-KrServer
Stop-KrTask
Suspend-KrSchedule
Test-KrCacheRevalidation
Test-KrCapability
Test-KrCertificate
Test-KrDebugContext
Test-KrJWT
Test-KrLogger
Test-KrOpenApiDocument
Test-KrRoute
Update-KrJWT
Update-KrSynchronizedCounter
Write-KrBinaryResponse
Write-KrBsonResponse
Write-KrCborResponse
Write-KrCsvResponse
Write-KrErrorResponse
Write-KrFileResponse
Write-KrFormUrlEncodedResponse
Write-KrHtmlResponse
Write-KrJsonResponse
Write-KrLog
Write-KrRedirectResponse
Write-KrResponse
Write-KrStatusResponse
Write-KrStreamResponse
Write-KrTextResponse
Write-KrXmlResponse
Write-KrYamlResponse
C#
C# API
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
KestrunRuntimeInfo class
KestrunRuntimeInfo.GetBuiltTargetFrameworkName method
KestrunRuntimeInfo.GetBuiltTargetFrameworkVersion method
KestrunRuntimeInfo.GetKnownFeatures method
KestrunRuntimeInfo.IsDebugBuild property
KestrunRuntimeInfo.IsReleaseDistribution property
KestrunRuntimeInfo.KnownFeature enumeration
KestrunRuntimeInfo.Supports method (1 of 2)
KestrunRuntimeInfo.TryGetMinVersion method
Kestrun.Authentication
ApiKeyAuthenticationOptions class
ApiKeyAuthenticationOptions constructor
ApiKeyAuthenticationOptions.AdditionalHeaderNames property
ApiKeyAuthenticationOptions.AllowInsecureHttp property
ApiKeyAuthenticationOptions.AllowQueryStringFallback property
ApiKeyAuthenticationOptions.ApiKeyName property
ApiKeyAuthenticationOptions.ApplyTo method
ApiKeyAuthenticationOptions.ChallengeHeaderFormat property
ApiKeyAuthenticationOptions.ClaimPolicyConfig property
ApiKeyAuthenticationOptions.Description property
ApiKeyAuthenticationOptions.DisplayName property
ApiKeyAuthenticationOptions.DocumentationId property
ApiKeyAuthenticationOptions.EmitChallengeHeader property
ApiKeyAuthenticationOptions.GlobalScheme property
ApiKeyAuthenticationOptions.Host property
ApiKeyAuthenticationOptions.In property
ApiKeyAuthenticationOptions.IssueClaims property
ApiKeyAuthenticationOptions.IssueClaimsCodeSettings property
ApiKeyAuthenticationOptions.Logger property
ApiKeyAuthenticationOptions.StaticApiKey property
ApiKeyAuthenticationOptions.StaticApiKeyAsBytes property
ApiKeyAuthenticationOptions.ValidateCodeSettings property
ApiKeyAuthenticationOptions.ValidateKeyAsync property
ApiKeyAuthHandler class
ApiKeyAuthHandler constructor
ApiKeyAuthHandler.BuildCsValidator method
ApiKeyAuthHandler.BuildPsValidator method
ApiKeyAuthHandler.BuildVBNetValidator method
ApiKeyAuthHandler.Host property
ApiKeyChallengeFormat enumeration
AssertionService class
AssertionService constructor
AssertionService.ClientId property
AssertionService.CreateClientAssertion method
AuthenticationCodeSettings constructor
AuthenticationCodeSettings record
AuthenticationCodeSettings.Code property
AuthenticationCodeSettings.CSharpVersion property
AuthenticationCodeSettings.ExtraImports property
AuthenticationCodeSettings.ExtraRefs property
AuthenticationCodeSettings.Language property
AuthenticationCodeSettings.VisualBasicVersion property
AuthenticationDefaults class
AuthenticationDefaults.ApiKeyDisplayName field
AuthenticationDefaults.ApiKeySchemeName field
AuthenticationDefaults.BasicDisplayName field
AuthenticationDefaults.BasicSchemeName field
AuthenticationDefaults.BearerDisplayName field
AuthenticationDefaults.BearerSchemeName field
AuthenticationDefaults.CookiesDisplayName field
AuthenticationDefaults.CookiesSchemeName field
AuthenticationDefaults.DigestDisplayName field
AuthenticationDefaults.DigestSchemeName field
AuthenticationDefaults.GitHubDisplayName field
AuthenticationDefaults.GitHubSchemeName field
AuthenticationDefaults.JwtBearerDisplayName field
AuthenticationDefaults.JwtBearerSchemeName field
AuthenticationDefaults.NtLmDisplayName field
AuthenticationDefaults.NtLmSchemeName field
AuthenticationDefaults.OAuth2DisplayName field
AuthenticationDefaults.OAuth2SchemeName field
AuthenticationDefaults.OidcDisplayName field
AuthenticationDefaults.OidcSchemeName field
AuthenticationDefaults.WindowsDisplayName field
AuthenticationDefaults.WindowsSchemeName field
AuthenticationRegistry class
AuthenticationRegistry constructor
AuthenticationRegistry.Clear method
AuthenticationRegistry.Exists method
AuthenticationRegistry.Get method (1 of 2)
AuthenticationRegistry.GetClaimPolicyConfigs method
AuthenticationRegistry.GetOidcOptions method
AuthenticationRegistry.GetSchemesByPolicy method
AuthenticationRegistry.Items method
AuthenticationRegistry.Register method (1 of 2)
AuthenticationRegistry.Remove method
AuthenticationRegistry.ResolveAuthenticationSchemeName method
AuthenticationRegistry.TryGet method (1 of 2)
AuthenticationRegistry.Upsert method (1 of 2)
AuthenticationType enumeration
AuthOptionsHelper class
AuthOptionsHelper.GetAuthOptions<TOptions> method
BasicAuthenticationOptions class
BasicAuthenticationOptions constructor
BasicAuthenticationOptions.AllowInsecureHttp property
BasicAuthenticationOptions.ApplyTo method
BasicAuthenticationOptions.Base64Encoded property
BasicAuthenticationOptions.ClaimPolicyConfig property
BasicAuthenticationOptions.Description property
BasicAuthenticationOptions.DisplayName property
BasicAuthenticationOptions.DocumentationId property
BasicAuthenticationOptions.GlobalScheme property
BasicAuthenticationOptions.HeaderName property
BasicAuthenticationOptions.Host property
BasicAuthenticationOptions.IssueClaims property
BasicAuthenticationOptions.IssueClaimsCodeSettings property
BasicAuthenticationOptions.Logger property
BasicAuthenticationOptions.Realm 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
BasicAuthHandler.Host property
CookieAuthOptions class
CookieAuthOptions constructor
CookieAuthOptions.AllowInsecureHttp property
CookieAuthOptions.ApplyTo method (1 of 2)
CookieAuthOptions.Description property
CookieAuthOptions.DisplayName property
CookieAuthOptions.DocumentationId property
CookieAuthOptions.GlobalScheme property
CookieAuthOptions.Host property
CookieAuthOptions.Logger property
IAuthenticationCommonOptions interface
IAuthenticationCommonOptions.ValidateCodeSettings property
IAuthenticationHostOptions interface
IAuthenticationHostOptions.DisplayName property
IAuthenticationHostOptions.Host property
IAuthenticationHostOptions.Logger 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
IOpenApiAuthenticationOptions interface
IOpenApiAuthenticationOptions.DefaultDocumentationIds field
IOpenApiAuthenticationOptions.DefaultSchemeName field
IOpenApiAuthenticationOptions.Description property
IOpenApiAuthenticationOptions.DocumentationId property
IOpenApiAuthenticationOptions.GlobalScheme property
JwtAuthOptions class
JwtAuthOptions constructor
JwtAuthOptions.AllowInsecureHttp property
JwtAuthOptions.ApplyTo method (1 of 2)
JwtAuthOptions.ClaimPolicy property
JwtAuthOptions.ClaimPolicyConfig property
JwtAuthOptions.Description property
JwtAuthOptions.DisplayName property
JwtAuthOptions.DocumentationId property
JwtAuthOptions.GlobalScheme property
JwtAuthOptions.Host property
JwtAuthOptions.IssueClaims property
JwtAuthOptions.IssueClaimsCodeSettings property
JwtAuthOptions.Logger property
JwtAuthOptions.ValidationParameters property
OAuth2Options class
OAuth2Options constructor
OAuth2Options.ApplyTo method (1 of 2)
OAuth2Options.AuthenticationScheme property
OAuth2Options.ClaimPolicy property
OAuth2Options.CookieOptions property
OAuth2Options.CookieScheme property
OAuth2Options.Description property
OAuth2Options.DisplayName property
OAuth2Options.DocumentationId property
OAuth2Options.GlobalScheme property
OAuth2Options.Host property
OAuth2Options.Logger property
OidcEvents class
OidcEvents constructor
OidcEvents.AuthorizationCodeReceived method
OidcOptions class
OidcOptions constructor
OidcOptions.ApplyTo method (1 of 2)
OidcOptions.AuthenticationScheme property
OidcOptions.ClaimPolicy property
OidcOptions.CookieOptions property
OidcOptions.CookieScheme property
OidcOptions.Description property
OidcOptions.DisplayName property
OidcOptions.DocumentationId property
OidcOptions.GlobalScheme property
OidcOptions.Host property
OidcOptions.JwkJson property
OidcOptions.Logger property
OidcOptions.PushedAuthorizationBehavior property
WindowsAuthOptions class
WindowsAuthOptions constructor
WindowsAuthOptions.ApplyTo method (1 of 2)
WindowsAuthOptions.Description property
WindowsAuthOptions.DisplayName property
WindowsAuthOptions.DocumentationId property
WindowsAuthOptions.GlobalScheme property
WindowsAuthOptions.Host property
WindowsAuthOptions.Logger property
WindowsAuthOptions.Protocol property
WindowsAuthProtocol enumeration
Kestrun.Certificates
CertificateManager class
CertificateManager.BuildPrivateKeyJwt method (1 of 2)
CertificateManager.BuildPrivateKeyJwtFromJwkJson method
CertificateManager.CreateJwkJsonFromCertificate method
CertificateManager.CreateJwkJsonFromRsa method
CertificateManager.CreateJwkJsonFromRsaPrivateKeyPem method
CertificateManager.CreateSelfSignedCertificateFromJwk method
CertificateManager.Export method (1 of 2)
CertificateManager.ExportPemFromJwkJson method (1 of 2)
CertificateManager.GetPurposes method
CertificateManager.Import method (1 of 4)
CertificateManager.NewCertificateRequest method
CertificateManager.NewSelfSigned method
CertificateManager.Validate method
CsrOptions constructor
CsrOptions record
CsrOptions.CommonName property
CsrOptions.Country property
CsrOptions.DnsNames property
CsrOptions.KeyLength property
CsrOptions.KeyType property
CsrOptions.Org property
CsrOptions.OrgUnit property
CsrResult constructor
CsrResult record
CsrResult.CsrDer property
CsrResult.CsrPem property
CsrResult.PrivateKey property
CsrResult.PrivateKeyDer property
CsrResult.PrivateKeyPem property
CsrResult.PrivateKeyPemEncrypted property
CsrResult.PublicKeyDer property
CsrResult.PublicKeyPem property
ExportFormat enumeration
JwkJson class
JwkJson.Options field
KeyType enumeration
RsaJwk class
RsaJwk constructor
RsaJwk.D property
RsaJwk.DP property
RsaJwk.DQ property
RsaJwk.E property
RsaJwk.Kid property
RsaJwk.Kty property
RsaJwk.N property
RsaJwk.P property
RsaJwk.Q property
RsaJwk.QI property
SelfSignedOptions constructor
SelfSignedOptions record
SelfSignedOptions.DnsNames property
SelfSignedOptions.Ephemeral property
SelfSignedOptions.Exportable property
SelfSignedOptions.KeyLength property
SelfSignedOptions.KeyType property
SelfSignedOptions.Purposes property
SelfSignedOptions.ValidDays property
Kestrun.Claims
ClaimPolicyBuilder class
ClaimPolicyBuilder constructor
ClaimPolicyBuilder.AddPolicy method (1 of 3)
ClaimPolicyBuilder.Build method
ClaimPolicyBuilder.Clear method
ClaimPolicyBuilder.Create method
ClaimPolicyBuilder.Policies property
ClaimPolicyBuilder.ToString method
ClaimPolicyConfig class
ClaimPolicyConfig constructor
ClaimPolicyConfig.AddPolicies method
ClaimPolicyConfig.AddPolicy method
ClaimPolicyConfig.Count property
ClaimPolicyConfig.GetPolicy method
ClaimPolicyConfig.Policies property
ClaimPolicyConfig.PolicyNames property
ClaimPolicyExtensions class
ClaimPolicyExtensions.ToAuthzDelegate method
ClaimPolicyPostConfigurer class
ClaimPolicyPostConfigurer constructor
ClaimPolicyPostConfigurer.PostConfigure method
ClaimRule constructor (1 of 3)
ClaimRule record
ClaimRule.AllowedValues property
ClaimRule.ClaimType property
ClaimRule.Description property
KestrunClaimExtensions class
KestrunClaimExtensions.ToClaimUri method
UserIdentityClaim enumeration
Kestrun.Client
KrHttpClientFactory class
KrHttpClientFactory.CreateNamedPipeClient method (1 of 3)
KrHttpClientFactory.CreateTcpClient method (1 of 3)
KrHttpClientFactory.CreateUnixSocketClient method (1 of 3)
KrHttpClientOptions class
KrHttpClientOptions constructor
KrHttpClientOptions.AllowAutoRedirect property
KrHttpClientOptions.Cookies property
KrHttpClientOptions.Credentials property
KrHttpClientOptions.Decompression property
KrHttpClientOptions.IgnoreCertErrors property
KrHttpClientOptions.MaxAutomaticRedirections property
KrHttpClientOptions.Proxy property
KrHttpClientOptions.ProxyUseDefaultCredentials property
KrHttpClientOptions.Timeout property
KrHttpClientOptions.UseDefaultCredentials property
KrHttpClientOptions.UseProxy property
KrHttpDownloads class
KrHttpDownloads.DownloadToFileAsync method
Kestrun.Health
DiskSpaceProbe class
DiskSpaceProbe constructor
DiskSpaceProbe.CheckAsync method
DiskSpaceProbe.Logger property
DiskSpaceProbe.Name property
DiskSpaceProbe.Tags property
HealthEndpointContentType enumeration
HealthEndpointOptions class
HealthEndpointOptions constructor
HealthEndpointOptions.AllowAnonymous property
HealthEndpointOptions.AutoRegisterEndpoint property
HealthEndpointOptions.Clone method
HealthEndpointOptions.Compress property
HealthEndpointOptions.CorsPolicy property
HealthEndpointOptions.DefaultScriptLanguage property
HealthEndpointOptions.DefaultTags property
HealthEndpointOptions.MaxDegreeOfParallelism property
HealthEndpointOptions.OpenApiDescription property
HealthEndpointOptions.OpenApiGroupName property
HealthEndpointOptions.OpenApiOperationId property
HealthEndpointOptions.OpenApiSummary property
HealthEndpointOptions.OpenApiTags property
HealthEndpointOptions.Pattern property
HealthEndpointOptions.ProbeTimeout property
HealthEndpointOptions.RateLimitPolicyName property
HealthEndpointOptions.RequirePolicies property
HealthEndpointOptions.RequireSchemes property
HealthEndpointOptions.ResponseContentType property
HealthEndpointOptions.ShortCircuit property
HealthEndpointOptions.ShortCircuitStatusCode property
HealthEndpointOptions.ThrowOnDuplicate property
HealthEndpointOptions.TreatDegradedAsUnhealthy property
HealthEndpointOptions.XmlRootElementName property
HealthProbeEntry constructor
HealthProbeEntry record
HealthProbeEntry.Data property
HealthProbeEntry.Description property
HealthProbeEntry.Duration property
HealthProbeEntry.Error property
HealthProbeEntry.Name property
HealthProbeEntry.Status property
HealthProbeEntry.StatusText property
HealthProbeEntry.Tags property
HealthReport constructor
HealthReport record
HealthReport.AppliedTags property
HealthReport.GeneratedAt property
HealthReport.Probes property
HealthReport.Status property
HealthReport.StatusText property
HealthReport.Summary property
HealthReportTextFormatter class
HealthReportTextFormatter.Format method
HealthSummary constructor
HealthSummary record
HealthSummary.Degraded property
HealthSummary.Healthy property
HealthSummary.Total property
HealthSummary.Unhealthy property
HttpProbe class
HttpProbe constructor
HttpProbe.CheckAsync method
HttpProbe.Logger property
HttpProbe.Name property
HttpProbe.Tags property
IProbe interface
IProbe.CheckAsync method
IProbe.Name property
IProbe.TAG_SELF field
IProbe.Tags property
Probe class
Probe.CheckAsync method
Probe.Name property
Probe.Tags property
ProbeResult constructor
ProbeResult record
ProbeResult.Data property
ProbeResult.Description property
ProbeResult.Status property
ProbeStatus enumeration
ProbeStatusLabels class
ProbeStatusLabels.STATUS_DEGRADED field
ProbeStatusLabels.STATUS_FAIL field
ProbeStatusLabels.STATUS_FAILED field
ProbeStatusLabels.STATUS_HEALTHY field
ProbeStatusLabels.STATUS_OK field
ProbeStatusLabels.STATUS_UNHEALTHY field
ProbeStatusLabels.STATUS_WARN field
ProbeStatusLabels.STATUS_WARNING field
ProcessProbe class
ProcessProbe constructor
ProcessProbe.CheckAsync method
ProcessProbe.Logger property
ProcessProbe.Name property
ProcessProbe.Tags property
Kestrun.Hosting
KestrunHost class
KestrunHost constructor (1 of 3)
KestrunHost.AddControllers method
KestrunHost.AddFeature method
KestrunHost.AddPowerShellRazorPages method (1 of 6)
KestrunHost.AddPowerShellRuntime method
KestrunHost.AddProbe method (1 of 3)
KestrunHost.AddRazorPages method (1 of 2)
KestrunHost.AddScheduling method
KestrunHost.AddService method
KestrunHost.AddSignalR method (1 of 2)
KestrunHost.AddTasks method
KestrunHost.AntiforgeryOptions property
KestrunHost.ApplicationName property
KestrunHost.Build method
KestrunHost.ConfigureListener method (1 of 5)
KestrunHost.CorsPolicyDefined property
KestrunHost.CreateRunspacePool method
KestrunHost.DefaultCacheControl property
KestrunHost.DefaultHost property
KestrunHost.DefinedCorsPolicyNames property
KestrunHost.Dispose method
KestrunHost.EnableConfiguration method
KestrunHost.ExceptionOptions property
KestrunHost.ForwardedHeaderOptions property
KestrunHost.GetOrCreateOpenApiDocument method
KestrunHost.IsConfigured property
KestrunHost.IsRunning property
KestrunHost.IsServiceRegistered method (1 of 2)
KestrunHost.KestrunRoot property
KestrunHost.Logger property
KestrunHost.ModulePaths property
KestrunHost.OpenApiDocumentDescriptor property
KestrunHost.Options property
KestrunHost.PowershellMiddlewareEnabled property
KestrunHost.RegisteredAuthentications property
KestrunHost.RegisteredRoutes property
KestrunHost.RouteGroupStack property
KestrunHost.Run method
KestrunHost.Scheduler property
KestrunHost.SharedState property
KestrunHost.StartAsync method
KestrunHost.StartTime property
KestrunHost.StatusCodeOptions property
KestrunHost.Stop method
KestrunHost.StopAsync method
KestrunHost.StopTime property
KestrunHost.Tasks property
KestrunHost.Uptime property
KestrunHost.Use method
KestrunHostAuthnExtensions class
KestrunHostAuthnExtensions.AddApiKeyAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddAuthorization method
KestrunHostAuthnExtensions.AddBasicAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddCookieAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddGitHubOAuthAuthentication method
KestrunHostAuthnExtensions.AddJwtBearerAuthentication method (1 of 2)
KestrunHostAuthnExtensions.AddOAuth2Authentication method
KestrunHostAuthnExtensions.AddOpenIdConnectAuthentication method
KestrunHostAuthnExtensions.AddWindowsAuthentication method (1 of 3)
KestrunHostAuthnExtensions.HasAuthPolicy method
KestrunHostAuthnExtensions.HasAuthScheme method
KestrunHostHealthExtensions class
KestrunHostHealthExtensions.AddHealthEndpoint method (1 of 2)
KestrunHostMapExtensions class
KestrunHostMapExtensions.AddAntiforgeryTokenRoute method
KestrunHostMapExtensions.AddElementsUiRoute method
KestrunHostMapExtensions.AddHtmlTemplateRoute method (1 of 2)
KestrunHostMapExtensions.AddMapRoute method (1 of 6)
KestrunHostMapExtensions.AddOpenApiMapRoute method
KestrunHostMapExtensions.AddRapiDocUiRoute method
KestrunHostMapExtensions.AddRedocUiRoute method
KestrunHostMapExtensions.AddScalarUiRoute method
KestrunHostMapExtensions.AddSwaggerUiRoute method
KestrunHostMapExtensions.ApplyKestrunConventions method
KestrunHostMapExtensions.EndpointSpecParser class
KestrunHostMapExtensions.EndpointSpecParser.TryParse method
KestrunHostMapExtensions.GetMapRouteOptions method
KestrunHostMapExtensions.KestrunHandler delegate
KestrunHostMapExtensions.MapExists method (1 of 2)
KestrunHostMapExtensions.TryParseEndpointSpec method
KestrunHostScriptValidationExtensions class
KestrunHostScriptValidationExtensions.GetCSharpScriptErrors method
KestrunHostScriptValidationExtensions.IsCSharpScriptValid method
KestrunHostScriptValidationExtensions.ValidateCSharpScript method
KestrunHostSessionExtensions class
KestrunHostSessionExtensions.AddDistributedMemoryCache method
KestrunHostSessionExtensions.AddDistributedSqlServerCache method
KestrunHostSessionExtensions.AddSession method
KestrunHostSessionExtensions.AddStackExchangeRedisCache method
KestrunHostSessionExtensions.IsDistributedCacheRegistered method
KestrunHostSignalRExtensions class
KestrunHostSignalRExtensions.BroadcastEventAsync method
KestrunHostSignalRExtensions.BroadcastLogAsync method
KestrunHostSignalRExtensions.BroadcastToGroupAsync method
KestrunHostSignalRExtensions.GetConnectedClientCount 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.AddCommonAccessLog method (1 of 2)
KestrunHttpMiddlewareExtensions.AddHsts method (1 of 2)
KestrunHttpMiddlewareExtensions.AddHttpsRedirection method (1 of 2)
KestrunHttpMiddlewareExtensions.AddResponseCaching method (1 of 2)
KestrunHttpMiddlewareExtensions.AddResponseCompression method (1 of 2)
KestrunSecurityMiddlewareExtensions class
KestrunSecurityMiddlewareExtensions.AddAntiforgery method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddCorsDefaultPolicy method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddCorsDefaultPolicyAllowAll method
KestrunSecurityMiddlewareExtensions.AddCorsPolicy method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddCorsPolicyAllowAll method
KestrunSecurityMiddlewareExtensions.AddHostFiltering method (1 of 2)
KestrunSecurityMiddlewareExtensions.AddRateLimiter method (1 of 2)
NoopHostLifetime class
NoopHostLifetime constructor
NoopHostLifetime.StopAsync method
NoopHostLifetime.WaitForStartAsync method
Kestrun.Hosting.Compression
KestrunCompressionServiceCollectionExtensions class
KestrunCompressionServiceCollectionExtensions.AddKestrunCompressionOptOut method
KestrunResponseCompressionProvider class
KestrunResponseCompressionProvider constructor
KestrunResponseCompressionProvider.CheckRequestAcceptsCompression method
KestrunResponseCompressionProvider.GetCompressionProvider method
KestrunResponseCompressionProvider.ShouldCompressResponse method
Kestrun.Hosting.Options
DefaultResponseContentType constructor
DefaultResponseContentType record
DefaultResponseContentType.ContentType property
ExceptionOptions class
ExceptionOptions constructor
ExceptionOptions.DeveloperExceptionPageOptions property
ExceptionOptions.Host property
ExceptionOptions.LanguageOptions property
ExceptionOptions.LegacyStatusCodeSelector property
ExceptionOptions.UseJsonExceptionHandler method
KestrelOptionsExtensions class
KestrelOptionsExtensions.CopyFromTemplate method
KestrunOptions class
KestrunOptions constructor
KestrunOptions.ApplicationName property
KestrunOptions.Health property
KestrunOptions.HttpsConnectionAdapter property
KestrunOptions.Listeners property
KestrunOptions.ListenUnixSockets property
KestrunOptions.MaxRunspaces property
KestrunOptions.MaxSchedulerRunspaces property
KestrunOptions.MinRunspaces property
KestrunOptions.NamedPipeNames property
KestrunOptions.NamedPipeOptions property
KestrunOptions.ServerLimits property
KestrunOptions.ServerOptions property
LanguageOptions constructor
LanguageOptions record
LanguageOptions.Arguments property
LanguageOptions.Code property
LanguageOptions.ExtraImports property
LanguageOptions.ExtraRefs property
LanguageOptions.Language property
LanguageOptions.LanguageVersion property
LanguageOptions.Parameters property
LanguageOptions.ScriptBlock property
ListenerOptions class
ListenerOptions constructor
ListenerOptions.DisableAltSvcHeader property
ListenerOptions.IPAddress property
ListenerOptions.Port property
ListenerOptions.Protocols property
ListenerOptions.ToString method
ListenerOptions.UseConnectionLogging property
ListenerOptions.UseHttps property
ListenerOptions.X509Certificate property
MapRouteOptions class
MapRouteOptions constructor
MapRouteOptions.AddSecurityRequirementObject method
MapRouteOptions.AllowAnonymous property
MapRouteOptions.CorsPolicy property
MapRouteOptions.DefaultResponseContentType property
MapRouteOptions.DisableAntiforgery property
MapRouteOptions.DisableResponseCompression property
MapRouteOptions.Endpoints property
MapRouteOptions.HttpVerbs property
MapRouteOptions.OpenAPI property
MapRouteOptions.PathLevelOpenAPIMetadata property
MapRouteOptions.Pattern property
MapRouteOptions.RateLimitPolicyName property
MapRouteOptions.RequirePolicies property
MapRouteOptions.RequireSchemes property
MapRouteOptions.ScriptCode property
MapRouteOptions.ShortCircuit property
MapRouteOptions.ShortCircuitStatusCode property
MapRouteOptions.ThrowOnDuplicate property
MapRouteOptions.ToString method
OpenAPICommonMetadata constructor (1 of 2)
OpenAPICommonMetadata record
OpenAPICommonMetadata.CorsPolicy property
OpenAPICommonMetadata.Description property
OpenAPICommonMetadata.Enabled property
OpenAPICommonMetadata.Parameters property
OpenAPICommonMetadata.Pattern property
OpenAPICommonMetadata.Servers property
OpenAPICommonMetadata.Summary property
OpenApiMapRouteOptions constructor
OpenApiMapRouteOptions record
OpenApiMapRouteOptions.DefaultFormat property
OpenApiMapRouteOptions.DefaultVersion property
OpenApiMapRouteOptions.DocId property
OpenApiMapRouteOptions.FormatVarName property
OpenApiMapRouteOptions.MapOptions property
OpenApiMapRouteOptions.RefreshVarName property
OpenApiMapRouteOptions.SpecVersion property
OpenApiMapRouteOptions.VersionVarName property
OpenAPIMetadata constructor (1 of 2)
OpenAPIMetadata record
OpenAPIMetadata.Callbacks property
OpenAPIMetadata.Deprecated property
OpenAPIMetadata.ExternalDocs property
OpenAPIMetadata.OperationId property
OpenAPIMetadata.RequestBody property
OpenAPIMetadata.Responses property
OpenAPIMetadata.SecuritySchemes property
OpenAPIMetadata.Tags property
StatusCodeOptions class
StatusCodeOptions constructor
StatusCodeOptions.BodyFormat property
StatusCodeOptions.ContentType property
StatusCodeOptions.Host property
StatusCodeOptions.LanguageOptions property
StatusCodeOptions.LocationFormat property
StatusCodeOptions.Options property
StatusCodeOptions.PathFormat property
StatusCodeOptions.QueryFormat property
Kestrun.Jwt
JwkUtilities class
JwkUtilities.ComputeThumbprintFromCertificate method
JwkUtilities.ComputeThumbprintRsa method
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.EncryptWithJwkJson method
JwtTokenBuilder.EncryptWithJwkPath 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.SignWithJwkJson 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
ParameterForInjectionInfo constructor (1 of 2)
ParameterForInjectionInfo record
ParameterForInjectionInfo.DefaultValue property
ParameterForInjectionInfo.In property
ParameterForInjectionInfo.IsRequestBody property
ParameterForInjectionInfo.Name property
ParameterForInjectionInfo.ParameterType property
ParameterForInjectionInfo.Type property
Kestrun.Logging
LoggerConfigurationExtensions class
LoggerConfigurationExtensions.EnsureSwitch method
LoggerConfigurationExtensions.Register method
LoggerExtensions class
LoggerExtensions.DebugSanitized method (1 of 2)
LoggerExtensions.ErrorSanitized method
LoggerManager class
LoggerManager.Clear method
LoggerManager.CloseAndFlush method (1 of 2)
LoggerManager.Contains method (1 of 3)
LoggerManager.DefaultLogger property
LoggerManager.DefaultLoggerName property
LoggerManager.Get method
LoggerManager.GetDefault method
LoggerManager.GetLevelSwitch method
LoggerManager.GetName method
LoggerManager.List method
LoggerManager.ListLevels method
LoggerManager.ListLoggers method
LoggerManager.New method
LoggerManager.Register method
LoggerManager.SetLevelSwitch method
LoggerManager.TryGetName 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
CommonAccessLogMiddleware class
CommonAccessLogMiddleware constructor
CommonAccessLogMiddleware.InvokeAsync method
CommonAccessLogOptions class
CommonAccessLogOptions constructor
CommonAccessLogOptions.ClientAddressHeader property
CommonAccessLogOptions.DefaultTimestampFormat field
CommonAccessLogOptions.IncludeElapsedMilliseconds property
CommonAccessLogOptions.IncludeProtocol property
CommonAccessLogOptions.IncludeQueryString property
CommonAccessLogOptions.Level property
CommonAccessLogOptions.Logger property
CommonAccessLogOptions.TimeProvider property
CommonAccessLogOptions.TimestampFormat property
CommonAccessLogOptions.UseUtcTimestamp property
FaviconMiddlewareExtensions class
FaviconMiddlewareExtensions.UseFavicon method
PowerShellRunspaceMiddleware class
PowerShellRunspaceMiddleware constructor
PowerShellRunspaceMiddleware.InvokeAsync method
PowerShellRunspaceMiddlewareExtensions class
PowerShellRunspaceMiddlewareExtensions.UsePowerShellRunspace method
StatusCodePageExtensions class
StatusCodePageExtensions.UseStatusCodePages method
Kestrun.Models
ContentDispositionOptions class
ContentDispositionOptions constructor
ContentDispositionOptions.FileName property
ContentDispositionOptions.ToString method
ContentDispositionOptions.Type property
ContentDispositionType enumeration
KestrunContext constructor (1 of 2)
KestrunContext record
KestrunContext.BroadcastEvent method
KestrunContext.BroadcastEventAsync method
KestrunContext.BroadcastLog method
KestrunContext.BroadcastLogAsync method
KestrunContext.BroadcastToGroup method
KestrunContext.BroadcastToGroupAsync method
KestrunContext.Challenge method (1 of 3)
KestrunContext.ChallengeAsync method
KestrunContext.Connection property
KestrunContext.Ct property
KestrunContext.HasSession property
KestrunContext.Host property
KestrunContext.HttpContext property
KestrunContext.Items property
KestrunContext.Request property
KestrunContext.Response property
KestrunContext.Session property
KestrunContext.SignOut method (1 of 3)
KestrunContext.TryGetSession method
KestrunContext.User property
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.HttpContext 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.Request property
KestrunRequest.RouteValues property
KestrunRequest.Scheme property
KestrunResponse class
KestrunResponse constructor
KestrunResponse.AcceptCharset property
KestrunResponse.ApplyCachingHeaders method
KestrunResponse.ApplyTo method
KestrunResponse.Body property
KestrunResponse.BodyAsyncThreshold property
KestrunResponse.CacheControl property
KestrunResponse.ContentDisposition property
KestrunResponse.ContentType property
KestrunResponse.Context property
KestrunResponse.Cookies property
KestrunResponse.Encoding property
KestrunResponse.GetHeader method
KestrunResponse.Headers property
KestrunResponse.IsTextBasedContentType method
KestrunResponse.RedirectUrl property
KestrunResponse.Request property
KestrunResponse.RevalidateCache method
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.WriteFormUrlEncodedResponse method
KestrunResponse.WriteFormUrlEncodedResponseAsync method
KestrunResponse.WriteHtmlResponse method (1 of 2)
KestrunResponse.WriteHtmlResponseAsync method (1 of 2)
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.WriteStatusOnly method
KestrunResponse.WriteStreamResponse method
KestrunResponse.WriteTextResponse method
KestrunResponse.WriteTextResponseAsync method
KestrunResponse.WriteXmlResponse method
KestrunResponse.WriteXmlResponseAsync method
KestrunResponse.WriteYamlResponse method
KestrunResponse.WriteYamlResponseAsync method
Kestrun.OpenApi
FunctionInfoExtensions class
FunctionInfoExtensions.GetDefaultParameterValue method
HelpExtractor class
HelpExtractor.GetDescription method
HelpExtractor.GetHelp method
HelpExtractor.GetParameterDescription method
HelpExtractor.GetSynopsis method
OaParameterExtensions class
OaParameterExtensions.ToOpenApi method (1 of 2)
OaParameterExtensions.ToOpenApiParameterLocation method
OaParameterExtensions.ToParameterLocation method
OaParameterExtensions.ToParameterStyle method
OaSchemaTypeExtensions class
OaSchemaTypeExtensions.ToJsonSchemaType method
OpenApiComponentClone class
OpenApiComponentClone.Clone method (1 of 32)
OpenApiComponentClone.ConvertToSchema method
OpenApiComponentClone.JsonNodeClone method
OpenApiComponentSet class
OpenApiComponentSet constructor
OpenApiComponentSet.CallbackTypes property
OpenApiComponentSet.ExampleTypes property
OpenApiComponentSet.HeaderTypes property
OpenApiComponentSet.LinkTypes property
OpenApiComponentSet.ParameterTypes property
OpenApiComponentSet.PathItemTypes property
OpenApiComponentSet.RequestBodyTypes property
OpenApiComponentSet.ResponseTypes property
OpenApiComponentSet.SchemaTypes property
OpenApiComponentSet.SecuritySchemeTypes property
OpenApiDocDescriptor class
OpenApiDocDescriptor constructor
OpenApiDocDescriptor.ApplySecurityScheme method
OpenApiDocDescriptor.Document property
OpenApiDocDescriptor.DocumentId property
OpenApiDocDescriptor.GenerateComponents method
OpenApiDocDescriptor.GenerateDoc method
OpenApiDocDescriptor.HasBeenGenerated property
OpenApiDocDescriptor.Host property
OpenApiDocDescriptor.LoadAnnotatedFunctions method
OpenApiDocDescriptor.ReadAndDiagnose method
OpenApiDocDescriptor.SecurityRequirement property
OpenApiDocDescriptor.ToJson method
OpenApiDocDescriptor.ToYaml method
OpenApiHelper class
OpenApiJsonNodeFactory class
OpenApiJsonNodeFactory.FromObject method
OpenApiSchemaDiscovery class
OpenApiSchemaDiscovery.GetOpenApiTypesAuto method
OpenApiSpecVersionExtensions class
OpenApiSpecVersionExtensions.ParseOpenApiSpecVersion method
OpenApiSpecVersionExtensions.ToVersionString method
Kestrun.Razor
PowerShellRazorPage class
PowerShellRazorPage.UsePowerShellRazorPages method
PwshKestrunModel class
PwshKestrunModel constructor
PwshKestrunModel.Config property
PwshKestrunModel.Data property
PwshKestrunModel.Query method
Kestrun.Runtime
EnvironmentHelper class
EnvironmentHelper.ClearOverride method
EnvironmentHelper.IsDevelopment method
EnvironmentHelper.IsProduction method
EnvironmentHelper.IsStaging method
EnvironmentHelper.Name property
EnvironmentHelper.SetHostEnvironment method
EnvironmentHelper.SetOverride method
EnvironmentHelper.SetOverrideName method
PowerShellOpenApiClassExporter class
PowerShellOpenApiClassExporter.ExportOpenApiClasses method (1 of 2)
PowerShellOpenApiClassExporter.ValidClassNames property
PowerShellOpenApiClassExporter.WriteOpenApiTempScript method
VariablesMap class
VariablesMap.GetCommonProperties method
VariablesMap.GetVariablesMap 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.Host property
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
KestrunRunspacePoolManager class
KestrunRunspacePoolManager constructor
KestrunRunspacePoolManager.Acquire method
KestrunRunspacePoolManager.AcquireAsync method
KestrunRunspacePoolManager.Dispose method
KestrunRunspacePoolManager.Host property
KestrunRunspacePoolManager.MaxRunspaces property
KestrunRunspacePoolManager.MinRunspaces property
KestrunRunspacePoolManager.OpenApiClassesPath 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
GlobalStore class
GlobalStore.Clear method
GlobalStore.Contains method
GlobalStore.Count property
GlobalStore.Get method
GlobalStore.Keys property
GlobalStore.KeySnapshot method
GlobalStore.Remove method
GlobalStore.Set method
GlobalStore.Snapshot method
GlobalStore.TryGet<T> method
GlobalStore.Values property
SharedState class
SharedState constructor
SharedState.Clear method
SharedState.Contains method
SharedState.Count property
SharedState.Get method
SharedState.Keys property
SharedState.KeySnapshot method
SharedState.Remove method
SharedState.Set method
SharedState.Snapshot method
SharedState.TryGet<T> method
SharedState.Values property
Kestrun.SignalR
IConnectionTracker interface
IConnectionTracker.ConnectedCount property
IConnectionTracker.GetConnections method
IConnectionTracker.OnConnected method
IConnectionTracker.OnDisconnected method
InMemoryConnectionTracker class
InMemoryConnectionTracker constructor
InMemoryConnectionTracker.ConnectedCount property
InMemoryConnectionTracker.GetConnections method
InMemoryConnectionTracker.OnConnected method
InMemoryConnectionTracker.OnDisconnected method
IRealtimeBroadcaster interface
IRealtimeBroadcaster.BroadcastEventAsync method
IRealtimeBroadcaster.BroadcastLogAsync method
IRealtimeBroadcaster.BroadcastToGroupAsync method
KestrunHub class
KestrunHub constructor
KestrunHub.Echo method
KestrunHub.JoinGroup method
KestrunHub.LeaveGroup method
KestrunHub.OnConnectedAsync method
KestrunHub.OnDisconnectedAsync method
RealtimeBroadcaster class
RealtimeBroadcaster constructor
RealtimeBroadcaster.BroadcastEventAsync method
RealtimeBroadcaster.BroadcastLogAsync method
RealtimeBroadcaster.BroadcastToGroupAsync method
Kestrun.Tasks
KestrunTask class
KestrunTask.Children property
KestrunTask.CompletedAtUtc property
KestrunTask.Description property
KestrunTask.Fault property
KestrunTask.Finished property
KestrunTask.Id property
KestrunTask.Name property
KestrunTask.Output property
KestrunTask.Parent property
KestrunTask.Progress property
KestrunTask.Runner property
KestrunTask.ScriptCode property
KestrunTask.StartedAtUtc property
KestrunTask.State property
KestrunTask.TokenSource property
KestrunTask.ToKrTask method
KestrunTask.Work property
KestrunTaskService class
KestrunTaskService constructor
KestrunTaskService.Cancel method
KestrunTaskService.Create method
KestrunTaskService.Get method
KestrunTaskService.GetResult method
KestrunTaskService.GetState method
KestrunTaskService.List method
KestrunTaskService.Remove method
KestrunTaskService.SetTaskDescription method
KestrunTaskService.SetTaskName method
KestrunTaskService.Start method
KestrunTaskService.StartAsync method
KrTask constructor
KrTask record
KrTask.ChildrenId property
KrTask.CompletedAt property
KrTask.Description property
KrTask.Duration property
KrTask.Id property
KrTask.Name property
KrTask.ParentId property
KrTask.Progress property
KrTask.StartedAt property
KrTask.State property
KrTask.StateText property
ProgressiveKestrunTaskState class
ProgressiveKestrunTaskState constructor
ProgressiveKestrunTaskState.Cancel method
ProgressiveKestrunTaskState.Complete method
ProgressiveKestrunTaskState.Fail method
ProgressiveKestrunTaskState.PercentComplete property
ProgressiveKestrunTaskState.Reset method
ProgressiveKestrunTaskState.StatusMessage property
ProgressiveKestrunTaskState.ToString method
TaskState enumeration
Kestrun.TBuilder
EndpointConventionBuilderLanguageExtensions class
EndpointConventionBuilderLanguageExtensions.WithLanguage<TBuilder> method
EndpointDisablingCompressionExtensions class
EndpointDisablingCompressionExtensions.DisableResponseCompression<TBuilder> method
EndpointDisablingCompressionExtensions.DisableResponseCompressionKey field
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
ObjectToDictionaryConverter class
ObjectToDictionaryConverter.ToDictionary method
ObjectToDictionaryConverter.ToDictionaryObject 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
XmlHelper class
XmlHelper.DefaultMaxDepth field
XmlHelper.MaxDepth property
XmlHelper.ToHashtable method
XmlHelper.ToXml method
Kestrun.Utilities.Json
JsonSerializerHelper class
JsonSerializerHelper.FromJson method (1 of 2)
PayloadSanitizer class
PayloadSanitizer.Sanitize method
Kestrun.Utilities.Yaml
BigIntegerTypeConverter class
BigIntegerTypeConverter constructor
BigIntegerTypeConverter.Accepts method
BigIntegerTypeConverter.ReadYaml method
BigIntegerTypeConverter.WriteYaml method
BuilderUtils class
BuilderUtils constructor
BuilderUtils.BuildSerializer method
FlowStyleAllEmitter class
FlowStyleAllEmitter constructor
FlowStyleAllEmitter.Emit method (1 of 2)
FlowStyleSequenceEmitter class
FlowStyleSequenceEmitter constructor
FlowStyleSequenceEmitter.Emit method
IDictionaryTypeConverter class
IDictionaryTypeConverter constructor
IDictionaryTypeConverter.Accepts method
IDictionaryTypeConverter.ReadYaml method
IDictionaryTypeConverter.WriteYaml method
NullValueGraphVisitor class
NullValueGraphVisitor constructor
NullValueGraphVisitor.EnterMapping method (1 of 2)
PSObjectTypeConverter class
PSObjectTypeConverter constructor
PSObjectTypeConverter.Accepts method
PSObjectTypeConverter.ReadYaml method
PSObjectTypeConverter.WriteYaml method
SerializationOptions enumeration
StringQuotingEmitter class
StringQuotingEmitter constructor
StringQuotingEmitter.Emit method
YamlHelper class
YamlHelper.ToYaml method
YamlLoader class
YamlLoader.DeserializeToObjects method
YamlLoader.GetRootNodes method
YamlLoader.GetYamlDocuments method
YamlSerializerFactory class
YamlSerializerFactory.GetSerializer method
YamlTypeConverter class
YamlTypeConverter.ConvertValueToProperType method
YamlTypeConverter.ConvertYamlDocumentToPSObject method (1 of 2)
YamlTypeConverter.ConvertYamlMappingToHashtable method
YamlTypeConverter.ConvertYamlSequenceToArray method
Guides
Antiforgery (CSRF) Protection
HTTP Caching
Certificates Management
Response Compression
CORS
ExceptionHandling
Forwarded Headers
Health Monitoring
HSTS and HTTPS Redirection
JWT Tokens
Kestrun Logging
OAuth 2.0
OpenID Connect (OIDC)
OpenAPI Generation
Component Headers
Component Links
Component Callbacks
WebHooks
Redocly Museum API
Swagger Petstore
Routing & Conventions
Razor Pages
Scheduling
Client Sessions
Shared State & Runspaces
Status Code Pages Middleware
Ad-hoc Tasks
Contributing
Build & Environment
Testing
Style & Quality
Git Workflow
Troubleshooting
Logging & Console Output
Tutorial Page Authoring Template
Kestrun on GitHub
Repository
C#
C# API
Kestrun.Authentication
ApiKeyAuthenticationOptions.Description property
ApiKeyAuthenticationOptions.Description property
public
string
?
Description
{
get
;
set
;
}
See Also
class
ApiKeyAuthenticationOptions
namespace
Kestrun.Authentication