CosmosScripts.ReadUserDefinedFunctionAsync Methode

Referenz

Definition

Namespace:: Azure.Cosmos.Scripts

Assembly:: Azure.Cosmos.dll

Paket:: Azure.Cosmos v4.0.0-preview3

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.

Liest einen UserDefinedFunctionProperties aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.

public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.UserDefinedFunctionProperties>> ReadUserDefinedFunctionAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadUserDefinedFunctionAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.UserDefinedFunctionProperties>>

Public MustOverride Function ReadUserDefinedFunctionAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UserDefinedFunctionProperties))

Parameter

id: String

Die ID der zu lesenden benutzerdefinierten Funktion

requestOptions: RequestOptions

(Optional) Die Optionen für die benutzerdefinierte Funktionsanforderung RequestOptions

cancellationToken: CancellationToken

(Optional) CancellationToken stellt die Anforderungsabbruch dar.

Gibt zurück

Task<Response<UserDefinedFunctionProperties>>

Eine Task , die einen Response<T> enthält, der einen UserDefinedFunctionProperties umschließt, der den Leseressourcendatensatz enthält.

Ausnahmen

CosmosException

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

Dadurch wird eine vorhandene benutzerdefinierte Funktion gelesen.

CosmosScripts scripts = this.container.Scripts;
Response<UserDefinedFunctionProperties> response = await scripts.ReadUserDefinedFunctionAsync("ExistingId");
UserDefinedFunctionProperties udfProperties = response;

Gilt für:

Freigeben über