Get-FilesSiemHttpDestinationEvent
List SIEM HTTP Destination Events, or get one siem http destination event by Id.
Syntax
List (Default)
Page
Continuation
Id
Description
List SIEM HTTP Destination Events.
Show SIEM HTTP Destination Event.
Without -Page or -Continuation, the command writes each siem http destination event of every page, loading one page at a time as the pipeline consumes them. -First and -Skip bound what it writes, and stopping the pipeline early, as Select-Object -First does, loads no further page. A failure on any page stops the command, so a partial listing is never taken for a complete one.
Examples
Example 1: List all siem http destination events
Writes every siem http destination event, loading one page at a time as the pipeline consumes them.
Example 2: Get one page at a time
Writes the first page as a FilesPage object, then the next page from its continuation.
Example 3: Get one siem http destination event
Writes the siem http destination event with that Id.
Parameters
-Cursor
Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
- Type:
System.String - Parameter sets:
List,Page
-PerPage
Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
- Type:
System.Int64 - Parameter sets:
List,Page
-SortBy
If set, sort records by the specified field in either asc or desc direction. Valid fields are created_at, status or siem_http_destination_id. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-Filter
If set, return records where the specified field is equal to the supplied value. Valid fields are created_at, siem_http_destination_id or status. Valid field combinations are [ siem_http_destination_id, created_at ], [ status, created_at ], [ siem_http_destination_id, status ] or [ siem_http_destination_id, status, created_at ]. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterGt
If set, return records where the specified field is greater than the supplied value. Valid fields are created_at. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterGteq
If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterLt
If set, return records where the specified field is less than the supplied value. Valid fields are created_at. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-FilterLteq
If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
List,Page
-Id
Siem Http Destination Event ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Page
Writes the first page as one FilesPage object instead of writing every object. Pass its Continuation to -Continuation for the next page.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
Page(required)
-Continuation
Writes the page after the one this continuation came from, as one FilesPage object. A continuation loads its page once and belongs to the command, query and connection that produced it.
- Type:
FilesCom.PowerShell.FilesContinuation - Parameter sets:
Continuation(required)
-First
Writes at most this many objects. Once they are written, no further page is loaded.
- Type:
System.UInt64 - Parameter sets:
(All)
-Skip
Skips this many objects before writing any. The skipped objects are still loaded.
- Type:
System.UInt64 - Parameter sets:
(All)
-IncludeTotalCount
Writes a total count first. Files.com does not report list totals, so the count is marked as unknown.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.SiemHttpDestinationEvent: the siem http destination event as Files.com returned it.FilesCom.PowerShell.FilesPage`1: with-Pageor-Continuation, one page of results and the continuation for the next.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.