Update-MgDirectoryRecovery

Module:: Microsoft.Graph.Identity.DirectoryManagement Module

Update the navigation property recovery in directory

Note

To view the beta release of this cmdlet, view Update-MgBetaDirectoryRecovery

Syntax

UpdateExpanded (Default)

Update-MgDirectoryRecovery
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Id <string>]
    [-Jobs <IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase[]>]
    [-Snapshots <IMicrosoftGraphEntraRecoveryServicesSnapshot[]>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgDirectoryRecovery
    -BodyParameter <IMicrosoftGraphEntraRecoveryServicesRecovery>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:	System.Collections.Hashtable
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

-BodyParameter

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

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesRecovery
Supports wildcards:	False
DontShow:	False

Parameter sets

Update

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

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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:	System.Management.Automation.SwitchParameter
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

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
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

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

-Jobs

Collection of all recovery jobs (both preview and recovery) for the tenant. To construct, see NOTES section for JOBS properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase[]
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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:	System.String
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

-Snapshots

Collection of backup snapshots available for the tenant. To construct, see NOTES section for SNAPSHOTS properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesSnapshot[]
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateExpanded

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

-WhatIf

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.

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesRecovery

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesRecovery

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 <IMicrosoftGraphEntraRecoveryServicesRecovery>: recovery [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Jobs <IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase[]>]: Collection of all recovery jobs (both preview and recovery) for the tenant. [Id <String>]: The unique identifier for an entity. Read-only. [FilteringCriteria <IMicrosoftGraphEntraRecoveryServicesRecoveryJobFilteringCriteriaBase>]: recoveryJobFilteringCriteriaBase [(Any) <Object>]: This indicates any property can be added to this object. [JobCompletionDateTime <DateTime?>]: The date and time when the job completed. Null if the job is still running. [JobStartDateTime <DateTime?>]: The date and time when the job started. [Status <RecoveryStatus?>]: recoveryStatus [TargetStateDateTime <DateTime?>]: The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne). [TotalChangedLinksCalculated <Int32?>]: The total count of changed directory object links (relationships) calculated by the job. null until the job completes calculation. Not all calculated link changes may be successfully applied; see totalLinksModified on derived types for the count of links that were actually modified. [TotalChangedObjectsCalculated <Int32?>]: The total count of changed directory objects calculated by the job. null until the job completes calculation. Not all calculated object changes may be successfully applied; see totalObjectsModified on derived types for the count of objects that were actually modified. [Snapshots <IMicrosoftGraphEntraRecoveryServicesSnapshot[]>]: Collection of backup snapshots available for the tenant. [Id <String>]: The unique identifier for an entity. Read-only. [CreatedDateTime <DateTime?>]: The date and time when the snapshot was created. [RecoveryJobs <IMicrosoftGraphEntraRecoveryServicesRecoveryJob[]>]: Collection of recovery jobs created for this snapshot. [FilteringCriteria <IMicrosoftGraphEntraRecoveryServicesRecoveryJobFilteringCriteriaBase>]: recoveryJobFilteringCriteriaBase [JobCompletionDateTime <DateTime?>]: The date and time when the job completed. Null if the job is still running. [JobStartDateTime <DateTime?>]: The date and time when the job started. [Status <RecoveryStatus?>]: recoveryStatus [TargetStateDateTime <DateTime?>]: The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne). [TotalChangedLinksCalculated <Int32?>]: The total count of changed directory object links (relationships) calculated by the job. null until the job completes calculation. Not all calculated link changes may be successfully applied; see totalLinksModified on derived types for the count of links that were actually modified. [TotalChangedObjectsCalculated <Int32?>]: The total count of changed directory objects calculated by the job. null until the job completes calculation. Not all calculated object changes may be successfully applied; see totalObjectsModified on derived types for the count of objects that were actually modified. [Id <String>]: The unique identifier for an entity. Read-only. [TotalFailedChanges <Int32?>]: The count of changes (including both objects and links) that failed to apply during recovery. [TotalLinksModified <Int32?>]: The count of directory object links (relationships) that were successfully modified during recovery. This value may be less than totalChangedLinksCalculated if some link changes failed. [TotalObjectsModified <Int32?>]: The count of directory objects that were successfully modified during recovery. This value may be less than totalChangedObjectsCalculated if some object changes failed. [RecoveryPreviewJobs <IMicrosoftGraphEntraRecoveryServicesRecoveryPreviewJob[]>]: Collection of preview jobs created for this snapshot. [FilteringCriteria <IMicrosoftGraphEntraRecoveryServicesRecoveryJobFilteringCriteriaBase>]: recoveryJobFilteringCriteriaBase [JobCompletionDateTime <DateTime?>]: The date and time when the job completed. Null if the job is still running. [JobStartDateTime <DateTime?>]: The date and time when the job started. [Status <RecoveryStatus?>]: recoveryStatus [TargetStateDateTime <DateTime?>]: The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne). [TotalChangedLinksCalculated <Int32?>]: The total count of changed directory object links (relationships) calculated by the job. null until the job completes calculation. Not all calculated link changes may be successfully applied; see totalLinksModified on derived types for the count of links that were actually modified. [TotalChangedObjectsCalculated <Int32?>]: The total count of changed directory objects calculated by the job. null until the job completes calculation. Not all calculated object changes may be successfully applied; see totalObjectsModified on derived types for the count of objects that were actually modified. [Id <String>]: The unique identifier for an entity. Read-only. [TotalChangedObjects <Int32?>]: The total number of changed objects identified in this snapshot.

