Send-PSUEvent

Sends events to an event hub.

SYNOPSIS

Sends events to an event hub.

SYNTAX

ScriptHub (Default)

Send-PSUEvent -Hub <String> [-ConnectionId <String>] [-Data <Object>] [-Timeout <Int32>]
 [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

ScriptComputer

Send-PSUEvent -Computer <String> [-Data <Object>] [-Timeout <Int32>] [-ComputerName <String>]
 [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
 [-Cookies] [<CommonParameters>]

ModuleComputer

Send-PSUEvent -Computer <String> [-Command <String>] [-Parameters <Hashtable>] [-Timeout <Int32>]
 [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

ModuleHub

Send-PSUEvent -Hub <String> [-ConnectionId <String>] [-Command <String>] [-Parameters <Hashtable>]
 [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

DESCRIPTION

Sends events to an event hub.

EXAMPLES

Example 1

PS C:\> Send-PSUEvent -Hub 'MyHub' -Data @{ Name = 'Adam' }

Sends an event to the MyHub event hub. All connected clients will receive the event.

PARAMETERS

-AppToken

Not used.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Not used.

Type: String
Parameter Sets: (All)
Aliases: Uri

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Data

The data to send to the client. This data will be serialized to CliXml and deserialized on the client.

Type: Object
Parameter Sets: ScriptHub, ScriptComputer
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Hub

The name of the event hub to send the event to.

Type: String
Parameter Sets: ScriptHub, ModuleHub
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Integrated

Not used.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseDefaultCredentials

Not used.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConnectionId

The connection ID to send the event to. If not specified, the event will be sent to all connected clients.

Type: String
Parameter Sets: ScriptHub, ModuleHub
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Command

The command to run on the agent.

Type: String
Parameter Sets: ModuleComputer, ModuleHub
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Computer

The computer to run this command on.

Type: String
Parameter Sets: ScriptComputer, ModuleComputer
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to login to the PowerShell Universal Management API.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Parameters

A hashtable of parameters to send to the command.

Type: Hashtable
Parameter Sets: ModuleComputer, ModuleHub
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrustCertificate

Whether the cmdlet should ignore certificate issues.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timeout

The timeout in seconds for the command to run.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cookies

Reuses and persists authentication cookies for the current PowerShell session.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS