Skip to content

entrarecoveryservices-recoverychangeobjectbase.md

Latest commit

 

History

History
62 lines (51 loc) · 3.55 KB

entrarecoveryservices-recoverychangeobjectbase.md

File metadata and controls

62 lines (51 loc) · 3.55 KB
title recoveryChangeObjectBase resource type
description Represents a single object change in the context of tenant recovery.
author yuhko-msft
ms.date 03/04/2026
ms.localizationpriority medium
ms.subservice entra-id
doc_type resourcePageType

recoveryChangeObjectBase resource type

Namespace: microsoft.graph.entraRecoveryServices

[!INCLUDE beta-disclaimer]

Represents a single object change in the context of tenant recovery. Returned by the getChanges function on preview jobs and getFailedChanges function on recovery jobs. Each instance describes the entity being modified, the type of recovery action to be performed, and the delta between the current and target states.

Inherits from microsoft.graph.entity.

This resource is an open type that supports additional dynamic properties deltaFromCurrent and currentState in responses.

Methods

None.

Properties

Property Type Description
displayName String The display name of the changed object in its current state, used to uniquely identify the object. Supports $filter (eq, ne, startswith).
entityTypeName microsoft.graph.entraRecoveryServices.resourceTypeName The type of directory entity being modified. The possible values are: user, group, conditionalAccessPolicy, namedLocationPolicy, authenticationMethodPolicy, authorizationPolicy, authenticationStrengthPolicy, application, servicePrincipal, unknownFutureValue, oAuth2PermissionGrant, appRoleAssignment. You must use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: oAuth2PermissionGrant, appRoleAssignment. Supports $filter (eq, ne).
failureMessage String The error message if the change failed to apply. Only populated in getFailedChanges responses. null otherwise.
id String The unique identifier of the changed object. Inherited from entity. Supports $filter (eq, ne).
recoveryAction microsoft.graph.entraRecoveryServices.recoveryAction The type of recovery action to be performed on this object. The possible values are: softDelete, update, restore, unknownFutureValue. Supports $filter (eq, ne).

Additional properties

In addition to the properties listed above, the following dynamic properties are included in responses:

  • deltaFromCurrent - Contains the changes that will be applied during recovery, typed as the entity being modified (e.g., microsoft.graph.user).
  • currentState - Contains the current state of the object for comparison, typed as the entity being modified.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.entraRecoveryServices.recoveryChangeObjectBase",
  "id": "String (identifier)",
  "entityTypeName": "String",
  "displayName": "String",
  "recoveryAction": "String",
  "failureMessage": "String"
}