Restore-MgUserDriveRoot
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-MgBetaUserDriveRoot
Syntax
Restore-MgUserDriveRoot
-DriveId <String>
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Name <String>]
[-ParentReference <IMicrosoftGraphItemReference>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Restore-MgUserDriveRoot
-DriveId <String>
-UserId <String>
-BodyParameter <IPathsWcmhxwUsersUserIdDrivesDriveIdRootMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Restore-MgUserDriveRoot
-InputObject <IUsersActionsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Name <String>]
[-ParentReference <IMicrosoftGraphItemReference>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Restore-MgUserDriveRoot
-InputObject <IUsersActionsIdentity>
-BodyParameter <IPathsWcmhxwUsersUserIdDrivesDriveIdRootMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>
[-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
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Not supported. | Not supported. |
| Delegated (personal Microsoft account) | Files.ReadWrite.All | Not available. |
| Application | Files.ReadWrite.All | Not available. |
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IPathsWcmhxwUsersUserIdDrivesDriveIdRootMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema |
| 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 |
-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: | IUsersActionsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| 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 |
-UserId
The unique identifier of user
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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.IPathsWcmhxwUsersUserIdDrivesDriveIdRootMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema
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 <IPathsWcmhxwUsersUserIdDrivesDriveIdRootMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>: .
[(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>]: Percent-encoded 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>]: Percent-encoded 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.