Share via


New-MgSolutionBackupRestoreSharePointRestoreSession

Create a new sharePointRestoreSession object.

Note

To view the beta release of this cmdlet, view New-MgBetaSolutionBackupRestoreSharePointRestoreSession

Syntax

New-MgSolutionBackupRestoreSharePointRestoreSession
   [-ResponseHeadersVariable <String>]
   [-AdditionalProperties <Hashtable>]
   [-CompletedDateTime <DateTime>]
   [-CreatedBy <IMicrosoftGraphIdentitySet>]
   [-CreatedDateTime <DateTime>]
   [-Error <IMicrosoftGraphPublicError>]
   [-Id <String>]
   [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
   [-LastModifiedDateTime <DateTime>]
   [-SiteRestoreArtifacts <IMicrosoftGraphSiteRestoreArtifact[]>]
   [-Status <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgSolutionBackupRestoreSharePointRestoreSession
   -BodyParameter <IMicrosoftGraphSharePointRestoreSession>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create a new sharePointRestoreSession object.

Parameters

-AdditionalProperties

Additional Parameters

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

-BodyParameter

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

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

-CompletedDateTime

The time of completion of the restore session.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-CreatedBy

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

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

-CreatedDateTime

The time of creation of the restore session.

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

-Error

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

Type:IMicrosoftGraphPublicError
Position:Named
Default value:None
Required:False
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

-LastModifiedBy

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

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

-LastModifiedDateTime

Timestamp of the last modification of the restore session.

Type:DateTime
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

-SiteRestoreArtifacts

A collection of restore points and destination details that can be used to restore SharePoint sites. To construct, see NOTES section for SITERESTOREARTIFACTS properties and create a hash table.

Type:IMicrosoftGraphSiteRestoreArtifact[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

restoreSessionStatus

Type:String
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.PowerShell.Models.IMicrosoftGraphSharePointRestoreSession

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSharePointRestoreSession

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 <IMicrosoftGraphSharePointRestoreSession>: sharePointRestoreSession

  • [(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.
  • [SiteRestoreArtifacts <IMicrosoftGraphSiteRestoreArtifact- []>]: A collection of restore points and destination details that can be used to restore SharePoint sites.
    • [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 the value of the destinationType property is new, and the existing site ID if the value 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

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

  • [(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

SITERESTOREARTIFACTS <IMicrosoftGraphSiteRestoreArtifact- []>: A collection of restore points and destination details that can be used to restore SharePoint sites.

  • [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 the value of the destinationType property is new, and the existing site ID if the value is inPlace.

https://learn.microsoft.com/powershell/module/microsoft.graph.backuprestore/new-mgsolutionbackuprestoresharepointrestoresession

https://learn.microsoft.com/graph/api/backuprestoreroot-post-sharepointrestoresessions?view=graph-rest-1.0