Scripts.DeleteStoredProcedureAsync メソッド

定義

名前空間:

Microsoft.Azure.Cosmos.Scripts

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.47.0

ソース:

Scripts.cs

StoredProcedureProperties非同期操作として Azure Cosmos DB サービスから を削除します。

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

abstract member DeleteStoredProcedureAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.StoredProcedureResponse>

Public MustOverride Function DeleteStoredProcedureAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StoredProcedureResponse)

パラメーター

id

String

削除するストアド プロシージャの識別子。

requestOptions

RequestOptions

(省略可能)ストアド プロシージャ要求のオプション。

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<StoredProcedureResponse>

発行 Task された要求に対する応答を格納する を含む ResponseMessage 。

例外

ArgumentNullException

が設定されていない場合 id 。

CosmosException

この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。

StatusCode	例外の理由
404	NotFound - 削除しようとしたリソースが存在しなかったことを意味します。

例

この例では、既存のストアド プロシージャへの参照を取得し、削除します。

Scripts scripts = this.container.Scripts;
StoredProcedureResponse response = await scripts.DeleteStoredProcedureAsync("taxUdfId");