New-FilesEventTarget

Create Event Target.

Syntax

New-FilesEventTarget -Name <System.String> [-WorkspaceId <System.Int64>] [-ApplyToAllWorkspaces <System.Boolean>] [-Enabled <System.Boolean>] -Config <System.Collections.IDictionary> [-DeliveryPolicy <System.Collections.IDictionary>] -TargetType <System.String> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Event Target.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Create Event Target

New-FilesEventTarget -Name 'example' -Config @{ } -TargetType 'example' -WorkspaceId 1 -ApplyToAllWorkspaces $true

Writes the event target returned.

Example 2: Preview the change

New-FilesEventTarget -Name 'example' -Config @{ } -TargetType 'example' -WorkspaceId 1 -ApplyToAllWorkspaces $true -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Name

Event Target name.

  • Type: System.String
  • Parameter sets: (All) (required)

-WorkspaceId

Workspace ID. 0 means the default workspace or site-wide.

  • Type: System.Int64
  • Parameter sets: (All)

-ApplyToAllWorkspaces

If true, this default-workspace target can receive events from all workspaces.

  • Type: System.Boolean
  • Parameter sets: (All)

-Enabled

Whether this Event Target can receive events.

  • Type: System.Boolean
  • Parameter sets: (All)

-Config

Event Target configuration. Folder targets accept path and format (json or csv). Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • Parameter sets: (All) (required)

-DeliveryPolicy

Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400. Slack and Teams support delivery_mode (immediate or subfolder_summary), summary_path (empty string means root), and summary_delay (15–300 seconds, default 60). The summary applies to matching file activity under summary_path; other matching events retain immediate delivery. Give a hashtable or PSCustomObject; keys keep their case and values their types.

  • Type: System.Collections.IDictionary
  • Parameter sets: (All)

-TargetType

Event Target type.

  • Type: System.String
  • Parameter sets: (All) (required)

-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)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

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.EventTarget: the event target as Files.com returned it.

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.