Container.ReplaceItemAsync<T> メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Cosmos
アセンブリ:
Microsoft.Azure.Cosmos.Client.dll
パッケージ:
Microsoft.Azure.Cosmos v3.36.0

Azure Cosmos サービス内の項目を非同期操作として置き換えます。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<T>> ReplaceItemAsync<T> (T item, string id, Microsoft.Azure.Cosmos.PartitionKey? partitionKey = default, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReplaceItemAsync : 'T * string * Nullable<Microsoft.Azure.Cosmos.PartitionKey> * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<'T>>
Public MustOverride Function ReplaceItemAsync(Of T) (item As T, id As String, Optional partitionKey As Nullable(Of PartitionKey) = Nothing, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))

型パラメーター

T

パラメーター

item
T

id プロパティを含む必要がある JSON シリアル化可能なオブジェクト。 CosmosSerializer カスタム シリアライザーを実装する場合は 。

id
String

既存のアイテムの Cosmos アイテム ID。

partitionKey
Nullable<PartitionKey>

PartitionKey 項目の 。 指定しない場合は、{T} から抽出することで設定されます

requestOptions
ItemRequestOptions

(省略可能)アイテム要求のオプション。

cancellationToken
CancellationToken

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

戻り値

Task<ItemResponse<T>>

Task更新されたリソース レコードをItemResponse<T>ラップする を含む 。

例外

ArgumentNullException

どちらか item が設定されていない場合。

CosmosException

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。

StatusCode例外の理由
400BadRequest - 指定されたドキュメントに問題が発生したことを意味します。
403禁止 - これは、ドキュメントを作成しようとしていたコレクションがいっぱいであることを意味する可能性があります。
413RequestEntityTooLarge - アイテムが現在の最大エンティティ サイズを超えています。 制限とクォータについては、ドキュメントを参照してください。
429TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。

例

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
}

ToDoActivity test = new ToDoActivity()
{
   id = Guid.NewGuid().ToString(),
   status = "InProgress"
};

ItemResponse item = await this.container.ReplaceItemAsync<ToDoActivity>(test, test.id, new PartitionKey(test.status));

注釈

項目のパーティション キー値は変更できません。 項目のパーティション キー値を変更するには、元の項目を削除し、新しい項目を挿入する必要があります。

適用対象