Add-KrSignalRHubMiddleware

SYNOPSIS

Maps a SignalR hub class to the given URL path.

SYNTAX

Items (Default)

Add-KrSignalRHubMiddleware [-Path <string>] [-DocId <string[]>] [-Summary <string>]
 [-Description <string>] [-Tags <string[]>] [-HubName <string>] [-IncludeNegotiateEndpoint]
 [<CommonParameters>]

ItemsSkipOpenApi

Add-KrSignalRHubMiddleware [-Path <string>] [-DocId <string[]>] [-SkipOpenApi] [<CommonParameters>]

Options

Add-KrSignalRHubMiddleware -Options <SignalROptions> [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

This function allows you to map a SignalR hub class to a specific URL path on the Kestrun server.

EXAMPLES

EXAMPLE 1

Add-KrSignalRHubMiddleware -Path ‘/hubs/notifications’ -HubName ‘NotificationsHub’ -IncludeNegotiateEndpoint Adds a SignalR hub at the path ‘/hubs/notifications’ with the hub name ‘NotificationsHub’ and includes the negotiate endpoint.

EXAMPLE 2

$options = [Kestrun.Hosting.Options.SignalROptions]::new() $options.Path = ‘/hubs/updates’ $options.HubName = ‘UpdatesHub’ $options.IncludeNegotiateEndpoint = $true Add-KrSignalRHubMiddleware -Options $options Adds a SignalR hub at the path ‘/hubs/updates’ with the hub name ‘UpdatesHub’ and includes the negotiate endpoint, using the provided options object for configuration.

EXAMPLE 3

Add-KrSignalRHubMiddleware -Path ‘/hubs/alerts’ -HubName ‘AlertsHub’ -SkipOpenApi Adds a SignalR hub at the path ‘/hubs/alerts’ with the hub name ‘AlertsHub’ and skips OpenAPI documentation for this endpoint.

PARAMETERS

-Description

Optional OpenAPI description override for the SignalR hub endpoint.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DocId

The OpenAPI document IDs to which the SignalR hub endpoint should be added. Default is ‘

Type: System.String[]
DefaultValue: '[Kestrun.OpenApi.OpenApiDocDescriptor]::DefaultDocumentationIds'
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ItemsSkipOpenApi
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-HubName

Optional name of the SignalR hub. If not provided, defaults to ‘kestrun’.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeNegotiateEndpoint

If specified, includes the negotiate endpoint for the SignalR hub.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Options

Full OpenAPI customization object (Kestrun.Hosting.Options.SignalROpenApiOptions). When provided, it takes precedence over the individual -OpenApi* parameters.

Type: Kestrun.Hosting.Options.SignalROptions
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Options
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Path

The URL path where the SignalR hub will be accessible. Defaults to ‘/hubs/kestrun’.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ItemsSkipOpenApi
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SkipOpenApi

If specified, the OpenAPI documentation for this endpoint will be skipped.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ItemsSkipOpenApi
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Summary

Optional OpenAPI summary override for the SignalR hub endpoint.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Tags

Optional OpenAPI tags override for the SignalR hub endpoint.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Items
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

This function is part of the Kestrun PowerShell module and is used to manage SignalR hubs on the Kestrun server. The Server parameter accepts a KestrunHost instance; if not provided, the default server is used. The Path parameter specifies the URL path where the SignalR hub will be accessible. The PassThru switch allows the function to return the modified server instance for further use.