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

名前空間: microsoft.graph

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

現在、削除されたアイテムの機能は、 アプリケーション、 servicePrincipal、 グループ、 およびユーザー リソースでのみサポートされています。

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

アクセス許可

アプリケーションが directoryObject 型のコレクションを返す関係をクエリするときに、特定の派生型 (デバイスなど) を読み取るアクセス許可がない場合、その型のメンバーが返されますが、情報は限られます。 この動作により、アプリケーションは、Directory.* 権限が付与されたアクセス許可のセットに依存するのではなく、必要な最小限のアクセス許可を要求できます。 詳細については、「アクセスできないメンバー オブジェクトについて、限定された情報が返される」を参照してください。

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アプリケーションとサービス プリンシパルの場合:

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Application.Read.All、Application.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Application.Read.All、Application.ReadWrite.All、Directory.Read.All

ユーザーの場合:

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	User.Read.All、User.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	User.Read.All、User.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All

グループの場合:

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Group.Read.All、Group.ReadWrite.All、Directory.Read.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Group.Read.All、Group.ReadWrite.All、Directory.Read.All

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.device

現在、この API は、削除されたアイテムからオブジェクトの種類のアプリケーション (microsoft.graph.application)、servicePrincipals (microsoft.graph.serviceprincipal)、グループ (microsoft.graph.groupまたはユーザー ) のmicrosoft.graph.user取得をサポートしています。 OData キャスト型は URI の必須部分であり、型のない呼び出し GET /directory/deleteditems はサポート されていません 。

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

このメソッドは、OData キャストで指定されたリソースでサポートされているクエリ パラメーターをサポートします。 つまり、パラメーター 、$count、、 $orderBy``$top $expand``$filter``$search``$selectクエリパラメーターです。 クエリの中には、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クエリ パラメーターが使用されるため、$orderByConsistencyLevel ヘッダーが必要です。

$orderBy OData クエリ パラメーターの使用例

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

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	ベアラー <コード> が 必要
承諾	application/json

要求本文

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

応答

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

例

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

要求

GET https://graph.microsoft.com/v1.0/directory/deletedItems/microsoft.graph.group

応答

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

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$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 プロパティで結果を並べ替える

要求

HTTP

GET https://graph.microsoft.com/v1.0/directory/deletedItems/microsoft.graph.group?$count=true&$orderBy=deletedDateTime asc&$select=id,DisplayName,deletedDateTime
ConsistencyLevel: eventual

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var queryOptions = new List<QueryOption>()
{
    new QueryOption("$count", "true")
};

var group = await graphClient.Directory.DeletedItems
    .Request( queryOptions )
    .Header("ConsistencyLevel","eventual")
    .Select("id,displayName,deletedDateTime")
    .OrderBy("deletedDateTime asc")
    .GetAsync();

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

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

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

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

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/directory/deletedItems/microsoft.graph.group?$count=true&$orderBy=deletedDateTime%20asc&$select=id,DisplayName,deletedDateTime"]]];
[urlRequest setHTTPMethod:@"GET"];
[urlRequest setValue:@"eventual" forHTTPHeaderField:@"ConsistencyLevel"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphGroup *group = [[MSGraphGroup alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];

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

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new HeaderOption("ConsistencyLevel", "eventual"));

GroupCollectionPage group = graphClient.directory().deletedItems().microsoft.graph.group()
    .buildRequest( requestOptions )
    .select("id,displayName,deletedDateTime")
    .orderBy("deletedDateTime asc")
    .get();

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

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestParameters := &msgraphsdk.GroupRequestBuilderGetQueryParameters{
    Count: true,
    OrderBy: "deletedDateTime%20asc",
    Select: "id,DisplayName,deletedDateTime",
}
headers := map[string]string{
    "ConsistencyLevel": "eventual"
}
options := &msgraphsdk.GroupRequestBuilderGetRequestConfiguration{
    QueryParameters: requestParameters,
    Headers: headers,
}
result, err := graphClient.Directory().DeletedItems().Group().GetWithRequestConfigurationAndResponseHandler(options, nil)

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

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDirectoryDeletedItem -DirectoryObjectId $directoryObjectId -CountVariable CountVar -Sort "deletedDateTime asc" -Property "id,DisplayName,deletedDateTime" 

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

応答

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$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"
        }
    ]
}