TransactionalBatch.ExecuteAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ExecuteAsync(CancellationToken) |
非同期操作として、Azure Cosmos サービスでトランザクション バッチを実行します。 |
| ExecuteAsync(TransactionalBatchRequestOptions, CancellationToken) |
非同期操作として、Azure Cosmos サービスでトランザクション バッチを実行します。 |
ExecuteAsync(CancellationToken)
非同期操作として、Azure Cosmos サービスでトランザクション バッチを実行します。
public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.TransactionalBatchResponse> ExecuteAsync (System.Threading.CancellationToken cancellationToken = default);abstract member ExecuteAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.TransactionalBatchResponse>Public MustOverride Function ExecuteAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of TransactionalBatchResponse)パラメーター
- cancellationToken
- CancellationToken
(省略可能)要求の取り消しを表すキャンセル トークン。
戻り値
トランザクション バッチの実行の詳細を含む待機可能な応答。
トランザクション バッチが正常に実行された場合、 StatusCode 返される応答の は に OK設定されます。
実行中にトランザクション バッチ内の操作が失敗した場合、バッチからの変更はコミットされません。失敗した操作の状態は で StatusCode使用できるようになります。 失敗した操作の詳細を取得するには、応答を列挙できます。これにより、トランザクション バッチ内の各操作に対応するインスタンスが、トランザクション バッチに追加された順序で返 TransactionalBatchOperationResult されます。 トランザクション バッチ内の操作に対応する結果の場合、 StatusCode は操作の状態を示します。操作が実行されなかったか、トランザクション バッチ内の別の操作が失敗したために中止された場合、このフィールドの値は HTTP 424 (Failed Dependency) になります。バッチが中止される原因となった操作の場合は、 このフィールドの値は、エラーの原因を HTTP 状態コードとして示します。
StatusCode返される応答の には、サーバー エラーが発生した場合の HTTP 5xx や HTTP 429 (要求が多すぎます) などの値が含まれる場合もあります。
注釈
この API は、クライアント側の例外でのみをスローします。 これは、パフォーマンスを向上させ、例外をスローするオーバーヘッドを防ぐためです。 返された応答で を使用 IsSuccessStatusCode して、トランザクション バッチが成功したことを確認します。 TransactionalBatch 要求の制限
適用対象
ExecuteAsync(TransactionalBatchRequestOptions, CancellationToken)
非同期操作として、Azure Cosmos サービスでトランザクション バッチを実行します。
public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.TransactionalBatchResponse> ExecuteAsync (Microsoft.Azure.Cosmos.TransactionalBatchRequestOptions requestOptions, System.Threading.CancellationToken cancellationToken = default);abstract member ExecuteAsync : Microsoft.Azure.Cosmos.TransactionalBatchRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.TransactionalBatchResponse>Public MustOverride Function ExecuteAsync (requestOptions As TransactionalBatchRequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TransactionalBatchResponse)パラメーター
- requestOptions
- TransactionalBatchRequestOptions
バッチ要求に特に適用されるオプション。
- cancellationToken
- CancellationToken
(省略可能)要求の取り消しを表すキャンセル トークン。
戻り値
トランザクション バッチの実行の詳細を含む待機可能な応答。
トランザクション バッチが正常に実行された場合、 StatusCode 返される応答の は に OK設定されます。
実行中にトランザクション バッチ内の操作が失敗した場合、バッチからの変更はコミットされません。失敗した操作の状態は で StatusCode使用できるようになります。 失敗した操作の詳細を取得するには、応答を列挙できます。これにより、トランザクション バッチ内の各操作に対応するインスタンスが、トランザクション バッチに追加された順序で返 TransactionalBatchOperationResult されます。 トランザクション バッチ内の操作に対応する結果の場合、 StatusCode は操作の状態を示します。操作が実行されなかったか、トランザクション バッチ内の別の操作が失敗したために中止された場合、このフィールドの値は HTTP 424 (Failed Dependency) になります。バッチが中止される原因となった操作の場合は、 このフィールドの値は、エラーの原因を HTTP 状態コードとして示します。
StatusCode返される応答の には、サーバー エラーが発生した場合の HTTP 5xx や HTTP 429 (要求が多すぎます) などの値が含まれる場合もあります。
注釈
この API は、クライアント側の例外でのみをスローします。 これは、パフォーマンスを向上させ、例外をスローするオーバーヘッドを防ぐためです。 返された応答で を使用 IsSuccessStatusCode して、トランザクション バッチが成功したことを確認します。 TransactionalBatch 要求の制限
適用対象
Azure SDK for .NET