New-MgUserTodoList
Create new navigation property to lists for users
Note
To view the beta release of this cmdlet, view New-MgBetaUserTodoList
Syntax
New-MgUserTodoList
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-DisplayName <String>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-Id <String>]
[-IsOwner]
[-IsShared]
[-Tasks <IMicrosoftGraphTodoTask[]>]
[-WellknownListName <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgUserTodoList
-UserId <String>
-BodyParameter <IMicrosoftGraphTodoTaskList>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgUserTodoList
-InputObject <IUsersIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-DisplayName <String>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-Id <String>]
[-IsOwner]
[-IsShared]
[-Tasks <IMicrosoftGraphTodoTask[]>]
[-WellknownListName <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgUserTodoList
-InputObject <IUsersIdentity>
-BodyParameter <IMicrosoftGraphTodoTaskList>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create new navigation property to lists for users
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Users
$params = @{
displayName = "Travel items"
}
# A UPN can also be used as -UserId.
New-MgUserTodoList -UserId $userId -BodyParameter $paramsThis example shows how to use the New-MgUserTodoList Cmdlet.
To learn about permissions for this resource, see the permissions reference.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
todoTaskList To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphTodoTaskList |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
The name of the task list.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Extensions
The collection of open extensions defined for the task list. Nullable. To construct, see NOTES section for EXTENSIONS properties and create a hash table.
| Type: | IMicrosoftGraphExtension[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IUsersIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsOwner
True if the user is owner of the given task list.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsShared
True if the task list is shared with other users
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tasks
The tasks in this task list. Read-only. Nullable. To construct, see NOTES section for TASKS properties and create a hash table.
| Type: | IMicrosoftGraphTodoTask[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserId
The unique identifier of user
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WellknownListName
wellknownListName
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTodoTaskList
Microsoft.Graph.PowerShell.Models.IUsersIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTodoTaskList
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.
BODYPARAMETER <IMicrosoftGraphTodoTaskList>: todoTaskList
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[DisplayName <String>]: The name of the task list.[Extensions <IMicrosoftGraphExtension-[]>]: The collection of open extensions defined for the task list. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.
[IsOwner <Boolean?>]: True if the user is owner of the given task list.[IsShared <Boolean?>]: True if the task list is shared with other users[Tasks <IMicrosoftGraphTodoTask-[]>]: The tasks in this task list. Read-only. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.[AttachmentSessions <IMicrosoftGraphAttachmentSession-[]>]:[Id <String>]: The unique identifier for an entity. Read-only.[Content <Byte-[]>]: The content streams that are uploaded.[ExpirationDateTime <DateTime?>]: The date and time in UTC when the upload session will expire. The complete file must be uploaded before this expiration time is reached.[NextExpectedRanges <String-[]>]: Indicates a single value {start} that represents the location in the file where the next upload should begin.
[Attachments <IMicrosoftGraphAttachmentBase-[]>]: A collection of file attachments for the task.[Id <String>]: The unique identifier for an entity. Read-only.[ContentType <String>]: The MIME type.[LastModifiedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Name <String>]: The display name of the attachment. This doesn't need to be the actual file name.[Size <Int32?>]: The length of the attachment in bytes.
[Body <IMicrosoftGraphItemBody>]: itemBody[(Any) <Object>]: This indicates any property can be added to this object.[Content <String>]: The content of the item.[ContentType <String>]: bodyType
[BodyLastModifiedDateTime <DateTime?>]: The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[Categories <String-[]>]: The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.[ChecklistItems <IMicrosoftGraphChecklistItem-[]>]: A collection of checklistItems linked to a task.[Id <String>]: The unique identifier for an entity. Read-only.[CheckedDateTime <DateTime?>]: The date and time when the checklistItem was finished.[CreatedDateTime <DateTime?>]: The date and time when the checklistItem was created.[DisplayName <String>]: Indicates the title of the checklistItem.[IsChecked <Boolean?>]: State that indicates whether the item is checked off or not.
[CompletedDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[(Any) <Object>]: This indicates any property can be added to this object.[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
[CreatedDateTime <DateTime?>]: The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[DueDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[Extensions <IMicrosoftGraphExtension-[]>]: The collection of open extensions defined for the task. Nullable.[HasAttachments <Boolean?>]: Indicates whether the task has attachments.[Importance <String>]: importance[IsReminderOn <Boolean?>]: Set to true if an alert is set to remind the user of the task.[LastModifiedDateTime <DateTime?>]: The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[LinkedResources <IMicrosoftGraphLinkedResource-[]>]: A collection of resources linked to the task.[Id <String>]: The unique identifier for an entity. Read-only.[ApplicationName <String>]: The app name of the source that sends the linkedResource.[DisplayName <String>]: The title of the linkedResource.[ExternalId <String>]: ID of the object that is associated with this task on the third-party/partner system.[WebUrl <String>]: Deep link to the linkedResource.
[Recurrence <IMicrosoftGraphPatternedRecurrence>]: patternedRecurrence[(Any) <Object>]: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]: recurrencePattern[(Any) <Object>]: This indicates any property can be added to this object.[DayOfMonth <Int32?>]: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-[]>]: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]: dayOfWeek[Index <String>]: weekIndex[Interval <Int32?>]: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]: recurrenceRange[(Any) <Object>]: This indicates any property can be added to this object.[EndDate <DateTime?>]: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]: recurrenceRangeType
[ReminderDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[StartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[Status <String>]: taskStatus[Title <String>]: A brief description of the task.
[WellknownListName <String>]: wellknownListName
EXTENSIONS <IMicrosoftGraphExtension- []>: The collection of open extensions defined for the task list.
Nullable.
[Id <String>]: The unique identifier for an entity. Read-only.
INPUTOBJECT <IUsersIdentity>: Identity Parameter
[AttachmentBaseId <String>]: The unique identifier of attachmentBase[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[OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant[OutlookCategoryId <String>]: The unique identifier of outlookCategory[ProfilePhotoId <String>]: The unique identifier of profilePhoto[ServiceStorageQuotaBreakdownId <String>]: The unique identifier of serviceStorageQuotaBreakdown[SharedInsightId <String>]: The unique identifier of sharedInsight[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[WindowsSettingId <String>]: The unique identifier of windowsSetting[WindowsSettingInstanceId <String>]: The unique identifier of windowsSettingInstance
TASKS <IMicrosoftGraphTodoTask- []>: The tasks in this task list.
Read-only.
Nullable.
[Id <String>]: The unique identifier for an entity. Read-only.[AttachmentSessions <IMicrosoftGraphAttachmentSession-[]>]:[Id <String>]: The unique identifier for an entity. Read-only.[Content <Byte-[]>]: The content streams that are uploaded.[ExpirationDateTime <DateTime?>]: The date and time in UTC when the upload session will expire. The complete file must be uploaded before this expiration time is reached.[NextExpectedRanges <String-[]>]: Indicates a single value {start} that represents the location in the file where the next upload should begin.
[Attachments <IMicrosoftGraphAttachmentBase-[]>]: A collection of file attachments for the task.[Id <String>]: The unique identifier for an entity. Read-only.[ContentType <String>]: The MIME type.[LastModifiedDateTime <DateTime?>]: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Name <String>]: The display name of the attachment. This doesn't need to be the actual file name.[Size <Int32?>]: The length of the attachment in bytes.
[Body <IMicrosoftGraphItemBody>]: itemBody[(Any) <Object>]: This indicates any property can be added to this object.[Content <String>]: The content of the item.[ContentType <String>]: bodyType
[BodyLastModifiedDateTime <DateTime?>]: The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[Categories <String-[]>]: The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.[ChecklistItems <IMicrosoftGraphChecklistItem-[]>]: A collection of checklistItems linked to a task.[Id <String>]: The unique identifier for an entity. Read-only.[CheckedDateTime <DateTime?>]: The date and time when the checklistItem was finished.[CreatedDateTime <DateTime?>]: The date and time when the checklistItem was created.[DisplayName <String>]: Indicates the title of the checklistItem.[IsChecked <Boolean?>]: State that indicates whether the item is checked off or not.
[CompletedDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[(Any) <Object>]: This indicates any property can be added to this object.[DateTime <String>]: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).[TimeZone <String>]: Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
[CreatedDateTime <DateTime?>]: The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[DueDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[Extensions <IMicrosoftGraphExtension-[]>]: The collection of open extensions defined for the task. Nullable.[Id <String>]: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]: Indicates whether the task has attachments.[Importance <String>]: importance[IsReminderOn <Boolean?>]: Set to true if an alert is set to remind the user of the task.[LastModifiedDateTime <DateTime?>]: The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[LinkedResources <IMicrosoftGraphLinkedResource-[]>]: A collection of resources linked to the task.[Id <String>]: The unique identifier for an entity. Read-only.[ApplicationName <String>]: The app name of the source that sends the linkedResource.[DisplayName <String>]: The title of the linkedResource.[ExternalId <String>]: ID of the object that is associated with this task on the third-party/partner system.[WebUrl <String>]: Deep link to the linkedResource.
[Recurrence <IMicrosoftGraphPatternedRecurrence>]: patternedRecurrence[(Any) <Object>]: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]: recurrencePattern[(Any) <Object>]: This indicates any property can be added to this object.[DayOfMonth <Int32?>]: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-[]>]: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]: dayOfWeek[Index <String>]: weekIndex[Interval <Int32?>]: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]: recurrenceRange[(Any) <Object>]: This indicates any property can be added to this object.[EndDate <DateTime?>]: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]: recurrenceRangeType
[ReminderDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[StartDateTime <IMicrosoftGraphDateTimeZone>]: dateTimeTimeZone[Status <String>]: taskStatus[Title <String>]: A brief description of the task.
RELATED LINKS
https://learn.microsoft.com/powershell/module/microsoft.graph.users/new-mgusertodolist