DocumentsOperationsExtensions.GetAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Search

Assembly:

Microsoft.Azure.Search.Data.dll

Paquet:

Microsoft.Azure.Search.Data v10.1.0

Surcharges

GetAsync(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)	Récupère un document à partir de l’index de recherche. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document
GetAsync<T>(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)	Récupère un document à partir de l’index de recherche. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

GetAsync(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)

Source:

DocumentsOperationsExtensions.cs

Récupère un document à partir de l’index de recherche. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

public static System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.Document> GetAsync (this Microsoft.Azure.Search.IDocumentsOperations operations, string key, System.Collections.Generic.IEnumerable<string> selectedFields = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member GetAsync : Microsoft.Azure.Search.IDocumentsOperations * string * seq<string> * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Search.Models.Document>

<Extension()>
Public Function GetAsync (operations As IDocumentsOperations, key As String, Optional selectedFields As IEnumerable(Of String) = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Document)

Paramètres

operations

IDocumentsOperations

Groupe d’opérations pour cette méthode d’extension.

key

String

Clé du document à récupérer ; Consultez https://docs.microsoft.com/rest/api/searchservice/Naming-rules pour connaître les règles de construction de clés de document valides.

selectedFields

IEnumerable<String>

Liste des noms de champs à récupérer pour le document ; Tout champ non récupéré sera manquant dans le document retourné.

searchRequestOptions

SearchRequestOptions

Paramètres supplémentaires pour l’opération

cancellationToken

CancellationToken

Jeton d'annulation.

Retours

Task<Document>

Document demandé.

Remarques

Les surcharges non génériques des méthodes Get, GetAsync et GetWithHttpMessagesAsync permettent de mapper au mieux les types JSON dans la charge utile de réponse aux types .NET. Consultez la rubrique GetWithHttpMessagesAsync(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) (éventuellement en anglais) pour plus d'informations.

GetAsync<T>(IDocumentsOperations, String, IEnumerable<String>, SearchRequestOptions, CancellationToken)

Source:

DocumentsOperationsExtensions.cs

Récupère un document à partir de l’index de recherche. https://docs.microsoft.com/rest/api/searchservice/Lookup-Document

public static System.Threading.Tasks.Task<T> GetAsync<T> (this Microsoft.Azure.Search.IDocumentsOperations operations, string key, System.Collections.Generic.IEnumerable<string> selectedFields = default, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member GetAsync : Microsoft.Azure.Search.IDocumentsOperations * string * seq<string> * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>

<Extension()>
Public Function GetAsync(Of T) (operations As IDocumentsOperations, key As String, Optional selectedFields As IEnumerable(Of String) = Nothing, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)

Paramètres de type

T

Le type CLR qui mappe vers le schéma d'index. Les instances de ce type peuvent être récupérées en tant que documents à partir de l’index.

Paramètres

operations

IDocumentsOperations

Groupe d’opérations pour cette méthode d’extension.

key

String

Clé du document à récupérer ; Consultez https://docs.microsoft.com/rest/api/searchservice/Naming-rules pour connaître les règles de construction de clés de document valides.

selectedFields

IEnumerable<String>

Liste des noms de champs à récupérer pour le document ; Tout champ non récupéré aura null ou valeur par défaut comme valeur de propriété correspondante dans l’objet retourné. Tous les champs récupérables sont inclus dans le résultat par défaut.

searchRequestOptions

SearchRequestOptions

Paramètres supplémentaires pour l’opération

cancellationToken

CancellationToken

Jeton d'annulation.

Retours

Task<T>

Document demandé.

Remarques

Les surcharges génériques des méthodes Get, GetAsync et GetWithHttpMessagesAsync prennent en charge le mappage des types de champs Recherche Azure aux types .NET via le paramètre de type T. Pour plus d’informations sur le mappage de type, consultez GetWithHttpMessagesAsync<T>(String, IEnumerable<String>, SearchRequestOptions, Dictionary<String,List<String>>, CancellationToken) .