New-FilesAiTask
Create Ai Task.
Syntax
Description
Create Ai Task.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.
Examples
Example 1: Create Ai Task
Writes the ai task returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Description
AI Task description.
- Type:
System.String - Parameter sets:
(All)
-Disabled
If true, this AI Task will not run.
- Type:
System.Boolean - Parameter sets:
(All)
-HolidayRegion
Optional holiday region used by the AI Task schedule.
- Type:
System.String - Parameter sets:
(All)
-Interval
If trigger is daily, this specifies how often to run the AI Task.
- Type:
System.String - Parameter sets:
(All)
-Name
AI Task name.
- Type:
System.String - Parameter sets:
(All)(required)
-Path
Path scope used for action-triggered AI Tasks.
- Type:
System.String - Parameter sets:
(All)
-PermissionSet
Permissions used by the internal API key for this AI Task. Valid values are full and files_only.
- Type:
System.String - Parameter sets:
(All)
-Prompt
Prompt sent when this AI Task is invoked.
- Type:
System.String - Parameter sets:
(All)(required)
-RecurringDay
If trigger is daily, this selects the day number inside the chosen interval.
- Type:
System.Int64 - Parameter sets:
(All)
-RecurringDays
If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
- Type:
System.Int64[] - Parameter sets:
(All)
-ScheduleId
If trigger is custom_schedule, the reusable Schedule used instead of the AI Task's schedule fields.
- Type:
System.Int64 - Parameter sets:
(All)
-ScheduleDaysOfWeek
If trigger is custom_schedule, the 0-based weekdays used by the schedule.
- Type:
System.Int64[] - Parameter sets:
(All)
-ScheduleTimeZone
Time zone used by the AI Task schedule.
- Type:
System.String - Parameter sets:
(All)
-ScheduleTimesOfDay
Times of day in HH:MM format for the AI Task schedule.
- Type:
System.String[] - Parameter sets:
(All)
-Source
Source glob used with path for action-triggered AI Tasks.
- Type:
System.String - Parameter sets:
(All)
-Trigger
How this AI Task is triggered.
- Type:
System.String - Parameter sets:
(All)
-TriggerActions
If trigger is action, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
- Type:
System.String[] - Parameter sets:
(All)
-WorkspaceId
Workspace ID. 0 means the default workspace.
- Type:
System.Int64 - Parameter sets:
(All)
-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: High. At the default
$ConfirmPreferenceofHigh, the command asks before each change;-Confirm:$falseruns it without asking.
-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.AiTask: the ai task 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.