Set-FilesPartner
Update Partner.
Syntax
Id (Default)
InputObject
Description
Update Partner.
The command accepts partners 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 Partner
Writes the partner as Files.com returns it.
Example 2: Act on partners from the pipeline
Takes the partner 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
Partner ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-AiAssistantPersonalityId
AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-AllowedIps
A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists. Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-AllowBypassing2faPolicies
Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-AllowCredentialChanges
Allow Partner Admins to change or reset credentials for users belonging to this Partner.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-AllowProvidingGpgKeys
Allow Partner Admins to provide GPG keys.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-AllowUserCreation
Allow Partner Admins to create users.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-CcEmailsToResponsibleParty
When true, emails sent to Partner users are copied to the responsible User or Group.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Notes
Notes about this Partner.
- Type:
System.String - Parameter sets:
Id,InputObject
-PartnerChannelTemplateId
ID of the Partner Channel Template assigned to this Partner.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-ResponsibleGroupId
ID of the Group responsible for this Partner.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-ResponsibleUserId
ID of the User responsible for this Partner.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-ShowPartnerChannelHomePage
Show Partner users a simplified home page built from this Partner's Channels.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Tags
Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens. Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
Id,InputObject
-Name
The name of the Partner.
- Type:
System.String - Parameter sets:
Id,InputObject
-PartnershipRole
This site's role for this Partner in Connected Sites relationships. host is a Partner this site configured. guest is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. host_and_guest is a configured Partner that is also the guest side of a connection. Promote a guest Partner by setting this to host_and_guest together with a root_folder.
- Type:
System.String - Parameter sets:
Id,InputObject
-RootFolder
The root folder path for this Partner.
- Type:
System.String - Parameter sets:
Id,InputObject
-InputObject
The partner 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.Partner - 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.Partner: a partner from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.Partner: the partner 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.