Set-FilesShareGroup

Update Share Group.

Syntax

Id (Default)

Set-FilesShareGroup [-Id] <System.Int64> [-Notes <System.String>] [-Name <System.String>] [-Members <System.Collections.IDictionary[]>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Set-FilesShareGroup [-Notes <System.String>] [-Name <System.String>] [-Members <System.Collections.IDictionary[]>] -InputObject <FilesCom.PowerShell.Models.ShareGroup> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Update Share Group.

The command accepts share 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.

Examples

Example 1: Update Share Group

Set-FilesShareGroup -Id 1 -Notes 'This group is defined for testing purposes' -Name 'Test group 1'

Writes the share group as Files.com returns it.

Example 2: Act on share groups from the pipeline

Get-FilesShareGroup -Id 1 | Set-FilesShareGroup -Notes 'This group is defined for testing purposes' -Name 'Test group 1'

Takes the share group from the pipeline and uses its Id and connection.

Example 3: Preview the change

Set-FilesShareGroup -Id 1 -Notes 'This group is defined for testing purposes' -Name 'Test group 1' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Id

Share Group ID.

  • Type: System.Int64
  • Parameter sets: Id (required, position 0)

-Notes

Additional notes of the share group

  • Type: System.String
  • Parameter sets: Id, InputObject

-Name

Name of the share group

  • Type: System.String
  • Parameter sets: Id, InputObject

-Members

A list of share group members.

  • Type: System.Collections.IDictionary[]
  • Parameter sets: Id, InputObject

-InputObject

The share 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.ShareGroup
  • 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 $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

  • FilesCom.PowerShell.Models.ShareGroup: a share group from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.ShareGroup: the share 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.