Update-MgDirectoryRecoveryJob

Module:
Microsoft.Graph.Identity.DirectoryManagement Module

Update the navigation property jobs in directory

Note

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

Syntax

UpdateExpanded (Default) 

Update-MgDirectoryRecoveryJob
    -RecoveryJobBaseId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-FilteringCriteria <hashtable>]
    [-Id <string>]
    [-JobCompletionDateTime <datetime>]
    [-JobStartDateTime <datetime>]
    [-Status <RecoveryStatus>]
    [-TargetStateDateTime <datetime>]
    [-TotalChangedLinksCalculated <int>]
    [-TotalChangedObjectsCalculated <int>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

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

UpdateViaIdentityExpanded 

Update-MgDirectoryRecoveryJob
    -InputObject <IIdentityDirectoryManagementIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-FilteringCriteria <hashtable>]
    [-Id <string>]
    [-JobCompletionDateTime <datetime>]
    [-JobStartDateTime <datetime>]
    [-Status <RecoveryStatus>]
    [-TargetStateDateTime <datetime>]
    [-TotalChangedLinksCalculated <int>]
    [-TotalChangedObjectsCalculated <int>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgDirectoryRecoveryJob
    -InputObject <IIdentityDirectoryManagementIdentity>
    -BodyParameter <IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase>
    [-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

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

-BodyParameter

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

Parameter properties

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

Parameter sets

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

-FilteringCriteria

recoveryJobFilteringCriteriaBase

Parameter properties

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

Parameter sets

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

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
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:Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
Supports wildcards:False
DontShow:False

Parameter sets

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

-JobCompletionDateTime

The date and time when the job completed. Null if the job is still running.

Parameter properties

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

Parameter sets

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

-JobStartDateTime

The date and time when the job started.

Parameter properties

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

Parameter sets

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

-RecoveryJobBaseId

The unique identifier of recoveryJobBase

Parameter properties

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

Parameter sets

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

-Status

recoveryStatus

Parameter properties

Type:Microsoft.Graph.PowerShell.Support.RecoveryStatus
Supports wildcards:False
DontShow:False

Parameter sets

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

-TargetStateDateTime

The target snapshot timestamp to which the tenant is being restored. Supports $filter (eq, ne).

Parameter properties

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

Parameter sets

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

-TotalChangedLinksCalculated

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.

Parameter properties

Type:System.Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

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

-TotalChangedObjectsCalculated

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.

Parameter properties

Type:System.Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

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

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase

{{ Fill in the Description }}

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 <IMicrosoftGraphEntraRecoveryServicesRecoveryJobBase>: recoveryJobBase [(Any) <Object>]: This indicates any property can be added to this object. [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.

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit [AllowedValueId <String>]: The unique identifier of allowedValue [AttributeSetId <String>]: The unique identifier of attributeSet [CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail [CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki [CommerceSubscriptionId <String>]: Alternate key of companySubscription [CompanySubscriptionId <String>]: The unique identifier of companySubscription [ContractId <String>]: The unique identifier of contract [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition [DeviceId <String>]: The unique identifier of device [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo [DirectoryObjectId <String>]: The unique identifier of directoryObject [DirectoryRoleId <String>]: The unique identifier of directoryRole [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord [DomainId <String>]: The unique identifier of domain [DomainName <String>]: Usage: domainName='{domainName}' [ExtensionId <String>]: The unique identifier of extension [GovernanceInvitationId <String>]: The unique identifier of governanceInvitation [GovernanceRelationshipId <String>]: The unique identifier of governanceRelationship [GovernanceRequestId <String>]: The unique identifier of governanceRequest [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization [OrgContactId <String>]: The unique identifier of orgContact [OrganizationId <String>]: The unique identifier of organization [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty [ProfilePropertySettingId <String>]: The unique identifier of profilePropertySetting [ProfileSourceId <String>]: The unique identifier of profileSource [RecoveryJobBaseId <String>]: The unique identifier of recoveryJobBase [RecoveryJobId <String>]: The unique identifier of recoveryJob [RecoveryPreviewJobId <String>]: The unique identifier of recoveryPreviewJob [RelatedTenantId <String>]: The unique identifier of relatedTenant [RemoteTenantGroupId <String>]: The unique identifier of remoteTenantGroup [RoleTemplateId <String>]: Alternate key of directoryRole [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership [SnapshotId <String>]: The unique identifier of snapshot [SourceId <String>]: Alternate key of profileSource [SubscribedSkuId <String>]: The unique identifier of subscribedSku [TenantGovernancePolicyTemplateId <String>]: The unique identifier of tenantGovernancePolicyTemplate [TenantId <String>]: Usage: tenantId='{tenantId}' [UserId <String>]: The unique identifier of user