IDocumentClient.ReadUserAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
ReadUserAsync(String, RequestOptions) |
Liest einen User aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
ReadUserAsync(Uri, RequestOptions) |
Liest einen User als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst. |
ReadUserAsync(String, RequestOptions)
Liest einen User aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (string userLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
Public Function ReadUserAsync (userLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))
Parameter
- userLink
- String
Der Link zur zu lesenden Benutzerressource.
- options
- RequestOptions
(Optional) Die Anforderungsoptionen für die Anforderung.
Gibt zurück
Eine System.Threading.Tasks , die einen ResourceResponse<TResource> enthält, der einen User umschließt, der den Leseressourcendatensatz enthält.
Ausnahmen
Wenn userLink
nicht festgelegt ist.
Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:
StatusCode | Ausnahmegrund |
---|---|
404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//Reads a User resource from a Database
// - sample_database is the ID of the database
// - user_id is the ID of the user to be read
var userLink = "/dbs/sample_database/users/user_id";
User user = await client.ReadUserAsync(userLink);
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 anstelle einer Abfrage nach ID einen Lesevorgang durch.
Das gezeigte Beispiel verwendet ID-basierte Links, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können die SelfLink Eigenschaft des Benutzers weiterhin 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 userLink
ist immer "/dbs/{db identifier}/users/{user identifier}", nur die Werte innerhalb des {...}-Werts ändern sich je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.
Weitere Informationen
Gilt für:
ReadUserAsync(Uri, RequestOptions)
Liest einen User als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (Uri userUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
Public Function ReadUserAsync (userUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))
Parameter
- userUri
- Uri
Ein URI für die zu lesende Benutzerressource.
- options
- RequestOptions
Die Anforderungsoptionen für die Anforderung.
Gibt zurück
Eine System.Threading.Tasks , die einen ResourceResponse<TResource> enthält, der einen User umschließt, der den Leseressourcendatensatz enthält.
Ausnahmen
Wenn userUri
nicht festgelegt ist.
Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:
StatusCode | Ausnahmegrund |
---|---|
404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//Reads a User resource where
// - db_id is the ID property of the Database
// - user_id is the ID property of the User you wish to read.
var userLink = UriFactory.CreateUserUri("db_id", "user_id");
User user = await client.ReadUserAsync(userLink);
Hinweise
Das Lesen einer Ressource ist die effizienteste Möglichkeit, eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie anstelle einer Abfrage nach ID einen Lesevorgang durch.
Weitere Informationen
Gilt für:
Azure SDK for .NET