Set-FilesGroup
Update Group.
Syntax
Id (Default)
InputObject
Description
Update Group.
The command accepts groups 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. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.
Examples
Example 1: Update Group
Writes the group as Files.com returns it.
Example 2: Act on groups from the pipeline
Takes the group 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
Group ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-Notes
Group notes.
- Type:
System.String - Parameter sets:
Id,InputObject
-UserIds
A list of user ids. If sent as a string, should be comma-delimited. Give the values as an array; the module joins them as the API expects.
- Type:
System.Int64[] - Parameter sets:
Id,InputObject
-AdminIds
A list of group admin user ids. If sent as a string, should be comma-delimited. Give the values as an array; the module joins them as the API expects.
- Type:
System.Int64[] - Parameter sets:
Id,InputObject
-AiAssistantPersonalityId
AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-FtpPermission
If true, users in this group can use FTP to login. This will override a false value of ftp_permission on the user level.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SftpPermission
If true, users in this group can use SFTP to login. This will override a false value of sftp_permission on the user level.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-DavPermission
If true, users in this group can use WebDAV to login. This will override a false value of dav_permission on the user level.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-RestapiPermission
If true, users in this group can use the REST API to login. This will override a false value of restapi_permission on the user level.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-S3CompatibleEndpointPermission
If true, users in this group can access the S3-compatible endpoint. This will override a false value of s3_compatible_endpoint_permission on the user level. Defaults to false.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-DesktopConfigurationProfileId
Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-IntegrationCentricProfileId
Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-AllowedIps
A list of allowed IPs if applicable. Newline delimited Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-Name
Group name.
- Type:
System.String - Parameter sets:
Id,InputObject
-InputObject
The group 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.Group - 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: 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
FilesCom.PowerShell.Models.Group: a group from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.Group: the group 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.