Restaurar item eliminado (objeto de diretório)

Namespace: microsoft.graph

Restaure uma aplicação, grupo, servicePrincipal, unidade administrativa ou objeto de utilizador recentemente eliminado a partir de itens eliminados. Se um item foi excluído acidentalmente, você poderá restaurá-lo totalmente. No entanto, os grupos de segurança não podem ser restaurados. Além disso, restaurar uma aplicação não restaura automaticamente o principal de serviço associado. Tem de chamar esta API para restaurar explicitamente o principal de serviço eliminado.

Um item eliminado recentemente permanece disponível até 30 dias. Após 30 dias, esse item será excluído permanentemente.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

A tabela seguinte mostra as permissões ou permissões com menos privilégios necessárias para chamar esta API em cada tipo de recurso suportado. Siga as melhores práticas para pedir permissões com menos privilégios. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Recurso com suporte	Delegada (conta corporativa ou de estudante)	Delegada (conta pessoal da Microsoft)	Application
administrativeUnit	AdministrativeUnit.ReadWrite.All	Sem suporte.	AdministrativeUnit.ReadWrite.All
application	Application.ReadWrite.All	Sem suporte.	Application.ReadWrite.OwnedBy
grupo	Group.ReadWrite.All	Sem suporte.	Group.ReadWrite.All
servicePrincipal	Application.ReadWrite.All	Sem suporte.	Application.ReadWrite.OwnedBy
user	User.DeleteRestore.All	Sem suporte.	User.DeleteRestore.All

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

• Para restaurar aplicações eliminadas ou principais de serviço: Administrador de Aplicações, Administrador de Aplicações na Cloud ou Administrador de Identidade Híbrida.
• Para restaurar utilizadores eliminados: Administrador de Utilizadores. No entanto, para restaurar utilizadores com funções de administrador com privilégios:
  • Em cenários delegados, a aplicação tem de ter a permissão Directory.AccessAsUser.All delegated e o utilizador de chamada também tem de ter uma função de administrador com privilégios superior, conforme indicado em Quem pode realizar ações confidenciais?.
  • Em cenários apenas de aplicações e para além de lhe ser concedida a permissão de aplicação User.ReadWrite.All , a aplicação tem de ter uma função de administrador com privilégios superior, conforme indicado em Quem pode realizar ações confidenciais?.
• Para restaurar grupos eliminados: Grupos Administrador. No entanto, para restaurar grupos atribuíveis a funções, tem de ser atribuída ao utilizador de chamada a função Administrador de Função Privilegiada .

Solicitação HTTP

HTTP

POST /directory/deletedItems/{id}/restore

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-type	application/json

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON dos parâmetros.

A tabela seguinte lista os parâmetros que são necessários quando chama esta ação.

Parâmetro	Tipo	Descrição
autoReconcileProxyConflict	Booliano	Parâmetro opcional. Indica se Microsoft Entra ID deve remover quaisquer endereços proxy em conflito ao restaurar um utilizador eliminado de forma recuperável cujos endereços proxy são atualmente utilizados para um utilizador ativo. Utilizado apenas para restaurar objetos de utilizador eliminados de forma recuperável. O valor predefinido para este parâmetro é false.

Resposta

Se bem-sucedido, este método retorna um código de resposta 200 OK e um objeto directoryObject no corpo da resposta.

Exemplos

Exemplo 1: Restaurar um item eliminado

Solicitação

HTTP

HTTP

POST https://graph.microsoft.com/v1.0/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore

C#

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.DeletedItems["{directoryObject-id}"].Restore.PostAsync();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

Bash

