Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph.entraRecoveryServices
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a preview job that calculates and enumerates the changes required to recover a tenant to a specific snapshot state. Inherits from recoveryJobBase. Use the getChanges function to retrieve the calculated changes after the job completes.
Inherits from microsoft.graph.entraRecoveryServices.recoveryJobBase.
Methods
| Method | Return type | Description |
|---|---|---|
| List | microsoft.graph.entraRecoveryServices.recoveryPreviewJob collection | Get a list of the recoveryPreviewJob objects and their properties. |
| Create | microsoft.graph.entraRecoveryServices.recoveryPreviewJob | Create a new recoveryPreviewJob object. |
| Get | microsoft.graph.entraRecoveryServices.recoveryPreviewJob | Read the properties and relationships of a recoveryPreviewJob object. |
| Get changes | microsoft.graph.entraRecoveryServices.recoveryChangeObjectBase collection | Retrieve the collection of changes calculated by the 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. Inherited from recoveryJobBase. |
| 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. Inherited from recoveryJobBase. |
| jobStartDateTime | DateTimeOffset | The date and time when the job started. Inherited from recoveryJobBase. |
| status | microsoft.graph.entraRecoveryServices.recoveryStatus | The current status of the job. Inherited from recoveryJobBase. 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. Inherited from recoveryJobBase. 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. Inherited from recoveryJobBase. |
| totalChangedObjectsCalculated | Int32 | The total count of changed directory objects calculated by the job. null until the job completes calculation. Inherited from recoveryJobBase. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.entraRecoveryServices.recoveryPreviewJob",
"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"
}