IDocumentClient.ReadDocumentAsync Methode

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReadDocumentAsync (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>

Public Function ReadDocumentAsync (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

Parameter

Gibt zurück

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen Document umschließt, der den gelesenen Ressourcendatensatz enthält.

Ausnahmen

Beispiele

//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Document doc = await client.ReadDocumentAsync(docLink);

Hinweise

Das Lesen einer Ressource ist die effizienteste Methode, um eine Ressource aus der Datenbank abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie einen Lesevorgang anstelle einer Abfrage nach ID durch.

Im gezeigten Beispiel werden ID-basierte Links verwendet, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können weiterhin die SelfLink -Eigenschaft des Dokuments verwenden, wenn Sie möchten. Eine Selbstverknüpfung ist ein URI für eine Ressource, die aus Ressourcenbezeichnern (oder den _rid Eigenschaften) besteht. ID-basierte Links und SelfLink funktionieren beide. Das Format für documentLink ist immer "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" nur die Werte innerhalb der {} Änderung, je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.

Weitere Informationen

• ResourceResponse<TResource>
• Task
• Uri
• Document
• RequestOptions

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReadDocumentAsync (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>

Public Function ReadDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

Parameter

Gibt zurück

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen Document umschließt, der den gelesenen Ressourcendatensatz enthält.

Ausnahmen

Beispiele

//Reads a Document resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read. 
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Document document = await client.ReadDocumentAsync(docUri);

Hinweise

Das Lesen einer Ressource ist die effizienteste Methode, um eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie einen Lesevorgang anstelle einer Abfrage nach ID durch.

Weitere Informationen

• Document
• RequestOptions
• ResourceResponse<TResource>
• Task

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>

Public Function ReadDocumentAsync(Of T) (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))

Typparameter

Parameter

Gibt zurück

Eine System.Threading.Tasks , die ein DocumentResponse<TDocument> enthält, das einen Document umschließt, der den gelesenen Ressourcendatensatz enthält.

Ausnahmen

Beispiele

//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Customer customer = await client.ReadDocumentAsync<Customer>(docLink);

Hinweise

Das Lesen einer Ressource ist die effizienteste Methode, um eine Ressource aus der Datenbank abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie einen Lesevorgang anstelle einer Abfrage nach ID durch.

Im gezeigten Beispiel werden ID-basierte Links verwendet, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können weiterhin die SelfLink -Eigenschaft des Dokuments verwenden, wenn Sie möchten. Eine Selbstverknüpfung ist ein URI für eine Ressource, die aus Ressourcenbezeichnern (oder den _rid Eigenschaften) besteht. ID-basierte Links und SelfLink funktionieren beide. Das Format für documentLink ist immer "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" nur die Werte innerhalb der {} Änderung, je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.

Weitere Informationen

• DocumentResponse<TDocument>
• Task
• Uri
• Document
• RequestOptions

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>

Public Function ReadDocumentAsync(Of T) (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))

Typparameter

Parameter

Gibt zurück

Eine System.Threading.Tasks , die ein DocumentResponse<TDocument> enthält, das einen Document umschließt, der den gelesenen Ressourcendatensatz enthält.

Ausnahmen

Beispiele

//Reads a Document resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read. 
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Customer customer = await client.ReadDocumentAsync<Customer>(docUri);

Hinweise

Das Lesen einer Ressource ist die effizienteste Methode, um eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie einen Lesevorgang anstelle einer Abfrage nach ID durch.

Weitere Informationen

• Document
• RequestOptions
• DocumentResponse<TDocument>
• Task