Update-MgBetaDriveItemRetentionLabel
Apply (set) a retention label on a driveItem (files and folders). Retention labels don't need to be published in a retention label policy to be applied using this method. When a retention label is applied to a folder, all the items in the folder are tagged with the same retention label. For information about conflict resolution for retention labels, see Will an existing label be overridden or removed. For information about retention labels from an administrator's perspective, see Use retention labels to manage the lifecycle of documents stored in SharePoint.
Note
To view the v1.0 release of this cmdlet, view Update-MgDriveItemRetentionLabel
Syntax
Update-MgBetaDriveItemRetentionLabel
-DriveId <String>
-DriveItemId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Id <String>]
[-IsLabelAppliedExplicitly]
[-LabelAppliedBy <IMicrosoftGraphIdentitySet>]
[-LabelAppliedDateTime <DateTime>]
[-Name <String>]
[-RetentionSettings <IMicrosoftGraphRetentionLabelSettings>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaDriveItemRetentionLabel
-DriveId <String>
-DriveItemId <String>
-BodyParameter <IMicrosoftGraphItemRetentionLabel>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaDriveItemRetentionLabel
-InputObject <IFilesIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Id <String>]
[-IsLabelAppliedExplicitly]
[-LabelAppliedBy <IMicrosoftGraphIdentitySet>]
[-LabelAppliedDateTime <DateTime>]
[-Name <String>]
[-RetentionSettings <IMicrosoftGraphRetentionLabelSettings>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaDriveItemRetentionLabel
-InputObject <IFilesIdentity>
-BodyParameter <IMicrosoftGraphItemRetentionLabel>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Apply (set) a retention label on a driveItem (files and folders). Retention labels don't need to be published in a retention label policy to be applied using this method. When a retention label is applied to a folder, all the items in the folder are tagged with the same retention label. For information about conflict resolution for retention labels, see Will an existing label be overridden or removed. For information about retention labels from an administrator's perspective, see Use retention labels to manage the lifecycle of documents stored in SharePoint.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Files.ReadWrite.All | Sites.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Files.ReadWrite.All | Sites.ReadWrite.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Files
$params = @{
retentionSettings = @{
isRecordLocked = $true
}
}
Update-MgBetaDriveItemRetentionLabel -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params
This example shows how to use the Update-MgBetaDriveItemRetentionLabel Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
itemRetentionLabel To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphItemRetentionLabel |
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 |
-DriveId
The unique identifier of drive
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DriveItemId
The unique identifier of driveItem
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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: | IFilesIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IsLabelAppliedExplicitly
Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LabelAppliedBy
identitySet To construct, see NOTES section for LABELAPPLIEDBY properties and create a hash table.
Type: | IMicrosoftGraphIdentitySet |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LabelAppliedDateTime
The date and time when the label was applied on the item. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The retention label on the document. Read-write.
Type: | String |
Position: | Named |
Default value: | None |
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 |
-RetentionSettings
retentionLabelSettings To construct, see NOTES section for RETENTIONSETTINGS properties and create a hash table.
Type: | IMicrosoftGraphRetentionLabelSettings |
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.Beta.PowerShell.Models.IFilesIdentity
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphItemRetentionLabel
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphItemRetentionLabel
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 <IMicrosoftGraphItemRetentionLabel>
: itemRetentionLabel
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsLabelAppliedExplicitly <Boolean?>]
: Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only.[LabelAppliedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[LabelAppliedDateTime <DateTime?>]
: The date and time when the label was applied on the item. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.[Name <String>]
: The retention label on the document. Read-write.[RetentionSettings <IMicrosoftGraphRetentionLabelSettings>]
: retentionLabelSettings[(Any) <Object>]
: This indicates any property can be added to this object.[BehaviorDuringRetentionPeriod <String>]
: behaviorDuringRetentionPeriod[IsContentUpdateAllowed <Boolean?>]
: Specifies whether updates to document content are allowed. Read-only.[IsDeleteAllowed <Boolean?>]
: Specifies whether the document deletion is allowed. Read-only.[IsLabelUpdateAllowed <Boolean?>]
: Specifies whether you're allowed to change the retention label on the document. Read-only.[IsMetadataUpdateAllowed <Boolean?>]
: Specifies whether updates to the item metadata (for example, the Title field) are blocked. Read-only.[IsRecordLocked <Boolean?>]
: Specifies whether the item is locked. Read-write.
INPUTOBJECT <IFilesIdentity>
: Identity Parameter
[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[DriveItemId <String>]
: The unique identifier of driveItem[DriveItemId1 <String>]
: The unique identifier of driveItem[DriveItemVersionId <String>]
: The unique identifier of driveItemVersion[EndDateTime <String>]
: Usage: endDateTime='{endDateTime}'[GroupId <String>]
: The unique identifier of group[Interval <String>]
: Usage: interval='{interval}'[ItemActivityStatId <String>]
: The unique identifier of itemActivityStat[ListItemId <String>]
: The unique identifier of listItem[ListItemVersionId <String>]
: The unique identifier of listItemVersion[PermissionId <String>]
: The unique identifier of permission[Q <String>]
: Usage: q='{q}'[RichLongRunningOperationId <String>]
: The unique identifier of richLongRunningOperation[SharedDriveItemId <String>]
: The unique identifier of sharedDriveItem[StartDateTime <String>]
: Usage: startDateTime='{startDateTime}'[SubscriptionId <String>]
: The unique identifier of subscription[ThumbnailSetId <String>]
: The unique identifier of thumbnailSet[Token <String>]
: Usage: token='{token}'[UserId <String>]
: The unique identifier of user
LABELAPPLIEDBY <IMicrosoftGraphIdentitySet>
: identitySet
[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
RETENTIONSETTINGS <IMicrosoftGraphRetentionLabelSettings>
: retentionLabelSettings
[(Any) <Object>]
: This indicates any property can be added to this object.[BehaviorDuringRetentionPeriod <String>]
: behaviorDuringRetentionPeriod[IsContentUpdateAllowed <Boolean?>]
: Specifies whether updates to document content are allowed. Read-only.[IsDeleteAllowed <Boolean?>]
: Specifies whether the document deletion is allowed. Read-only.[IsLabelUpdateAllowed <Boolean?>]
: Specifies whether you're allowed to change the retention label on the document. Read-only.[IsMetadataUpdateAllowed <Boolean?>]
: Specifies whether updates to the item metadata (for example, the Title field) are blocked. Read-only.[IsRecordLocked <Boolean?>]
: Specifies whether the item is locked. Read-write.