JOBS <IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase[]>: Collection of all recovery jobs (both preview and recovery) for the tenant. [Id <String>]: The unique identifier for an entity. Read-only. [FilteringCriteria <IMicrosoftGraphEntraRecoveryServicesRecoveryJobFilteringCriteriaBase>]: recoveryJobFilteringCriteriaBase [(Any) <Object>]: This indicates any property can be added to this object. [JobCompletionDateTime <DateTime?>]: The date and time when the job completed. Null if the job is still running. [JobStartDateTime <DateTime?>]: The date and time when the job started. [Status <RecoveryStatus?>]: recoveryStatus [TargetStateDateTime <DateTime?>]: The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne). [TotalChangedLinksCalculated <Int32?>]: The total count of changed directory object links (relationships) calculated by the job. null until the job completes calculation. Not all calculated link changes may be successfully applied; see totalLinksModified on derived types for the count of links that were actually modified. [TotalChangedObjectsCalculated <Int32?>]: The total count of changed directory objects calculated by the job. null until the job completes calculation. Not all calculated object changes may be successfully applied; see totalObjectsModified on derived types for the count of objects that were actually modified.

SNAPSHOTS <IMicrosoftGraphEntraRecoveryServicesSnapshot[]>: Collection of backup snapshots available for the tenant. [Id <String>]: The unique identifier for an entity. Read-only. [CreatedDateTime <DateTime?>]: The date and time when the snapshot was created. [RecoveryJobs <IMicrosoftGraphEntraRecoveryServicesRecoveryJob[]>]: Collection of recovery jobs created for this snapshot. [FilteringCriteria <IMicrosoftGraphEntraRecoveryServicesRecoveryJobFilteringCriteriaBase>]: recoveryJobFilteringCriteriaBase [(Any) <Object>]: This indicates any property can be added to this object. [JobCompletionDateTime <DateTime?>]: The date and time when the job completed. Null if the job is still running. [JobStartDateTime <DateTime?>]: The date and time when the job started. [Status <RecoveryStatus?>]: recoveryStatus [TargetStateDateTime <DateTime?>]: The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne). [TotalChangedLinksCalculated <Int32?>]: The total count of changed directory object links (relationships) calculated by the job. null until the job completes calculation. Not all calculated link changes may be successfully applied; see totalLinksModified on derived types for the count of links that were actually modified. [TotalChangedObjectsCalculated <Int32?>]: The total count of changed directory objects calculated by the job. null until the job completes calculation. Not all calculated object changes may be successfully applied; see totalObjectsModified on derived types for the count of objects that were actually modified. [Id <String>]: The unique identifier for an entity. Read-only. [TotalFailedChanges <Int32?>]: The count of changes (including both objects and links) that failed to apply during recovery. [TotalLinksModified <Int32?>]: The count of directory object links (relationships) that were successfully modified during recovery. This value may be less than totalChangedLinksCalculated if some link changes failed. [TotalObjectsModified <Int32?>]: The count of directory objects that were successfully modified during recovery. This value may be less than totalChangedObjectsCalculated if some object changes failed. [RecoveryPreviewJobs <IMicrosoftGraphEntraRecoveryServicesRecoveryPreviewJob[]>]: Collection of preview jobs created for this snapshot. [FilteringCriteria <IMicrosoftGraphEntraRecoveryServicesRecoveryJobFilteringCriteriaBase>]: recoveryJobFilteringCriteriaBase [JobCompletionDateTime <DateTime?>]: The date and time when the job completed. Null if the job is still running. [JobStartDateTime <DateTime?>]: The date and time when the job started. [Status <RecoveryStatus?>]: recoveryStatus [TargetStateDateTime <DateTime?>]: The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne). [TotalChangedLinksCalculated <Int32?>]: The total count of changed directory object links (relationships) calculated by the job. null until the job completes calculation. Not all calculated link changes may be successfully applied; see totalLinksModified on derived types for the count of links that were actually modified. [TotalChangedObjectsCalculated <Int32?>]: The total count of changed directory objects calculated by the job. null until the job completes calculation. Not all calculated object changes may be successfully applied; see totalObjectsModified on derived types for the count of objects that were actually modified. [Id <String>]: The unique identifier for an entity. Read-only. [TotalChangedObjects <Int32?>]: The total number of changed objects identified in this snapshot.