< Back

Set-AMSharePointCondition

Sat Jan 11, 2020 3:34 am

NAME Set-AMSharePointCondition



SYNOPSIS

Sets properties of an AutoMate Enterprise SharePoint condition.





SYNTAX

Set-AMSharePointCondition [-InputObject] <Object> [[-SiteURL] <String>] [[-Scope] {Web | List}] [[-List] <String>]

[-ItemAdded] [-ItemUpdated] [-ItemDeleted] [-ItemCheckedIn] [-ItemCheckedOut] [-ItemUncheckedOut] [-ItemFileMoved]

[-ItemAttachmentAdded] [-ItemAttachmentDeleted] [-FieldAdded] [-FieldUpdated] [-FieldDeleted] [-WorkflowStarted]

[-WorkflowPostponed] [-WorkflowCompleted] [-ListAdded] [-ListDeleted] [-GroupAdded] [-GroupUpdated]

[-GroupDeleted] [-GroupUserAdded] [-GroupUserDeleted] [-RoleDefinitionAdded] [-RoleDefinitionUpdated]

[-RoleDefinitionDeleted] [-RoleAssignmentAdded] [-RoleAssignmentDeleted] [[-UserMode] {NoUser | DefaultUser |

SpecifiedUser}] [[-UserName] <String>] [[-Domain] <String>] [-Wait] [[-Timeout] <Int32>] [[-TimeoutUnit] {Seconds

| Minutes | Hours | Days | Milliseconds}] [[-TriggerAfter] <Int32>] [[-Notes] <String>] [[-CompletionState]

{InDevelopment | Testing | Production | Archive}] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Set-AMIdleCondition modifies an existing SharePoint condition.





PARAMETERS

-InputObject <Object>

The condition to modify.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-SiteURL <String>

The SharePoint site URL in which to monitor.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Scope

The SharePoint range to monitor: Web or List.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-List <String>

The title of the list to monitor. This parameter is available only if the Scope parameter is set to List.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ItemAdded [<SwitchParameter>]

If set to YES, the condition will monitor for items to be added to the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemUpdated [<SwitchParameter>]

If set to YES, the condition will monitor for items to be updated in the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for items to be deleted from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemCheckedIn [<SwitchParameter>]

If set to YES, the condition will monitor for items to be checked in the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemCheckedOut [<SwitchParameter>]

If set to YES, the condition will monitor for items to be checked out of the site/list. If you check out an

item, you will reserve it for your use so that others cannot change it while you are working on it.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemUncheckedOut [<SwitchParameter>]

If set to YES, the condition will monitor for items to be unchecked out (also known as discarded checkout)

from the site/list. You can uncheck out an item if you want it to go back to the way it was before you checked

it out. This will undo all of the changes that you made to the item



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemFileMoved [<SwitchParameter>]

If set to YES, the condition will monitor for a file that is represented by an item from a document library to

be moved from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemAttachmentAdded [<SwitchParameter>]

If set to YES, the condition will monitor for an attachment to be added to a list item in the specified

site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ItemAttachmentDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for an attachment to be deleted from a list item in the specified

site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-FieldAdded [<SwitchParameter>]

If set to YES, the condition will monitor for a field to be added to the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-FieldUpdated [<SwitchParameter>]

If set to YES, the condition will monitor for a field to be updated in the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-FieldDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for a field to be deleted from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WorkflowStarted [<SwitchParameter>]

If set to YES, the condition will monitor for a SharePoint workflow to be started from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WorkflowPostponed [<SwitchParameter>]

If set to YES, the condition will monitor for a SharePoint workflow to be postponed from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WorkflowCompleted [<SwitchParameter>]

If set to YES, the condition will monitor for a SharePoint workflow to be completed from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ListAdded [<SwitchParameter>]

If set to YES, the condition will monitor for a list to be added to the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-ListDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for a list to be deleted from the site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-GroupAdded [<SwitchParameter>]

If set to YES, the condition will monitor for a group to be added to the specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-GroupUpdated [<SwitchParameter>]

If set to YES, the condition will monitor for a group to be updated in the specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-GroupDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for a group to be deleted from the specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-GroupUserAdded [<SwitchParameter>]

If set to YES, the condition will monitor for a user to be added to a group in the specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-GroupUserDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for a user to be deleted from a group in the specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-RoleDefinitionAdded [<SwitchParameter>]

If set to YES, the condition will monitor for a role definition (or permission level) to be added to an item

in the specified site/list. A role definition is a collection of rights bound to a specific item.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-RoleDefinitionUpdated [<SwitchParameter>]

If set to YES, the condition will monitor for a role definition (or permission level) to be updated in the

specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-RoleDefinitionDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for a role definition (or permission level) to be deleted from an

item in the specified site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-RoleAssignmentAdded [<SwitchParameter>]

If set to YES, the condition will monitor for a role assignment to be added to an item in the specified

site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-RoleAssignmentDeleted [<SwitchParameter>]

If set to YES, the condition will monitor for a role assignment to be deleted from an item in the specified

site/list.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UserMode

Specify to use the default agent user (DefaultUser) or a specified user (SpecifiedUser).



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserName <String>

The username used to authenticate with the database.



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Domain <String>

The domain for the specified user.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Wait [<SwitchParameter>]

Wait for the condition, or evaluate immediately.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Timeout <Int32>

If wait is specified, the amount of time before the condition times out.



Required? false

Position? 8

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-TimeoutUnit

The unit for Timeout (Seconds by default).



Required? false

Position? 9

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TriggerAfter <Int32>

The number of times the condition should occur before the trigger fires.



Required? false

Position? 10

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Notes <String>

The new notes to set on the object.



Required? false

Position? 11

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CompletionState

The completion state (staging level) to set on the object.



Required? false

Position? 12

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS

https://github.com/AutomatePS/AutomatePS