New-MgSolutionBackupRestoreExchangeRestoreSession

Module:

Microsoft.Graph.BackupRestore Module

Create new navigation property to exchangeRestoreSessions for solutions

Note

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

Syntax

CreateExpanded (Default)

New-MgSolutionBackupRestoreExchangeRestoreSession
    [-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>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgSolutionBackupRestoreExchangeRestoreSession
    -BodyParameter <IMicrosoftGraphExchangeRestoreSession>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create new navigation property to exchangeRestoreSessions for solutions

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

CreateExpanded

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

-BodyParameter

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

Parameter properties

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

Parameter sets

Create

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

CreateExpanded

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

CreateExpanded

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

CreateExpanded

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

CreateExpanded

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

-GranularMailboxRestoreArtifacts

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

Parameter properties

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

Parameter sets

CreateExpanded

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

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
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

CreateExpanded

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

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

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

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
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

CreateExpanded

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.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>]: .

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/powershell/module/microsoft.graph.backuprestore/new-mgsolutionbackuprestoreexchangerestoresession