Partager via


Scripts.ReadStoredProcedureAsync Méthode

Définition

Lit un StoredProcedureProperties à partir du service Azure Cosmos en tant qu’opération asynchrone.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.StoredProcedureResponse> ReadStoredProcedureAsync (string id, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadStoredProcedureAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.StoredProcedureResponse>
Public MustOverride Function ReadStoredProcedureAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StoredProcedureResponse)

Paramètres

id
String

Identificateur de la procédure stockée à lire.

requestOptions
RequestOptions

(Facultatif) Options de la demande de procédure stockée.

cancellationToken
CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task contenant un StoredProcedureProperties.

Exceptions

Si id n’est pas défini.

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCodeRaison de l’exception
404NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas.
429TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

Cette opération lit une procédure stockée existante.

Scripts scripts = this.container.Scripts;
StoredProcedureResponse storedProcedure = await scripts.ReadStoredProcedureAsync("ExistingId");

S’applique à