Send-PSUEvent

SYNOPSIS

Sends data or commands to an event hub, computer, or computer group.

SYNTAX

Send-PSUEvent -Hub <String> [-ConnectionId <String>] [-Data <Object>] [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
Send-PSUEvent -Hub <String> [-ConnectionId <String>] [-Command <String>] [-Parameters <Hashtable>] [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
Send-PSUEvent -Computer <String> [-Data <Object>] [-ScriptBlock <ScriptBlock>] [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
Send-PSUEvent -Computer <String> [-Command <String>] [-Parameters <Hashtable>] [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
Send-PSUEvent -ComputerGroup <String> [-Data <Object>] [-ScriptBlock <ScriptBlock>] [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
Send-PSUEvent -ComputerGroup <String> [-Command <String>] [-Parameters <Hashtable>] [-Timeout <Int32>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]

DESCRIPTION

Sends serialized data or requests command execution on connected agents. Select an event hub with -Hub, one agent with -Computer, or a group with -ComputerGroup. For an agent, use -ScriptBlock for a script invocation or -Command and -Parameters for a module command; these options belong to different parameter sets. -Timeout defaults to 30 seconds. Invoke-PSUCommand is an alias.

EXAMPLES

Send-PSUEvent -Hub 'MyHub' -Data @{ Name = 'Adam' }
Send-PSUEvent -ComputerGroup 'Build agents' -Command 'Get-Process' -Parameters @{ Name = 'pwsh' } -Timeout 30

PARAMETERS

Parameter	Description
-Hub	Event hub name; event data goes to all connections unless -ConnectionId is supplied.
-ConnectionId	Send to a specific connection on the hub.
-Computer	Target a connected computer.
-ComputerGroup	Target a connected computer group.
-Data	Object to serialize and send to a hub or computer.
-ScriptBlock	Script to run on a computer or computer group.
-Command	Module command to run on a computer, group, or hub.
-Parameters	Hashtable of parameters passed to -Command.
-Timeout	Time in seconds to wait for the result; default is 30.
-ComputerName	PSU server URL for a remote management connection; alias: -Uri.
-AppToken	App token for a remote management connection.
-Credential	Credentials for the management API.
-UseDefaultCredentials	Use the current Windows credentials for the management connection.
-Integrated	Use the in-process PSU management client when the cmdlet runs inside PSU.
-TrustCertificate	Allow a remote connection with an untrusted TLS certificate.
-Cookies	Reuse and persist authentication cookies in this PowerShell session.

PERMISSIONS

The access token requires apis.eventhubs/execute to run this cmdlet remotely. This also applies when the command targets a computer or computer group.