mgc directory deleted-items restore post --directory-object-id {directoryObject-id}

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
restore, err := graphClient.Directory().DeletedItems().ByDirectoryObjectId("directoryObject-id").Restore().Post(context.Background(), nil)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.directory().deletedItems().byDirectoryObjectId("{directoryObject-id}").restore().post();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore')
	.post();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->directory()->deletedItems()->byDirectoryObjectId('directoryObject-id')->restore()->post()->wait();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Restore-MgDirectoryDeletedItem -DirectoryObjectId $directoryObjectId

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.directory.deleted_items.by_directory_object_id('directoryObject-id').restore.post()

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects/$entity",
  "@odata.type":"#microsoft.graph.group",
  "id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
  "displayName":"SampleGroup",
  "groupTypes":["Unified"],
  "mail":"example@contoso.com",
  "mailEnabled":true,
  "mailNickname":"Example",
  "securityEnabled":false,
  "visibility":"Public"
}

Exemplo 2: Restaurar um item eliminado e remover quaisquer endereços proxy em conflito

Solicitação

HTTP

HTTP

POST https://graph.microsoft.com/v1.0/directory/deleteditems/78bf875b-9343-4edc-9130-0d3958113563/restore
Content-Type: application/json

{
  "autoReconcileProxyConflict": true
}

C#

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.DirectoryNamespace.DeletedItems.Item.Restore;

var requestBody = new RestorePostRequestBody
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"autoReconcileProxyConflict" , true
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.DeletedItems["{directoryObject-id}"].Restore.PostAsync(requestBody);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

Bash

mgc directory deleted-items restore post --directory-object-id {directoryObject-id} --body '{\
  "autoReconcileProxyConflict": true\
}\
'

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdirectory "github.com/microsoftgraph/msgraph-sdk-go/directory"
	  //other-imports
)

requestBody := graphdirectory.NewRestorePostRequestBody()
additionalData := map[string]interface{}{
	autoReconcileProxyConflict := true
requestBody.SetAutoReconcileProxyConflict(&autoReconcileProxyConflict) 
}
requestBody.SetAdditionalData(additionalData)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
restore, err := graphClient.Directory().DeletedItems().ByDirectoryObjectId("directoryObject-id").Restore().Post(context.Background(), requestBody, nil)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.directory.deleteditems.item.restore.RestorePostRequestBody restorePostRequestBody = new com.microsoft.graph.directory.deleteditems.item.restore.RestorePostRequestBody();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("autoReconcileProxyConflict", true);
restorePostRequestBody.setAdditionalData(additionalData);
var result = graphClient.directory().deletedItems().byDirectoryObjectId("{directoryObject-id}").restore().post(restorePostRequestBody);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const directoryObject = {
  autoReconcileProxyConflict: true
};

await client.api('/directory/deleteditems/78bf875b-9343-4edc-9130-0d3958113563/restore')
	.post(directoryObject);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Directory\DeletedItems\Item\Restore\RestorePostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new RestorePostRequestBody();
$additionalData = [
	'autoReconcileProxyConflict' => true,
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->directory()->deletedItems()->byDirectoryObjectId('directoryObject-id')->restore()->post($requestBody)->wait();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	autoReconcileProxyConflict = $true
}

Restore-MgDirectoryDeletedItem -DirectoryObjectId $directoryObjectId -BodyParameter $params

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.directory.deleteditems.item.restore.restore_post_request_body import RestorePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RestorePostRequestBody(
	additional_data = {
			"auto_reconcile_proxy_conflict" : True,
	}
)

result = await graph_client.directory.deleted_items.by_directory_object_id('directoryObject-id').restore.post(request_body)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
    "@odata.type": "#microsoft.graph.user",
    "id": "78bf875b-9343-4edc-9130-0d3958113563",
    "businessPhones": [],
    "displayName": "SampleUser",
    "givenName": "Sample",
    "jobTitle": "Product Marketing Manager",
    "mail": "sampleuser@contoso.com",
    "mobilePhone": "+1 425 555 0109",
    "officeLocation": "18/2111",
    "preferredLanguage": "en-US",
    "surname": "Vance",
    "userPrincipalName": "sampleuser@contoso.com"
}