Complete-MgBetaUserOutlookTask
Complete an Outlook task which sets the completedDateTime property to the current date, and the status property to completed. If you are completing a task in a recurring series, in the response, the task collection will contain the completed task in the series, and the next task in the series. The completedDateTime property represents the date when the task is finished. The time portion of completedDateTime is set to midnight UTC by default. By default, this operation (and the POST, GET, and PATCH task operations) returns date-related properties in UTC. You can use the Prefer: outlook.timezone header to have all the date-related properties in the response represented in a time zone different than UTC.
Syntax
Complete (Default)
Complete-MgBetaUserOutlookTask
-OutlookTaskId <String>
-UserId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CompleteViaIdentity
Complete-MgBetaUserOutlookTask
-InputObject <IUsersIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Complete an Outlook task which sets the completedDateTime property to the current date, and the status property to completed. If you are completing a task in a recurring series, in the response, the task collection will contain the completed task in the series, and the next task in the series. The completedDateTime property represents the date when the task is finished. The time portion of completedDateTime is set to midnight UTC by default. By default, this operation (and the POST, GET, and PATCH task operations) returns date-related properties in UTC. You can use the Prefer: outlook.timezone header to have all the date-related properties in the response represented in a time zone different than UTC.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Tasks.ReadWrite, |
| Delegated (personal Microsoft account) | Tasks.ReadWrite, |
| Application | Not supported |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Users
# A UPN can also be used as -UserId.
Complete-MgBetaUserOutlookTask -UserId $userId -OutlookTaskId $outlookTaskId
This example shows how to use the Complete-MgBetaUserOutlookTask Cmdlet.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | IDictionary |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IUsersIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CompleteViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutlookTaskId
The unique identifier of outlookTask
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Complete
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserId
The unique identifier of user
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Complete
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IUsersIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOutlookTask
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IUsersIdentity>: Identity Parameter
[AppId <String>]: Alternate key of servicePrincipal[AttachmentBaseId <String>]: The unique identifier of attachmentBase[AttachmentId <String>]: The unique identifier of attachment[AttachmentSessionId <String>]: The unique identifier of attachmentSession[ChecklistItemId <String>]: The unique identifier of checklistItem[DirectoryObjectId <String>]: The unique identifier of directoryObject[ExtensionId <String>]: The unique identifier of extension[LicenseDetailsId <String>]: The unique identifier of licenseDetails[LinkedResourceId <String>]: The unique identifier of linkedResource[NotificationId <String>]: The unique identifier of notification[OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant[OutlookCategoryId <String>]: The unique identifier of outlookCategory[OutlookTaskFolderId <String>]: The unique identifier of outlookTaskFolder[OutlookTaskGroupId <String>]: The unique identifier of outlookTaskGroup[OutlookTaskId <String>]: The unique identifier of outlookTask[ProfilePhotoId <String>]: The unique identifier of profilePhoto[ServicePrincipalId <String>]: The unique identifier of servicePrincipal[ServiceStorageQuotaBreakdownId <String>]: The unique identifier of serviceStorageQuotaBreakdown[SharedInsightId <String>]: The unique identifier of sharedInsight[TimeZoneStandard <String>]: Usage: TimeZoneStandard='{TimeZoneStandard}'[TodoTaskId <String>]: The unique identifier of todoTask[TodoTaskListId <String>]: The unique identifier of todoTaskList[TrendingId <String>]: The unique identifier of trending[UsedInsightId <String>]: The unique identifier of usedInsight[UserId <String>]: The unique identifier of user[UserPrincipalName <String>]: Alternate key of user[WindowsSettingId <String>]: The unique identifier of windowsSetting[WindowsSettingInstanceId <String>]: The unique identifier of windowsSettingInstance