Recherche pour les éléments de lecteur dans un lecteur

Article
10/02/2023

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Recherchez la hiérarchie des éléments pour des éléments correspondant à une requête. Vous pouvez effectuer une recherche dans une hiérarchie de dossiers, un lecteur entier ou des fichiers partagés avec l’utilisateur actuel.

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Files.Read	Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Déléguée (compte Microsoft personnel)	Files.Read	Files.Read.All, Files.ReadWrite, Files.ReadWrite.All
Application	Files.Read.All	Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Remarque : Cette méthode ne prend pas en charge l’autorisation d’application Sites.Selected.

Requête HTTP

GET /drives/{drive-id}/root/search(q='{search-text}')
GET /groups/{group-id}/drive/root/search(q='{search-text}')
GET /me/drive/root/search(q='{search-text}')
GET /sites/{site-id}/drive/root/search(q='{search-text}')
GET /users/{user-id}/drive/root/search(q='{search-text}')

Paramètres facultatifs de la requête

Cette méthode prend en charge les $expandparamètres de requête , $select$skipToken, $top, et $orderbyOData pour personnaliser la réponse.

Paramètres de fonction

Paramètre	Type	Description
q	string	Texte de requête utilisé pour rechercher des éléments. Les valeurs peuvent être mises en correspondance sur plusieurs champs, y compris le nom de fichier, les métadonnées et le contenu du fichier.

Exemple

Demande

L’exemple suivant recherche un résultat pour « Projet Contoso » dans plusieurs champs dans les éléments du drive de l’utilisateur connecté.

GET /me/drive/root/search(q='Contoso Project')


// 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.Drives["{drive-id}"].Items["{driveItem-id}"].SearchWithQ("{q}").GetAsSearchWithQGetResponseAsync();

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta drives items search-with-q get --q {q-id} --drive-id {drive-id} --drive-item-id {driveItem-id}

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



q := "{q}"
search, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").SearchWithQ(&q).GetAsSearchWithQGetResponse(context.Background(), nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").searchWithQ("{q}").get();

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let search = await client.api('/me/drive/root/search(q='Contoso Project')')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->searchWithQ('{q}', )->get()->wait();

Importante


Import-Module Microsoft.Graph.Beta.Files

Search-MgBetaDriveItem -DriveId $driveId -DriveItemId $driveItemId

Importante


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').search_with_q("{q}").get()

Importante

Réponse

Cette méthode renvoie un objet qui contient une collection d’objets DriveItem qui correspondent aux critères de recherche. Si aucun élément n’est trouvé, une collection vide est renvoyée.

S’il y a trop de correspondances, la réponse sera être paginée et une propriété @odata.nextLink contiendra une URL vers la page de résultats suivante. Vous pouvez utiliser le paramètre de requête $top pour spécifier le nombre d’éléments dans la page.

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

{
    "value": [
      {
        "id": "0123456789abc!123",
        "name": "Contoso Project",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!123" }
      },
      {
        "id": "0123456789abc!456",
        "name": "Contoso Project 2016",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!456" }
      }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd"
}

Recherche d’éléments auxquels peut accéder un utilisateur

Outre la recherche d’éléments dans un lecteur, votre application peut effectuer une recherche plus large pour inclure des éléments partagés avec l’utilisateur actuel. Pour élargir l’étendue de recherche, utilisez la méthode de recherche sur la ressource Drive.

Exemple

GET /me/drive/search(q='Contoso Project')


// 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.Drives["{drive-id}"].SearchWithQ("{q}").GetAsSearchWithQGetResponseAsync();

Importante


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta drives search-with-q get --q {q-id} --drive-id {drive-id}

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



q := "{q}"
search, err := graphClient.Drives().ByDriveId("drive-id").SearchWithQ(&q).GetAsSearchWithQGetResponse(context.Background(), nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.drives().byDriveId("{drive-id}").searchWithQ("{q}").get();

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let search = await client.api('/me/drive/search(q='Contoso Project')')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->drives()->byDriveId('drive-id')->searchWithQ('{q}', )->get()->wait();

Importante


Import-Module Microsoft.Graph.Beta.Files

Search-MgBetaDrive -DriveId $driveId

Importante


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.drives.by_drive_id('drive-id').search_with_q("{q}").get()

Importante

Réponse

Les réponses lors de la recherche à partir de la ressource drive peuvent inclure des éléments à l’extérieur du lecteur (éléments partagés avec l’utilisateur actuel). Ces éléments incluront la facette remoteItem pour indiquer qu’ils sont stockés en dehors du lecteur cible.

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

{
    "value": [
      {
        "id": "0123456789abc!123",
        "name": "Contoso Project",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!123" },
        "remoteItem": { "id": "!23141901", "driveId": "s!1020101jlkjl12lx" }
      },
      {
        "id": "0123456789abc!456",
        "name": "Contoso Project 2016",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!456" }
      }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd"
}

Réponses d’erreur

Pour plus d’informations sur la façon dont les erreurs sont renvoyées, voir Réponses d’erreur.

Recherche pour les éléments de lecteur dans un lecteur

Autorisations

Requête HTTP

Paramètres facultatifs de la requête

Paramètres de fonction

Exemple

Demande

Réponse

Recherche d’éléments auxquels peut accéder un utilisateur

Exemple

Réponse

Réponses d’erreur

Commentaires

Commentaires

Ressources supplémentaires