Container.PatchItemStreamAsync Método

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.39.0

Origem:

Container.cs

Corrige um item no serviço do Azure Cosmos como uma operação assíncrona.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage> PatchItemStreamAsync (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, System.Collections.Generic.IReadOnlyList<Microsoft.Azure.Cosmos.PatchOperation> patchOperations, Microsoft.Azure.Cosmos.PatchItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PatchItemStreamAsync : string * Microsoft.Azure.Cosmos.PartitionKey * System.Collections.Generic.IReadOnlyList<Microsoft.Azure.Cosmos.PatchOperation> * Microsoft.Azure.Cosmos.PatchItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>

Public MustOverride Function PatchItemStreamAsync (id As String, partitionKey As PartitionKey, patchOperations As IReadOnlyList(Of PatchOperation), Optional requestOptions As PatchItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)

Parâmetros

id

String

A ID do item do Cosmos

partitionKey

PartitionKey

A chave de partição do item.

patchOperations

IReadOnlyList<PatchOperation>

Representa uma lista de operações a serem aplicadas sequencialmente ao item cosmos referenciado.

requestOptions

PatchItemRequestOptions

(Opcional) As opções para a solicitação de item.

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<ResponseMessage>

Um Task que contém um ResponseMessage que encapsula um Stream que contém o registro de recurso corrigido.

Exemplos

PatchItemAsync<T>(String, PartitionKey, IReadOnlyList<PatchOperation>, PatchItemRequestOptions, CancellationToken)

Comentários

O valor da chave de partição do item é imutável. Para alterar o valor da chave de partição de um item, você deve excluir o item original e inserir um novo item. As operações de patch são atômicas e são executadas sequencialmente. Por padrão, o corpo do recurso será retornado como parte da resposta. O usuário não pode solicitar nenhum conteúdo definindo EnableContentResponseOnWrite sinalizador como false.