DocumentClient.ReadUserDefinedFunctionAsync 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
| ReadUserDefinedFunctionAsync(String, RequestOptions) |
Liest einen UserDefinedFunction aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
| ReadUserDefinedFunctionAsync(Uri, RequestOptions) |
Liest einen UserDefinedFunction als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst. |
ReadUserDefinedFunctionAsync(String, RequestOptions)
Liest einen UserDefinedFunction aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionAsync (string functionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.ReadUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>Public Function ReadUserDefinedFunctionAsync (functionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))Parameter
- functionLink
- String
Der Link zur zu lesenden benutzerdefinierten Funktion.
- options
- RequestOptions
(Optional) Die Anforderungsoptionen für die Anforderung.
Gibt zurück
Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen UserDefinedFunction umschließt, der den gelesenen Ressourcendatensatz enthält.
Implementiert
Ausnahmen
Wenn functionLink 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 können, sind:
| StatusCode | Grund für die Ausnahme |
|---|---|
| 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 DocumentClientException.RetryAfter-Wert, um zu sehen, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//Reads a User Defined Function from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - udf_id is the ID of the user-defined function to be read
var udfLink = "/dbs/sample_database/colls/sample_collection/udfs/udf_id";
UserDefinedFunction udf = await client.ReadUserDefinedFunctionAsync(udfLink);
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 der benutzerdefinierten Funktion 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 functionLink lautet immer "/dbs/{db identifier}/colls/{coll identifier}/udfs/{udf identifier}", nur die Werte innerhalb von {...} ändern sich je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.
Weitere Informationen
Gilt für:
ReadUserDefinedFunctionAsync(Uri, RequestOptions)
Liest einen UserDefinedFunction als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionAsync (Uri functionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.ReadUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>Public Function ReadUserDefinedFunctionAsync (functionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))Parameter
- functionUri
- Uri
Ein URI der benutzerdefinierten Funktionsressource, die gelesen werden soll.
- options
- RequestOptions
Die Anforderungsoptionen für die Anforderung.
Gibt zurück
Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen UserDefinedFunction umschließt, der den gelesenen Ressourcendatensatz enthält.
Implementiert
Ausnahmen
Wenn functionUri 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 können, sind:
| StatusCode | Grund für die Ausnahme |
|---|---|
| 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 DocumentClientException.RetryAfter-Wert, um zu sehen, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//Reads a UserDefinedFunction resource where
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - udf_id is the ID property of the UserDefinedFunction you wish to read.
var udfLink = UriFactory.CreateUserDefinedFunctionUri("db_id", "coll_id", "udf_id");
UserDefinedFunction udf = await client.ReadUserDefinedFunctionAsync(udfLink);
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
Gilt für:
Azure SDK for .NET