Update-MgSolutionBackupRestoreExchangeRestoreSession
Update the properties of an exchangeRestoreSession.
Note
To view the beta release of this cmdlet, view Update-MgBetaSolutionBackupRestoreExchangeRestoreSession
Syntax
Update-MgSolutionBackupRestoreExchangeRestoreSession
-ExchangeRestoreSessionId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-CompletedDateTime <DateTime>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-CreatedDateTime <DateTime>]
[-Error <IMicrosoftGraphPublicError>]
[-GranularMailboxRestoreArtifacts <IMicrosoftGraphGranularMailboxRestoreArtifact[]>]
[-Id <String>]
[-LastModifiedBy <IMicrosoftGraphIdentitySet>]
[-LastModifiedDateTime <DateTime>]
[-MailboxRestoreArtifacts <IMicrosoftGraphMailboxRestoreArtifact[]>]
[-Status <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgSolutionBackupRestoreExchangeRestoreSession
-ExchangeRestoreSessionId <String>
-BodyParameter <IMicrosoftGraphExchangeRestoreSession>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgSolutionBackupRestoreExchangeRestoreSession
-InputObject <IBackupRestoreIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-CompletedDateTime <DateTime>]
[-CreatedBy <IMicrosoftGraphIdentitySet>]
[-CreatedDateTime <DateTime>]
[-Error <IMicrosoftGraphPublicError>]
[-GranularMailboxRestoreArtifacts <IMicrosoftGraphGranularMailboxRestoreArtifact[]>]
[-Id <String>]
[-LastModifiedBy <IMicrosoftGraphIdentitySet>]
[-LastModifiedDateTime <DateTime>]
[-MailboxRestoreArtifacts <IMicrosoftGraphMailboxRestoreArtifact[]>]
[-Status <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgSolutionBackupRestoreExchangeRestoreSession
-InputObject <IBackupRestoreIdentity>
-BodyParameter <IMicrosoftGraphExchangeRestoreSession>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Update the properties of an exchangeRestoreSession.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
exchangeRestoreSession To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphExchangeRestoreSession |
| 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 |
-ExchangeRestoreSessionId
The unique identifier of exchangeRestoreSession
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GranularMailboxRestoreArtifacts
To construct, see NOTES section for GRANULARMAILBOXRESTOREARTIFACTS properties and create a hash table.
| Type: | IMicrosoftGraphGranularMailboxRestoreArtifact[] |
| 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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IBackupRestoreIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
-MailboxRestoreArtifacts
A collection of restore points and destination details that can be used to restore Exchange mailboxes. To construct, see NOTES section for MAILBOXRESTOREARTIFACTS properties and create a hash table.
| Type: | IMicrosoftGraphMailboxRestoreArtifact[] |
| 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 |
-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.IBackupRestoreIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphExchangeRestoreSession
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphExchangeRestoreSession
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 <IMicrosoftGraphExchangeRestoreSession>: exchangeRestoreSession
[(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.[GranularMailboxRestoreArtifacts <IMicrosoftGraphGranularMailboxRestoreArtifact-[]>]:[RestoredFolderId <String>]: The new restored folder identifier for the user.[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.[ArtifactCount <Int32?>]: .[SearchResponseId <String>]: .
[MailboxRestoreArtifacts <IMicrosoftGraphMailboxRestoreArtifact-[]>]: A collection of restore points and destination details that can be used to restore Exchange mailboxes.[CompletionDateTime <DateTime?>]: The time when restoration of restore artifact is completed.[DestinationType <String>]: destinationType[Error <IMicrosoftGraphPublicError>]: publicError[RestorePoint <IMicrosoftGraphRestorePoint>]: restorePoint[StartDateTime <DateTime?>]: The time when restoration of restore artifact is started.[Status <String>]: artifactRestoreStatus[Id <String>]: The unique identifier for an entity. Read-only.[RestoredFolderId <String>]: The new restored folder identifier for the user.
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.
GRANULARMAILBOXRESTOREARTIFACTS <IMicrosoftGraphGranularMailboxRestoreArtifact- []>: .
[RestoredFolderId <String>]: The new restored folder identifier for the user.[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.[ArtifactCount <Int32?>]: .[SearchResponseId <String>]: .
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
MAILBOXRESTOREARTIFACTS <IMicrosoftGraphMailboxRestoreArtifact- []>: A collection of restore points and destination details that can be used to restore Exchange mailboxes.
[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.[RestoredFolderId <String>]: The new restored folder identifier for the user.
RELATED LINKS
https://learn.microsoft.com/graph/api/exchangerestoresession-update?view=graph-rest-1.0