Set-FilesScheduledExport
Update Scheduled Export.
Syntax
Id (Default)
InputObject
Description
Update Scheduled Export.
The command accepts scheduled exports from the pipeline as -InputObject, and uses each one's Id and the connection that fetched it.
When given -InputObject, the command updates that object with the values Files.com returns and writes it.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Update Scheduled Export
Writes the scheduled export as Files.com returns it.
Example 2: Act on scheduled exports from the pipeline
Takes the scheduled export from the pipeline and uses its Id and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Id
Scheduled Export ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Name
Name for this scheduled export.
- Type:
System.String - Parameter sets:
Id,InputObject
-ExportType
Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit
- Type:
System.String - Parameter sets:
Id,InputObject
-ExportOptions
Report-specific options. permission_audit supports group_by with user or path. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
Id,InputObject
-UserId
Site Admin user who receives the completed export e-mail.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-Disabled
If true, this scheduled export will not run.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Trigger
Schedule trigger type: daily or custom_schedule.
- Type:
System.String - Parameter sets:
Id,InputObject
-Interval
If trigger is daily, this specifies how often to run the scheduled export.
- Type:
System.String - Parameter sets:
Id,InputObject
-RecurringDay
If trigger is daily, this selects the day number inside the chosen interval.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-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:
Id,InputObject
-ScheduleId
If trigger is custom_schedule, the reusable Schedule used instead of the scheduled export's schedule fields.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-ScheduleDaysOfWeek
If trigger is custom_schedule, the 0-based weekdays used by the schedule.
- Type:
System.Int64[] - Parameter sets:
Id,InputObject
-ScheduleTimesOfDay
Times of day in HH:MM format for the scheduled export schedule.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-ScheduleTimeZone
Time zone used by the scheduled export schedule.
- Type:
System.String - Parameter sets:
Id,InputObject
-HolidayRegion
Optional holiday region used by the scheduled export schedule.
- Type:
System.String - Parameter sets:
Id,InputObject
-InputObject
The scheduled export to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.ScheduledExport - Parameter sets:
InputObject(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
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes 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
FilesCom.PowerShell.Models.ScheduledExport: a scheduled export from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.ScheduledExport: the scheduled export 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.