Get-MgSiteListItemDelta
Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection. Your app begins by calling delta without any parameters.The service starts enumerating the hierarchy of the list, returning pages of items, and either an @odata.nextLink or an @odata.deltaLink.Your app should continue calling with the @odata.nextLink until you see an @odata.deltaLink returned. After you received all the changes, you can apply them to your local state.To check for changes in the future, call delta again with the @odata.deltaLink from the previous response. The delta feed shows the latest state for each item, not each change. If an item was renamed twice, it only shows up once, with its latest name.The same item might appear more than once in a delta feed, for various reasons. You should use the last occurrence you see. Items with this property should be removed from your local state.
Note
To view the beta release of this cmdlet, view Get-MgBetaSiteListItemDelta
Syntax
Get-MgSiteListItemDelta
-ListId <String>
-SiteId <String>
[-ExpandProperty <String[]>]
[-Filter <String>]
[-Property <String[]>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-MgSiteListItemDelta
-ListId <String>
-SiteId <String>
-Token <String>
[-ExpandProperty <String[]>]
[-Filter <String>]
[-Property <String[]>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-MgSiteListItemDelta
-InputObject <ISitesIdentity>
[-ExpandProperty <String[]>]
[-Filter <String>]
[-Property <String[]>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-Count]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-MgSiteListItemDelta
-InputObject <ISitesIdentity>
[-ExpandProperty <String[]>]
[-Filter <String>]
[-Property <String[]>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-Count]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Description
Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection. Your app begins by calling delta without any parameters.The service starts enumerating the hierarchy of the list, returning pages of items, and either an @odata.nextLink or an @odata.deltaLink.Your app should continue calling with the @odata.nextLink until you see an @odata.deltaLink returned. After you received all the changes, you can apply them to your local state.To check for changes in the future, call delta again with the @odata.deltaLink from the previous response. The delta feed shows the latest state for each item, not each change. If an item was renamed twice, it only shows up once, with its latest name.The same item might appear more than once in a delta feed, for various reasons. You should use the last occurrence you see. Items with this property should be removed from your local state.
Permissions
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Sites.Read.All, Sites.ReadWrite.All, |
Delegated (personal Microsoft account) | Not supported |
Application | Sites.Read.All, Sites.ReadWrite.All, |
Examples
Example 1: Initial request
Import-Module Microsoft.Graph.Sites
Get-MgSiteListItemDelta -SiteId $siteId -ListId $listId
This example will initial request
Example 2: Last page request
Import-Module Microsoft.Graph.Sites
Get-MgSiteListItemDelta -SiteId $siteId -ListId $listId -Token "1230919asd190410jlka"
This example will last page request
Example 3: Delta link request
Import-Module Microsoft.Graph.Sites
Get-MgSiteListItemDelta -SiteId $siteId -ListId $listId -Token "latest"
This example will delta link request
Parameters
-All
List all pages.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Count
Include count of items
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
Type: | String |
Aliases: | CV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExpandProperty
Expand related entities
Type: | String[] |
Aliases: | Expand |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
Filter items by property values
Type: | String |
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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | ISitesIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ListId
The unique identifier of list
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PageSize
Sets the page size of results.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
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 |
-Property
Select properties to be returned
Type: | String[] |
Aliases: | Select |
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 |
-Search
Search items by search phrases
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SiteId
The unique identifier of site
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Skip
Skip the first n items
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Sort
Order items by property values
Type: | String[] |
Aliases: | OrderBy |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Token
Usage: token='{token}'
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Top
Show only the first n items
Type: | Int32 |
Aliases: | Limit |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.ISitesIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphListItem
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 <ISitesIdentity>
: Identity Parameter
[BaseItemId <String>]
: The unique identifier of baseItem[BaseSitePageId <String>]
: The unique identifier of baseSitePage[ColumnDefinitionId <String>]
: The unique identifier of columnDefinition[ColumnLinkId <String>]
: The unique identifier of columnLink[ContentTypeId <String>]
: The unique identifier of contentType[ContentTypeId1 <String>]
: The unique identifier of contentType[DocumentSetVersionId <String>]
: The unique identifier of documentSetVersion[DriveId <String>]
: The unique identifier of drive[EndDateTime <String>]
: Usage: endDateTime='{endDateTime}'[GroupId <String>]
: The unique identifier of group[GroupId1 <String>]
: The unique identifier of group[HorizontalSectionColumnId <String>]
: The unique identifier of horizontalSectionColumn[HorizontalSectionId <String>]
: The unique identifier of horizontalSection[IncludePersonalNotebooks <Boolean?>]
: Usage: includePersonalNotebooks={includePersonalNotebooks}[Interval <String>]
: Usage: interval='{interval}'[ItemActivityId <String>]
: The unique identifier of itemActivity[ItemActivityStatId <String>]
: The unique identifier of itemActivityStat[ListId <String>]
: The unique identifier of list[ListItemId <String>]
: The unique identifier of listItem[ListItemVersionId <String>]
: The unique identifier of listItemVersion[NotebookId <String>]
: The unique identifier of notebook[OnenoteOperationId <String>]
: The unique identifier of onenoteOperation[OnenotePageId <String>]
: The unique identifier of onenotePage[OnenoteResourceId <String>]
: The unique identifier of onenoteResource[OnenoteSectionId <String>]
: The unique identifier of onenoteSection[Path <String>]
: Usage: path='{path}'[PermissionId <String>]
: The unique identifier of permission[RelationId <String>]
: The unique identifier of relation[RichLongRunningOperationId <String>]
: The unique identifier of richLongRunningOperation[SectionGroupId <String>]
: The unique identifier of sectionGroup[SectionGroupId1 <String>]
: The unique identifier of sectionGroup[SetId <String>]
: The unique identifier of set[SetId1 <String>]
: The unique identifier of set[SiteId <String>]
: The unique identifier of site[SiteId1 <String>]
: The unique identifier of site[StartDateTime <String>]
: Usage: startDateTime='{startDateTime}'[StoreId <String>]
: The unique identifier of store[SubscriptionId <String>]
: The unique identifier of subscription[TermId <String>]
: The unique identifier of term[TermId1 <String>]
: The unique identifier of term[Token <String>]
: Usage: token='{token}'[UserId <String>]
: The unique identifier of user[WebPartId <String>]
: The unique identifier of webPart