Restore-MgDirectoryDeletedItem
Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups can't be restored. Also, restoring an application doesn't restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted.
Note
To view the beta release of this cmdlet, view Restore-MgBetaDirectoryDeletedItem
Syntax
Restore (Default)
Restore-MgDirectoryDeletedItem
-DirectoryObjectId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RestoreViaIdentity
Restore-MgDirectoryDeletedItem
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. However, security groups can't be restored. Also, restoring an application doesn't restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | User.DeleteRestore.All, User.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | User.DeleteRestore.All, User.ReadWrite.All, |
Examples
Example 1: Restore a deleted item
Import-Module Microsoft.Graph.Identity.DirectoryManagement
Restore-MgDirectoryDeletedItem -DirectoryObjectId $directoryObjectId
This example will restore a deleted item
Example 2: Restore a deleted item and remove any conflicting proxy addresses
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
autoReconcileProxyConflict = $true
}
Restore-MgDirectoryDeletedItem -DirectoryObjectId $directoryObjectId -BodyParameter $params
This example will restore a deleted item and remove any conflicting proxy addresses
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| 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 |
-DirectoryObjectId
The unique identifier of directoryObject
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Restore
| Position: | Named |
| Mandatory: | True |
| 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: | IDictionary |
| Default value: | None |
| 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 |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IIdentityDirectoryManagementIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RestoreViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | String |
| Default value: | None |
| 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 |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| 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
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryObject
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.
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[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[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[RoleTemplateId <String>]: Alternate key of directoryRole[ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership[SubscribedSkuId <String>]: The unique identifier of subscribedSku[TenantId <String>]: Usage: tenantId='{tenantId}'[UserId <String>]: The unique identifier of user