Skip to content

Commit 17f1625

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Get-WebSocket -Authenticate ( Fixes #69 )
1 parent dcd8bbd commit 17f1625

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/Get-WebSocket.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,17 @@ The Scriptblock to run when the WebSocket job produces a warning.
308308
|---------------|--------|--------|-------------|
309309
|`[ScriptBlock]`|false |named |false |
310310

311+
#### **Authenticate**
312+
If provided, will authenticate the WebSocket.
313+
Many websockets require an initial authentication handshake
314+
after an initial message is received.
315+
This parameter can be either a ScriptBlock or any other object.
316+
If it is a ScriptBlock, it will be run with the output of the WebSocket passed as the first argument.
317+
318+
|Type |Required|Position|PipelineInput|Aliases |
319+
|------------|--------|--------|-------------|----------------------|
320+
|`[PSObject]`|false |named |false |Authorize<br/>Identify|
321+
311322
#### **Watch**
312323
If set, will watch the output of the WebSocket job, outputting results continuously instead of outputting a websocket job.
313324

@@ -438,7 +449,7 @@ RunspacePools allow you to limit the scope of the handler to a pool of runspaces
438449

439450
### Syntax
440451
```PowerShell
441-
Get-WebSocket [[-SocketUrl] <Uri>] [-QueryParameter <IDictionary>] [-ForwardEvent] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Watch] [-RawText] [-Binary] [-Force] [-SubProtocol <String>] [-Filter <PSObject[]>] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-PSTypeName <String[]>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
452+
Get-WebSocket [[-SocketUrl] <Uri>] [-QueryParameter <IDictionary>] [-ForwardEvent] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-OnConnect <ScriptBlock>] [-OnError <ScriptBlock>] [-OnOutput <ScriptBlock>] [-OnWarning <ScriptBlock>] [-Authenticate <PSObject>] [-Watch] [-RawText] [-Binary] [-Force] [-SubProtocol <String>] [-Filter <PSObject[]>] [-WatchFor <IDictionary>] [-TimeOut <TimeSpan>] [-PSTypeName <String[]>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-ConnectionTimeout <TimeSpan>] [-Runspace <Runspace>] [-RunspacePool <RunspacePool>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
442453
```
443454
```PowerShell
444455
Get-WebSocket [-RootUrl] <String[]> [-Route <IDictionary>] [-HTML <String>] [-PaletteName <String>] [-GoogleFont <String>] [-CodeFont <String>] [-JavaScript <String[]>] [-ImportMap <IDictionary>] [-Handler <ScriptBlock>] [-Variable <IDictionary>] [-Header <IDictionary>] [-Name <String>] [-InitializationScript <ScriptBlock>] [-BufferSize <Int32>] [-Broadcast <PSObject>] [-Force] [-TimeOut <TimeSpan>] [-Maximum <Int64>] [-ThrottleLimit <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

0 commit comments

Comments
 (0)