Restore-MgDriveItem

Module:

Microsoft.Graph.Files Module

Restore a driveItem that has been deleted and is currently in the recycle bin.

Note

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

Syntax

RestoreExpanded (Default)

Restore-MgDriveItem
    -DriveId <string>
    -DriveItemId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Name <string>]
    [-ParentReference <IMicrosoftGraphItemReference>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Restore

Restore-MgDriveItem
    -DriveId <string>
    -DriveItemId <string>
    -BodyParameter <IPaths17Wfo8EDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RestoreViaIdentityExpanded

Restore-MgDriveItem
    -InputObject <IFilesIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Name <string>]
    [-ParentReference <IMicrosoftGraphItemReference>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RestoreViaIdentity

Restore-MgDriveItem
    -InputObject <IFilesIdentity>
    -BodyParameter <IPaths17Wfo8EDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Restore a driveItem that has been deleted and is currently in the recycle bin.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Files

$params = @{
	parentReference = @{
		id = "String"
	}
	name = "String"
}

Restore-MgDriveItem -DriveId $driveId -DriveItemId $driveItemId -BodyParameter $params

This example shows how to use the Restore-MgDriveItem Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

RestoreExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-BodyParameter

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IPaths17Wfo8EDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

Restore

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DriveId

The unique identifier of drive

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Restore

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DriveItemId

The unique identifier of driveItem

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Restore

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IFilesIdentity
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreViaIdentityExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

RestoreViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Restore a driveItem that has been deleted and is currently in the recycle bin.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

RestoreExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ParentReference

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphItemReference
Supports wildcards:	False
DontShow:	False

Parameter sets

RestoreViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

RestoreExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

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

Inputs

Microsoft.Graph.PowerShell.Models.IFilesIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IPaths17Wfo8EDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDriveItem

{{ Fill in the Description }}

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 <IPaths17Wfo8EDrivesDriveIdItemsDriveitemIdMicrosoftGraphRestorePostRequestbodyContentApplicationJsonSchema>: . [(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 <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

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.

Related Links

• Restore-MgDriveItem
• Graph API Reference