Update-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession

Module:

Microsoft.Graph.BackupRestore Module

Update the properties of a oneDriveForBusinessRestoreSession object.

Note

To view the beta release of this cmdlet, view Update-MgBetaSolutionBackupRestoreOneDriveForBusinessRestoreSession

Syntax

UpdateExpanded (Default)

Update-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession
    -OneDriveForBusinessRestoreSessionId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-CompletedDateTime <DateTime>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DriveRestoreArtifacts <IMicrosoftGraphDriveRestoreArtifact[]>]
    [-Error <IMicrosoftGraphPublicError>]
    [-Id <String>]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-Status <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession
    -OneDriveForBusinessRestoreSessionId <String>
    -BodyParameter <IMicrosoftGraphOneDriveForBusinessRestoreSession>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession
    -InputObject <IBackupRestoreIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-CompletedDateTime <DateTime>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DriveRestoreArtifacts <IMicrosoftGraphDriveRestoreArtifact[]>]
    [-Error <IMicrosoftGraphPublicError>]
    [-Id <String>]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-Status <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-MgSolutionBackupRestoreOneDriveForBusinessRestoreSession
    -InputObject <IBackupRestoreIdentity>
    -BodyParameter <IMicrosoftGraphOneDriveForBusinessRestoreSession>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of a oneDriveForBusinessRestoreSession object.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-BodyParameter

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

Parameter properties

Type:	IMicrosoftGraphOneDriveForBusinessRestoreSession
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Update

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

UpdateViaIdentity

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

-CompletedDateTime

The time of completion of the restore session.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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:	SwitchParameter
Default value:	None
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

-CreatedBy

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

Parameter properties

Type:	IMicrosoftGraphIdentitySet
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-CreatedDateTime

The time of creation of the restore session.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-DriveRestoreArtifacts

A collection of restore points and destination details that can be used to restore a OneDrive for Business drive. To construct, see NOTES section for DRIVERESTOREARTIFACTS properties and create a hash table.

Parameter properties

