New-FilesShareGroup

Create Share Group.

Syntax

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

Description

Create Share Group.

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 Share Group

New-FilesShareGroup -Name 'Test group 1' -Members @(@{ }) -Notes 'This group is defined for testing purposes'

Writes the share group returned.

Example 2: Preview the change

New-FilesShareGroup -Name 'Test group 1' -Members @(@{ }) -Notes 'This group is defined for testing purposes' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-UserId

User ID. Provide a value of 0 to operate the current session's user.

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

-Notes

Additional notes of the share group

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

-Name

Name of the share group

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

-Members

A list of share group members.

  • Type: System.Collections.IDictionary[]
  • 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.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.