A collection of restore points and destination details that can be used to restore a OneDrive for work or school drive.
To construct, see NOTES section for DRIVERESTOREARTIFACTS properties and create a hash table.
A collection of user mailboxes and destination details that can be used to restore a OneDrive for work or school drive.
To construct, see NOTES section for DRIVERESTOREARTIFACTSBULKADDITIONREQUESTS 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 <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.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[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.
[DriveRestoreArtifacts <IMicrosoftGraphDriveRestoreArtifact[]>]: A collection of restore points and destination details that can be used to restore a OneDrive for work or school 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.
[OffboardRequestedDateTime <DateTime?>]: The time when protection unit offboard was requested.
[PolicyId <String>]: The unique identifier of the protection policy based on which protection unit was created.
[ProtectionSources <String>]: protectionSource
[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.
[DriveRestoreArtifactsBulkAdditionRequests <IMicrosoftGraphDriveRestoreArtifactsBulkAdditionRequest[]>]: A collection of user mailboxes and destination details that can be used to restore a OneDrive for work or school drive.
[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.
[DirectoryObjectIds <String[]>]: The list of directory object IDs that are added to the corresponding OneDrive for work or school restore session in a bulk operation.
[Drives <String[]>]: The list of email addresses that are added to the corresponding OneDrive for work or school 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.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[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 work or school 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.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[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.
[OffboardRequestedDateTime <DateTime?>]: The time when protection unit offboard was requested.
[PolicyId <String>]: The unique identifier of the protection policy based on which protection unit was created.
[ProtectionSources <String>]: protectionSource
[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.
DRIVERESTOREARTIFACTSBULKADDITIONREQUESTS <IMicrosoftGraphDriveRestoreArtifactsBulkAdditionRequest[]>: A collection of user mailboxes and destination details that can be used to restore a OneDrive for work or school drive.
[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.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[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.
[DirectoryObjectIds <String[]>]: The list of directory object IDs that are added to the corresponding OneDrive for work or school restore session in a bulk operation.
[Drives <String[]>]: The list of email addresses that are added to the corresponding OneDrive for work or school restore session in a bulk operation.
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.
This property is read-only.
[Id <String>]: The identifier of the identity.
This property is read-only.
[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.