deletedItems (ディレクトリオブジェクト) を一覧表示する

[アーティクル]
07/05/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

最近削除されたディレクトリオブジェクトの一覧を取得します。現在、削除されたアイテムの機能は、アプリケーション、 servicePrincipal、 externalUserProfile、グループ、管理単位、 pendingExternalUserProfile、およびユーザーリソースでのみサポートされています。

メモ： 削除されたセキュリティグループは完全に削除され、この API を使用して取得することはできません。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可またはアクセス許可を示しています。ベストプラクティスに従って、最小限の特権のアクセス許可を要求します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

サポートされているリソース	委任 (職場または学校のアカウント)	委任 (個人用 Microsoft アカウント)	アプリケーション
administrativeUnit	AdministrativeUnit.Read.All	サポートされていません。	AdministrativeUnit.Read.All
application	Application.Read.All	サポートされていません。	Application.Read.All
externalUserProfile	ExternalUserProfile.Read.All	非サポート	ExternalUserProfile.Read.All
グループ	Group.Read.All	サポートされていません。	Group.Read.All
pendingExternalUserProfile	PendingExternalUserProfile.Read.All	非サポート	PendingExternalUserProfile.Read.All
servicePrincipal	Application.Read.All	サポートされていません。	Application.Read.All
user	User.Read.All	サポートされていません。	User.Read.All

重要

アプリケーションが directoryObject 型コレクションを返すリレーションシップを照会するときに、特定のリソースの種類を読み取るアクセス許可がない場合、その型のメンバーは返されますが、情報は限られています。たとえば、オブジェクト型と id の @odata.type プロパティのみが返されますが、他のプロパティはとしてnull示されます。この動作により、アプリケーションはディレクトリのセットに依存するのではなく、必要な最小限の特権のアクセス許可を要求できます。*アクセス許可。詳細については、「アクセスできないメンバーオブジェクトについて、限定された情報が返される」を参照してください。

HTTP 要求

GET /directory/deleteditems/microsoft.graph.application
GET /directory/deleteditems/microsoft.graph.servicePrincipal
GET /directory/deleteditems/microsoft.graph.group
GET /directory/deletedItems/microsoft.graph.user
GET /directory/deletedItems/microsoft.graph.administrativeUnit
GET /directory/deletedItems/microsoft.graph.externalUserProfile
GET /directory/deletedItems/microsoft.graph.pendingExternalUserProfile

OData キャスト型は URI の必須部分であり、型なしでの呼び出し GET /directory/deleteditems はサポート されていません 。

オプションのクエリパラメーター

このメソッドは、OData キャストによって指定されたリソースでサポートされるクエリパラメーターをサポートします。つまり、$count$expand、$filter、、$search$orderby$selectおよび$topクエリパラメーターです。この API は、既定で 100 個のオブジェクトを返し、を使用して $topページあたり最大 999 個のオブジェクトを返します。

クエリの中には、ConsistencyLevel ヘッダーの設定を eventual および $count に使用した場合にのみサポートされるものもあります。例:

https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?&$count=true&$orderby=deletedDateTime desc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual

この例では、パラメーターと $count クエリパラメーターがクエリで使用されるため$orderby、ConsistencyLevel ヘッダーが必要です。

OData クエリパラメーターの例を$orderbyする

$orderby OData クエリパラメーターは、削除されたオブジェクト型の deletedDateTime、displayName、userPrincipalName プロパティでサポートされています。 deletedDateTime プロパティでは、クエリで高度なクエリパラメーター (ConsistencyLevel ヘッダーがに設定され、$count=trueクエリ文字列) を追加するeventual必要があります。

OData キャスト	$orderbyをサポートするプロパティ	例
microsoft.graph.user	deletedDateTime、displayName、userPrincipalName	/directory/deletedItems/microsoft.graph.user?$orderby=userPrincipalName
microsoft.graph.group	deletedDateTime、displayName	/directory/deletedItems/microsoft.graph.group?$orderby=deletedDateTime asc&$count=true
microsoft.graph.application	deletedDateTime、displayName	/directory/deletedItems/microsoft.graph.application?$orderby=displayName
microsoft.graph.device	deletedDateTime、displayName	/directory/deletedItems/microsoft.graph.device?$orderby=deletedDateTime&$count=true

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。
承諾	application/json

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で directoryObject オブジェクトのコレクションを返します。

例

例 1: 削除されたグループを取得する

要求

GET https://graph.microsoft.com/beta/directory/deleteditems/microsoft.graph.group


