Skip to content

Latest commit

 

History

History
377 lines (311 loc) · 13.6 KB

Restore-MgUserDriveItem.md

File metadata and controls

377 lines (311 loc) · 13.6 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Users.Actions-help.xml
Microsoft.Graph.Users.Actions
2.0.0

Restore-MgUserDriveItem

SYNOPSIS

Restore a driveItem that has been deleted and is currently in the recycle bin. NOTE: This functionality is currently only available for OneDrive Personal.

Note

To view the beta release of this cmdlet, view Restore-MgBetaUserDriveItem

SYNTAX

RestoreExpanded (Default)

Restore-MgUserDriveItem -DriveId <String> -DriveItemId <String> -UserId <String>
 [-ResponseHeadersVariable <String>] [-AdditionalProperties <Hashtable>] [-Name <String>]
 [-ParentReference <IMicrosoftGraphItemReference>] [-Headers <IDictionary>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Restore

Restore-MgUserDriveItem -DriveId <String> -DriveItemId <String> -UserId <String>
 -BodyParameter <IPaths14Ul7QfUsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

RestoreViaIdentityExpanded

Restore-MgUserDriveItem -InputObject <IUsersActionsIdentity> [-ResponseHeadersVariable <String>]
 [-AdditionalProperties <Hashtable>] [-Name <String>] [-ParentReference <IMicrosoftGraphItemReference>]
 [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

RestoreViaIdentity

Restore-MgUserDriveItem -InputObject <IUsersActionsIdentity>
 -BodyParameter <IPaths14Ul7QfUsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Restore a driveItem that has been deleted and is currently in the recycle bin. NOTE: This functionality is currently only available for OneDrive Personal.

Permissions [!INCLUDE permissions-table]

PARAMETERS

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: RestoreExpanded, RestoreViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type: IPaths14Ul7QfUsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema
Parameter Sets: Restore, RestoreViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DriveId

The unique identifier of drive

Type: String
Parameter Sets: RestoreExpanded, Restore
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DriveItemId

The unique identifier of driveItem

Type: String
Parameter Sets: RestoreExpanded, Restore
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type: IUsersActionsIdentity
Parameter Sets: RestoreViaIdentityExpanded, RestoreViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

.

Type: String
Parameter Sets: RestoreExpanded, RestoreViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ParentReference

itemReference To construct, see NOTES section for PARENTREFERENCE properties and create a hash table.

Type: IMicrosoftGraphItemReference
Parameter Sets: RestoreExpanded, RestoreViaIdentityExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserId

The unique identifier of user

Type: String
Parameter Sets: RestoreExpanded, Restore
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Graph.PowerShell.Models.IPaths14Ul7QfUsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity

System.Collections.IDictionary

OUTPUTS

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDriveItem

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 <IPaths14Ul7QfUsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>: .

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Name <String>]:
  • [ParentReference <IMicrosoftGraphItemReference>]: itemReference
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DriveId <String>]: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a - [drive]- []. Read-only.
    • [DriveType <String>]: Identifies the type of drive. Only returned if the item is located in a - [drive]- []. See - [drive]- [] resource for values.
    • [Id <String>]: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
    • [Name <String>]: The name of the item being referenced. Read-only.
    • [Path <String>]: Path that can be used to navigate to the item. Read-only.
    • [ShareId <String>]: A unique identifier for a shared resource that can be accessed via the - [Shares]- [] API.
    • [SharepointIds <IMicrosoftGraphSharepointIds>]: sharepointIds
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [ListId <String>]: The unique identifier (guid) for the item's list in SharePoint.
      • [ListItemId <String>]: An integer identifier for the item within the containing list.
      • [ListItemUniqueId <String>]: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
      • [SiteId <String>]: The unique identifier (guid) for the item's site collection (SPSite).
      • [SiteUrl <String>]: The SharePoint URL for the site that contains the item.
      • [TenantId <String>]: The unique identifier (guid) for the tenancy.
      • [WebId <String>]: The unique identifier (guid) for the item's site (SPWeb).
    • [SiteId <String>]: For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that - [site]- [] resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.

INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter

  • [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
  • [CalendarId <String>]: The unique identifier of calendar
  • [ChatId <String>]: The unique identifier of chat
  • [ChatMessageId <String>]: The unique identifier of chatMessage
  • [ChatMessageId1 <String>]: The unique identifier of chatMessage
  • [ContentTypeId <String>]: The unique identifier of contentType
  • [DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
  • [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
  • [DriveId <String>]: The unique identifier of drive
  • [DriveItemId <String>]: The unique identifier of driveItem
  • [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
  • [EventId <String>]: The unique identifier of event
  • [EventId1 <String>]: The unique identifier of event
  • [ListItemId <String>]: The unique identifier of listItem
  • [ListItemVersionId <String>]: The unique identifier of listItemVersion
  • [MailFolderId <String>]: The unique identifier of mailFolder
  • [MailFolderId1 <String>]: The unique identifier of mailFolder
  • [ManagedDeviceId <String>]: The unique identifier of managedDevice
  • [MessageId <String>]: The unique identifier of message
  • [NotebookId <String>]: The unique identifier of notebook
  • [OnenotePageId <String>]: The unique identifier of onenotePage
  • [OnenoteSectionId <String>]: The unique identifier of onenoteSection
  • [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
  • [PermissionId <String>]: The unique identifier of permission
  • [PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod
  • [SubscriptionId <String>]: The unique identifier of subscription
  • [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
  • [TodoTaskId <String>]: The unique identifier of todoTask
  • [TodoTaskListId <String>]: The unique identifier of todoTaskList
  • [UserId <String>]: The unique identifier of user

PARENTREFERENCE <IMicrosoftGraphItemReference>: itemReference

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DriveId <String>]: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a - [drive]- []. Read-only.
  • [DriveType <String>]: Identifies the type of drive. Only returned if the item is located in a - [drive]- []. See - [drive]- [] resource for values.
  • [Id <String>]: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
  • [Name <String>]: The name of the item being referenced. Read-only.
  • [Path <String>]: Path that can be used to navigate to the item. Read-only.
  • [ShareId <String>]: A unique identifier for a shared resource that can be accessed via the - [Shares]- [] API.
  • [SharepointIds <IMicrosoftGraphSharepointIds>]: sharepointIds
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ListId <String>]: The unique identifier (guid) for the item's list in SharePoint.
    • [ListItemId <String>]: An integer identifier for the item within the containing list.
    • [ListItemUniqueId <String>]: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
    • [SiteId <String>]: The unique identifier (guid) for the item's site collection (SPSite).
    • [SiteUrl <String>]: The SharePoint URL for the site that contains the item.
    • [TenantId <String>]: The unique identifier (guid) for the tenancy.
    • [WebId <String>]: The unique identifier (guid) for the item's site (SPWeb).
  • [SiteId <String>]: For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that - [site]- [] resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.users.actions/restore-mguserdriveitem

https://learn.microsoft.com/graph/api/driveitem-restore?view=graph-rest-1.0