Skip to content

entrarecoveryservices-recoveryjobbase.md

Latest commit

 

History

History
66 lines (57 loc) · 3.88 KB

entrarecoveryservices-recoveryjobbase.md

File metadata and controls

66 lines (57 loc) · 3.88 KB
title recoveryJobBase resource type
description Abstract base type for recovery jobs. Defines common properties shared by preview and recovery jobs.
author yuhko-msft
ms.date 03/04/2026
ms.localizationpriority medium
ms.subservice entra-id
doc_type resourcePageType

recoveryJobBase resource type

Namespace: microsoft.graph.entraRecoveryServices

[!INCLUDE beta-disclaimer]

Abstract base type for recovery jobs. Defines common properties shared by recoveryPreviewJob and recoveryJob. Cannot be instantiated directly. Jobs follow the resource-based long running operation (RELO) pattern.

Inherits from microsoft.graph.entity.

Methods

Method Return type Description
List microsoft.graph.entraRecoveryServices.recoveryJobBase Get a list of the recoveryJobBase objects and their properties.
Cancel None Cancel a running recovery or preview job.

Properties

Property Type Description
filteringCriteria microsoft.graph.entraRecoveryServices.recoveryJobFilteringCriteriaBase Optional filtering criteria used to scope the job to specific entity types or entity IDs.
id String The unique identifier for the job. Inherited from entity. Supports $filter (eq, ne).
jobCompletionDateTime DateTimeOffset The date and time when the job completed. Null if the job is still running.
jobStartDateTime DateTimeOffset The date and time when the job started.
status microsoft.graph.entraRecoveryServices.recoveryStatus The current status of the job. The possible values are: initialized, running, successful, failed, abandoned, unknownFutureValue, calculating, loadingData. You must use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: calculating, loadingData. Supports $filter (eq, ne).
targetStateDateTime DateTimeOffset 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.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.entraRecoveryServices.recoveryJobBase",
  "id": "String (identifier)",
  "status": "String",
  "targetStateDateTime": "String (timestamp)",
  "jobStartDateTime": "String (timestamp)",
  "jobCompletionDateTime": "String (timestamp)",
  "filteringCriteria": {
    "@odata.type": "microsoft.graph.entraRecoveryServices.recoveryJobFilteringCriteriaBase"
  },
  "totalChangedObjectsCalculated": "Integer",
  "totalChangedLinksCalculated": "Integer"
}