// 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.GraphGroup.GetAsync();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta directory deleted-items graph-group get

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



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

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphGroup, err := graphClient.Directory().DeletedItems().GraphGroup().Get(context.Background(), nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

GroupCollectionResponse result = graphClient.directory().deletedItems().graphGroup().get();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

let group = await client.api('/directory/deleteditems/microsoft.graph.group')
	.version('beta')
	.get();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


$result = $graphServiceClient->directory()->deletedItems()->graphGroup()->get()->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

Get-MgBetaDirectoryDeletedItemAsGroup

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta 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.graph_group.get()

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

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

例 2: 削除されたユーザーオブジェクトの数を取得し、deletedDateTime プロパティで結果を並べ替える

要求

GET https://graph.microsoft.com/beta/directory/deletedItems/microsoft.graph.group?$count=true&$orderby=deletedDateTime asc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual


// 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.GraphGroup.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Count = true;
	requestConfiguration.QueryParameters.Orderby = new string []{ "deletedDateTime asc" };
	requestConfiguration.QueryParameters.Select = new string []{ "id","displayName","deletedDateTime" };
	requestConfiguration.Headers.Add("ConsistencyLevel", "eventual");
});

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta directory deleted-items graph-group get --count "true" --orderby "deletedDateTime asc" --select "id,displayName,deletedDateTime"

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



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

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

headers := abstractions.NewRequestHeaders()
headers.Add("ConsistencyLevel", "eventual")


requestCount := true

requestParameters := &graphdirectory.DirectoryDeletedItemsGraph.groupRequestBuilderGetQueryParameters{
	Count: &requestCount,
	Orderby: [] string {"deletedDateTime asc"},
	Select: [] string {"id","displayName","deletedDateTime"},
}
configuration := &graphdirectory.DirectoryDeletedItemsGraph.groupRequestBuilderGetRequestConfiguration{
	Headers: headers,
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphGroup, err := graphClient.Directory().DeletedItems().GraphGroup().Get(context.Background(), configuration)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

GroupCollectionResponse result = graphClient.directory().deletedItems().graphGroup().get(requestConfiguration -> {
	requestConfiguration.queryParameters.count = true;
	requestConfiguration.queryParameters.orderby = new String []{"deletedDateTime asc"};
	requestConfiguration.queryParameters.select = new String []{"id", "displayName", "deletedDateTime"};
	requestConfiguration.headers.add("ConsistencyLevel", "eventual");
});

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

let group = await client.api('/directory/deletedItems/microsoft.graph.group')
	.version('beta')
	.header('ConsistencyLevel','eventual')
	.select('id,displayName,deletedDateTime')
	.orderby('deletedDateTime asc')
	.get();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Directory\DeletedItems\Graph\Group\GroupRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new GraphGroupRequestBuilderGetRequestConfiguration();
$headers = [
		'ConsistencyLevel' => 'eventual',
	];
$requestConfiguration->headers = $headers;

$queryParameters = GraphGroupRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->count = true;
$queryParameters->orderby = ["deletedDateTime asc"];
$queryParameters->select = ["id","displayName","deletedDateTime"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->directory()->deletedItems()->graphGroup()->get($requestConfiguration)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

Get-MgBetaDirectoryDeletedItemAsGroup -CountVariable CountVar -Sort "deletedDateTime asc" -Property "id,displayName,deletedDateTime"

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.directory.deleted_items.graph.group.group_request_builder import GroupRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = GroupRequestBuilder.GroupRequestBuilderGetQueryParameters(
		count = True,
		orderby = ["deletedDateTime asc"],
		select = ["id","displayName","deletedDateTime"],
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)
request_configuration.headers.add("ConsistencyLevel", "eventual")


result = await graph_client.directory.deleted_items.graph_group.get(request_configuration = request_configuration)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(id,displayName,deletedDateTime)",
    "@odata.count": 2,
    "value": [
        {
            "id": "c31799b8-0683-4d70-9e91-e032c89d3035",
            "displayName": "Role assignable group",
            "deletedDateTime": "2021-10-26T16:56:36Z"
        },
        {
            "id": "74e45ce0-a52a-4766-976c-7201b0f99370",
            "displayName": "Role assignable group",
            "deletedDateTime": "2021-10-26T16:58:37Z"
        }
    ]
}

次の方法で共有

deletedItems (ディレクトリオブジェクト) を一覧表示する

アクセス許可

HTTP 要求

オプションのクエリパラメーター

OData クエリパラメーターの例を$orderbyする

要求ヘッダー

要求本文

応答

例

例 1: 削除されたグループを取得する

要求

応答

例 2: 削除されたユーザーオブジェクトの数を取得し、deletedDateTime プロパティで結果を並べ替える

要求

応答

フィードバック

その他のリソース

次の方法で共有

deletedItems (ディレクトリ オブジェクト) を一覧表示する

アクセス許可

HTTP 要求

オプションのクエリ パラメーター

OData クエリ パラメーターの例を$orderbyする

要求ヘッダー

要求本文

応答

例

例 1: 削除されたグループを取得する

要求

応答

例 2: 削除されたユーザー オブジェクトの数を取得し、deletedDateTime プロパティで結果を並べ替える

要求

応答

フィードバック

その他のリソース

deletedItems (ディレクトリオブジェクト) を一覧表示する

オプションのクエリパラメーター

OData クエリパラメーターの例を$orderbyする

例 2: 削除されたユーザーオブジェクトの数を取得し、deletedDateTime プロパティで結果を並べ替える