Type:	IMicrosoftGraphDriveRestoreArtifact[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-Error

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

Parameter properties

Type:	IMicrosoftGraphPublicError
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

Position:	Named
Mandatory:	False
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:	IDictionary
Default value:	None
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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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:	IBackupRestoreIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateViaIdentityExpanded

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

UpdateViaIdentity

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

-LastModifiedBy

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

Parameter properties

Type:	IMicrosoftGraphIdentitySet
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-LastModifiedDateTime

Timestamp of the last modification of the restore session.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-OneDriveForBusinessRestoreSessionId

The unique identifier of oneDriveForBusinessRestoreSession

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

Update

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	String
Default value:	None
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

-Status

restoreSessionStatus

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

UpdateViaIdentityExpanded

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

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
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.IBackupRestoreIdentity

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphOneDriveForBusinessRestoreSession

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphOneDriveForBusinessRestoreSession

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 <IMicrosoftGraphOneDriveForBusinessRestoreSession>: oneDriveForBusinessRestoreSession

• [(Any) <Object>]: This indicates any property can be added to this object.
• [CompletedDateTime <DateTime?>]: The time of completion of the restore session.
• [CreatedBy <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
• [CreatedDateTime <DateTime?>]: The time of creation of the restore session.
• [Error <IMicrosoftGraphPublicError>]: publicError
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Code <String>]: Represents the error code.
  • [Details <IMicrosoftGraphPublicErrorDetail- []>]: Details of the error.
    • [Code <String>]: The error code.
    • [Message <String>]: The error message.
    • [Target <String>]: The target of the error.
  • [InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Code <String>]: The error code.
    • [Details <IMicrosoftGraphPublicErrorDetail- []>]: A collection of error details.
    • [Message <String>]: The error message.
    • [Target <String>]: The target of the error.
  • [Message <String>]: A non-localized message for the developer.
  • [Target <String>]: The target of the error.
• [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
• [LastModifiedDateTime <DateTime?>]: Timestamp of the last modification of the restore session.
• [Status <String>]: restoreSessionStatus
• [Id <String>]: The unique identifier for an entity. Read-only.
• [DriveRestoreArtifacts <IMicrosoftGraphDriveRestoreArtifact- []>]: A collection of restore points and destination details that can be used to restore a OneDrive for Business drive.
  • [CompletionDateTime <DateTime?>]: The time when restoration of restore artifact is completed.
  • [DestinationType <String>]: destinationType
  • [Error <IMicrosoftGraphPublicError>]: publicError
  • [RestorePoint <IMicrosoftGraphRestorePoint>]: restorePoint
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ExpirationDateTime <DateTime?>]: Expiration date time of the restore point.
    • [ProtectionDateTime <DateTime?>]: Date time when the restore point was created.
    • [ProtectionUnit <IMicrosoftGraphProtectionUnitBase>]: protectionUnitBase
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [CreatedDateTime <DateTime?>]: The time of creation of the protection unit.
      • [Error <IMicrosoftGraphPublicError>]: publicError
      • [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
      • [LastModifiedDateTime <DateTime?>]: Timestamp of the last modification of this protection unit.
      • [PolicyId <String>]: The unique identifier of the protection policy based on which protection unit was created.
      • [Status <String>]: protectionUnitStatus
    • [Tags <String>]: restorePointTags
  • [StartDateTime <DateTime?>]: The time when restoration of restore artifact is started.
  • [Status <String>]: artifactRestoreStatus
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [RestoredSiteId <String>]: The new site identifier if destinationType is new, and the input site ID if the destinationType is inPlace.

CREATEDBY <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

DRIVERESTOREARTIFACTS <IMicrosoftGraphDriveRestoreArtifact- []>: A collection of restore points and destination details that can be used to restore a OneDrive for Business drive.

• [CompletionDateTime <DateTime?>]: The time when restoration of restore artifact is completed.
• [DestinationType <String>]: destinationType
• [Error <IMicrosoftGraphPublicError>]: publicError
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Code <String>]: Represents the error code.
  • [Details <IMicrosoftGraphPublicErrorDetail- []>]: Details of the error.
    • [Code <String>]: The error code.
    • [Message <String>]: The error message.
    • [Target <String>]: The target of the error.
  • [InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Code <String>]: The error code.
    • [Details <IMicrosoftGraphPublicErrorDetail- []>]: A collection of error details.
    • [Message <String>]: The error message.
    • [Target <String>]: The target of the error.
  • [Message <String>]: A non-localized message for the developer.
  • [Target <String>]: The target of the error.
• [RestorePoint <IMicrosoftGraphRestorePoint>]: restorePoint
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ExpirationDateTime <DateTime?>]: Expiration date time of the restore point.
  • [ProtectionDateTime <DateTime?>]: Date time when the restore point was created.
  • [ProtectionUnit <IMicrosoftGraphProtectionUnitBase>]: protectionUnitBase
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [CreatedBy <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
    • [CreatedDateTime <DateTime?>]: The time of creation of the protection unit.
    • [Error <IMicrosoftGraphPublicError>]: publicError
    • [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [LastModifiedDateTime <DateTime?>]: Timestamp of the last modification of this protection unit.
    • [PolicyId <String>]: The unique identifier of the protection policy based on which protection unit was created.
    • [Status <String>]: protectionUnitStatus
  • [Tags <String>]: restorePointTags
• [StartDateTime <DateTime?>]: The time when restoration of restore artifact is started.
• [Status <String>]: artifactRestoreStatus
• [Id <String>]: The unique identifier for an entity. Read-only.
• [RestoredSiteId <String>]: The new site identifier if destinationType is new, and the input site ID if the destinationType is inPlace.

ERROR <IMicrosoftGraphPublicError>: publicError

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Code <String>]: Represents the error code.
• [Details <IMicrosoftGraphPublicErrorDetail- []>]: Details of the error.
  • [Code <String>]: The error code.
  • [Message <String>]: The error message.
  • [Target <String>]: The target of the error.
• [InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Code <String>]: The error code.
  • [Details <IMicrosoftGraphPublicErrorDetail- []>]: A collection of error details.
  • [Message <String>]: The error message.
  • [Target <String>]: The target of the error.
• [Message <String>]: A non-localized message for the developer.
• [Target <String>]: The target of the error.

INPUTOBJECT <IBackupRestoreIdentity>: Identity Parameter

• [DriveProtectionRuleId <String>]: The unique identifier of driveProtectionRule
• [DriveProtectionUnitId <String>]: The unique identifier of driveProtectionUnit
• [DriveRestoreArtifactId <String>]: The unique identifier of driveRestoreArtifact
• [ExchangeProtectionPolicyId <String>]: The unique identifier of exchangeProtectionPolicy
• [ExchangeRestoreSessionId <String>]: The unique identifier of exchangeRestoreSession
• [GranularMailboxRestoreArtifactId <String>]: The unique identifier of granularMailboxRestoreArtifact
• [MailboxProtectionRuleId <String>]: The unique identifier of mailboxProtectionRule
• [MailboxProtectionUnitId <String>]: The unique identifier of mailboxProtectionUnit
• [MailboxRestoreArtifactId <String>]: The unique identifier of mailboxRestoreArtifact
• [OneDriveForBusinessProtectionPolicyId <String>]: The unique identifier of oneDriveForBusinessProtectionPolicy
• [OneDriveForBusinessRestoreSessionId <String>]: The unique identifier of oneDriveForBusinessRestoreSession
• [ProtectionPolicyBaseId <String>]: The unique identifier of protectionPolicyBase
• [ProtectionUnitBaseId <String>]: The unique identifier of protectionUnitBase
• [RestorePointId <String>]: The unique identifier of restorePoint
• [RestoreSessionBaseId <String>]: The unique identifier of restoreSessionBase
• [ServiceAppId <String>]: The unique identifier of serviceApp
• [SharePointProtectionPolicyId <String>]: The unique identifier of sharePointProtectionPolicy
• [SharePointRestoreSessionId <String>]: The unique identifier of sharePointRestoreSession
• [SiteProtectionRuleId <String>]: The unique identifier of siteProtectionRule
• [SiteProtectionUnitId <String>]: The unique identifier of siteProtectionUnit
• [SiteRestoreArtifactId <String>]: The unique identifier of siteRestoreArtifact

LASTMODIFIEDBY <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

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.backuprestore/update-mgsolutionbackuprestoreonedriveforbusinessrestoresession
• https://learn.microsoft.com/graph/api/onedriveforbusinessrestoresession-update?view=graph-rest-1.0