Share via

New-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest

Module:
Microsoft.Graph.Beta.BackupRestore Module

Create a new mailboxRestoreArtifactsBulkAdditionRequest object associated with an exchangeRestoreSession. The following steps describe how to create and manage an exchangeRestoreSession with bulk artifact additions:

Syntax

CreateExpanded (Default) 

New-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest

    -ExchangeRestoreSessionId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DestinationType <String>]
    [-DirectoryObjectIds <String[]>]
    [-DisplayName <String>]
    [-Error <IMicrosoftGraphPublicError>]
    [-Id <String>]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-Mailboxes <String[]>]
    [-ProtectionTimePeriod <IMicrosoftGraphTimePeriod>]
    [-ProtectionUnitIds <String[]>]
    [-RestorePointPreference <String>]
    [-Status <String>]
    [-Tags <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest

    -ExchangeRestoreSessionId <String>
    -BodyParameter <IMicrosoftGraphMailboxRestoreArtifactsBulkAdditionRequest>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded 

New-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest

    -InputObject <IBackupRestoreIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DestinationType <String>]
    [-DirectoryObjectIds <String[]>]
    [-DisplayName <String>]
    [-Error <IMicrosoftGraphPublicError>]
    [-Id <String>]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-Mailboxes <String[]>]
    [-ProtectionTimePeriod <IMicrosoftGraphTimePeriod>]
    [-ProtectionUnitIds <String[]>]
    [-RestorePointPreference <String>]
    [-Status <String>]
    [-Tags <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity 

New-MgBetaSolutionBackupRestoreExchangeRestoreSessionMailboxRestoreArtifactBulkAdditionRequest

    -InputObject <IBackupRestoreIdentity>
    -BodyParameter <IMicrosoftGraphMailboxRestoreArtifactsBulkAdditionRequest>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a new mailboxRestoreArtifactsBulkAdditionRequest object associated with an exchangeRestoreSession. The following steps describe how to create and manage an exchangeRestoreSession with bulk artifact additions:

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

-BodyParameter

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

Parameter properties

Type:IMicrosoftGraphMailboxRestoreArtifactsBulkAdditionRequest
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
CreateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
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
CreateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreatedDateTime

The time when the bulk request was created.

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

-DestinationType

destinationType

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

-DirectoryObjectIds

The list of directory object IDs that are added to the corresponding Exchange restore session in a bulk operation. This property isn't implemented yet. Future value; don't use.

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

-DisplayName

Name of the addition request.

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

-ExchangeRestoreSessionId

The unique identifier of exchangeRestoreSession

Parameter properties

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

Parameter sets

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

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

Parameter sets

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

-LastModifiedDateTime

Timestamp when this entity was last modified.

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

-Mailboxes

The list of email addresses that are added to the corresponding Exchange restore session in a bulk operation.

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

-ProtectionTimePeriod

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

Parameter properties

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

-ProtectionUnitIds

Indicates which protection units to restore. This property isn't implemented yet. Future value; don't use.

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
CreateViaIdentityExpanded
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

-RestorePointPreference

restorePointPreference

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

-Status

restoreArtifactsBulkRequestStatus

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

-Tags

restorePointTags

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
CreateViaIdentityExpanded
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.Beta.PowerShell.Models.IBackupRestoreIdentity

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMailboxRestoreArtifactsBulkAdditionRequest

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphMailboxRestoreArtifactsBulkAdditionRequest

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 <IMicrosoftGraphMailboxRestoreArtifactsBulkAdditionRequest>: mailboxRestoreArtifactsBulkAdditionRequest

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [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 Exchange restore session in a bulk operation. This property isn't implemented yet. Future value; don't use.
  • [Mailboxes <String- []>]: The list of email addresses that are added to the corresponding Exchange 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

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. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity

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.