DocumentOperationsExtensions.Get Method (IDocumentOperations, String, IEnumerable)

Article
03/04/2015
2 minutes to read

Retrieves a document from the Azure Search index. (see https://msdn.microsoft.com/en-us/library/azure/dn798929.aspx for more information)

Namespace: Microsoft.Azure.Search
Assembly: Microsoft.Azure.Search (in Microsoft.Azure.Search.dll)

Usage

'Usage
Dim operations As IDocumentOperations
Dim key As String
Dim selectedFields As IEnumerable(Of String)
Dim returnValue As DocumentGetResponse

returnValue = DocumentOperationsExtensions.Get(operations, key, selectedFields)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Get ( _
    operations As IDocumentOperations, _
    key As String, _
    selectedFields As IEnumerable(Of String) _
) As DocumentGetResponse

[ExtensionAttribute] 
public static DocumentGetResponse Get (
    IDocumentOperations operations,
    string key,
    IEnumerable<string> selectedFields
)

[ExtensionAttribute] 
public:
static DocumentGetResponse^ Get (
    IDocumentOperations^ operations, 
    String^ key, 
    IEnumerable<String^>^ selectedFields
)

/** @attribute ExtensionAttribute() */ 
public static DocumentGetResponse Get (
    IDocumentOperations operations, 
    String key, 
    IEnumerable<String> selectedFields
)

ExtensionAttribute 
public static function Get (
    operations : IDocumentOperations, 
    key : String, 
    selectedFields : IEnumerable<String>
) : DocumentGetResponse

Parameters

key
The key of the document to retrieve; See https://msdn.microsoft.com/en-us/library/azure/dn857353.aspx for the rules for constructing valid document keys.

selectedFields
List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.

Return Value

Response containing the document.

Remarks

The non-generic overloads of the Get and GetAsync methods make a best-effort attempt to map JSON types in the response payload to .NET types. See GetAsync(String,Generic IEnumerable,CancellationToken) for more information.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012