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.
A collection of SharePoint site URLs and destination details that can be used to restore SharePoint sites.
To construct, see NOTES section for SITERESTOREARTIFACTSBULKADDITIONREQUESTS properties and create a hash table.
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.
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.
[RestoreJobType <String>]: restoreJobType
[RestoreSessionArtifactCount <IMicrosoftGraphRestoreSessionArtifactCount>]: restoreSessionArtifactCount
[(Any) <Object>]: This indicates any property can be added to this object.
[Completed <Int32?>]: The number of artifacts whose restoration completed.
[Failed <Int32?>]: The number of artifacts whose restoration failed.
[InProgress <Int32?>]: The number of artifacts whose restoration is in progress.
[Total <Int32?>]: The number of artifacts present in 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.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[Error <IMicrosoftGraphPublicError>]: publicError
[LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
[LastModifiedDateTime <DateTime?>]: Timestamp of the last modification of this protection unit.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[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.
[SiteRestoreArtifactsBulkAdditionRequests <IMicrosoftGraphSiteRestoreArtifactsBulkAdditionRequest[]>]: A collection of SharePoint site URLs and destination details that can be used to restore SharePoint sites.
[CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
[CreatedDateTime <DateTime?>]: The time when the bulk request was created.
[DestinationType <String>]: destinationType
[DisplayName <String>]: Name of the addition request.
[Error <IMicrosoftGraphPublicError>]: publicError
[LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
[LastModifiedDateTime <DateTime?>]: Timestamp when this entity was last modified.
[ProtectionTimePeriod <IMicrosoftGraphTimePeriod>]: timePeriod
[(Any) <Object>]: This indicates any property can be added to this object.
[EndDateTime <DateTime?>]: The date time of the end of the time period.
[StartDateTime <DateTime?>]: The date time of the start of the time period.
[ProtectionUnitIds <String[]>]: Indicates which protection units to restore.
This property isn't implemented yet.
Future value; don't use.
[RestorePointPreference <String>]: restorePointPreference
[Status <String>]: restoreArtifactsBulkRequestStatus
[Tags <String>]: restorePointTags
[Id <String>]: The unique identifier for an entity.
Read-only.
[SiteIds <String[]>]: The list of SharePoint site IDs that are added to the corresponding SharePoint restore session in a bulk operation.
[SiteWebUrls <String[]>]: The list of SharePoint site URLs that are added to the corresponding SharePoint restore session in a bulk operation.
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.
INPUTOBJECT <IBackupRestoreIdentity>: Identity Parameter
[DriveProtectionRuleId <String>]: The unique identifier of driveProtectionRule
[DriveProtectionUnitId <String>]: The unique identifier of driveProtectionUnit
[DriveProtectionUnitsBulkAdditionJobId <String>]: The unique identifier of driveProtectionUnitsBulkAdditionJob
[DriveRestoreArtifactId <String>]: The unique identifier of driveRestoreArtifact
[DriveRestoreArtifactsBulkAdditionRequestId <String>]: The unique identifier of driveRestoreArtifactsBulkAdditionRequest
[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
[MailboxProtectionUnitsBulkAdditionJobId <String>]: The unique identifier of mailboxProtectionUnitsBulkAdditionJob
[MailboxRestoreArtifactId <String>]: The unique identifier of mailboxRestoreArtifact
[MailboxRestoreArtifactsBulkAdditionRequestId <String>]: The unique identifier of mailboxRestoreArtifactsBulkAdditionRequest
[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
[SiteProtectionUnitsBulkAdditionJobId <String>]: The unique identifier of siteProtectionUnitsBulkAdditionJob
[SiteRestoreArtifactId <String>]: The unique identifier of siteRestoreArtifact
[SiteRestoreArtifactsBulkAdditionRequestId <String>]: The unique identifier of siteRestoreArtifactsBulkAdditionRequest
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
RESTORESESSIONARTIFACTCOUNT <IMicrosoftGraphRestoreSessionArtifactCount>: restoreSessionArtifactCount
[(Any) <Object>]: This indicates any property can be added to this object.
[Completed <Int32?>]: The number of artifacts whose restoration completed.
[Failed <Int32?>]: The number of artifacts whose restoration failed.
[InProgress <Int32?>]: The number of artifacts whose restoration is in progress.
[Total <Int32?>]: The number of artifacts present in the restore session.
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.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[Error <IMicrosoftGraphPublicError>]: publicError
[LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
[LastModifiedDateTime <DateTime?>]: Timestamp of the last modification of this protection unit.
The timestamp type represents date and time information using ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[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.
SITERESTOREARTIFACTSBULKADDITIONREQUESTS <IMicrosoftGraphSiteRestoreArtifactsBulkAdditionRequest[]>: A collection of SharePoint site URLs and destination details that can be used to restore SharePoint sites.
[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 when the bulk request was created.
[DestinationType <String>]: destinationType
[DisplayName <String>]: Name of the addition request.
[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 when this entity was last modified.
[ProtectionTimePeriod <IMicrosoftGraphTimePeriod>]: timePeriod
[(Any) <Object>]: This indicates any property can be added to this object.
[EndDateTime <DateTime?>]: The date time of the end of the time period.
[StartDateTime <DateTime?>]: The date time of the start of the time period.
[ProtectionUnitIds <String[]>]: Indicates which protection units to restore.
This property isn't implemented yet.
Future value; don't use.
[RestorePointPreference <String>]: restorePointPreference
[Status <String>]: restoreArtifactsBulkRequestStatus
[Tags <String>]: restorePointTags
[Id <String>]: The unique identifier for an entity.
Read-only.
[SiteIds <String[]>]: The list of SharePoint site IDs that are added to the corresponding SharePoint restore session in a bulk operation.
[SiteWebUrls <String[]>]: The list of SharePoint site URLs that are added to the corresponding SharePoint restore session in a bulk operation.