DocumentClient.ReplaceDocumentAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| ReplaceDocumentAsync(Document, RequestOptions, CancellationToken) |
Substitui um Document no serviço do Azure Cosmos DB como uma operação assíncrona. |
| ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken) |
Substitui um Document no serviço do Azure Cosmos DB como uma operação assíncrona. |
| ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken) |
Substitui um documento como uma operação assíncrona no serviço do Azure Cosmos DB. |
ReplaceDocumentAsync(Document, RequestOptions, CancellationToken)
Substitui um Document no serviço do Azure Cosmos DB como uma operação assíncrona.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReplaceDocumentAsync (Microsoft.Azure.Documents.Document document, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceDocumentAsync : Microsoft.Azure.Documents.Document * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReplaceDocumentAsync : Microsoft.Azure.Documents.Document * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReplaceDocumentAsync (document As Document, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parâmetros
- options
- RequestOptions
(Opcional) As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Document que contém o registro de recurso atualizado.
Implementações
Exceções
Se document não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
| StatusCode | Motivo da exceção |
|---|---|
| 404 | NotFound - Isso significa que o recurso que você tentou excluir não existia. |
Exemplos
Este exemplo usa Document e aproveita o fato de que ele é um objeto dinâmico e usa SetProperty para atualizar dinamicamente as propriedades no documento
//Fetch the Document to be updated
Document doc = client.CreateDocumentQuery<Document>(collectionLink)
.Where(r => r.Id == "doc id")
.AsEnumerable()
.SingleOrDefault();
//Update some properties on the found resource
doc.SetPropertyValue("MyProperty", "updated value");
//Now persist these changes to the database by replacing the original resource
Document updated = await client.ReplaceDocumentAsync(doc);
Confira também
Aplica-se a
ReplaceDocumentAsync(String, Object, RequestOptions, CancellationToken)
Substitui um Document no serviço do Azure Cosmos DB como uma operação assíncrona.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReplaceDocumentAsync (string documentLink, object document, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceDocumentAsync : string * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReplaceDocumentAsync : string * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReplaceDocumentAsync (documentLink As String, document As Object, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parâmetros
- documentLink
- String
O link do documento a ser atualizado. Por exemplo, dbs/db_rid/colls/col_rid/docs/doc_rid/
- options
- RequestOptions
(Opcional) As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Document que contém o registro de recurso atualizado.
Implementações
Exceções
Se ou documentLinkdocument não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
| StatusCode | Motivo da exceção |
|---|---|
| 404 | NotFound - Isso significa que o recurso que você tentou excluir não existia. |
Exemplos
Neste exemplo, em vez de usar um fortemente tipado Document, trabalharemos com nosso próprio objeto POCO e não dependeremos da natureza dinâmica da classe Document.
public class MyPoco
{
public string Id {get; set;}
public string MyProperty {get; set;}
}
//Get the doc back as a Document so you have access to doc.SelfLink
Document doc = client.CreateDocumentQuery<Document>(collectionLink)
.Where(r => r.Id == "doc id")
.AsEnumerable()
.SingleOrDefault();
//Now dynamically cast doc back to your MyPoco
MyPoco poco = (dynamic)doc;
//Update some properties of the poco object
poco.MyProperty = "updated value";
//Now persist these changes to the database using doc.SelLink and the update poco object
Document updated = await client.ReplaceDocumentAsync(doc.SelfLink, poco);
Confira também
Aplica-se a
ReplaceDocumentAsync(Uri, Object, RequestOptions, CancellationToken)
Substitui um documento como uma operação assíncrona no serviço do Azure Cosmos DB.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReplaceDocumentAsync (Uri documentUri, object document, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceDocumentAsync : Uri * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReplaceDocumentAsync : Uri * obj * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReplaceDocumentAsync (documentUri As Uri, document As Object, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parâmetros
- documentUri
- Uri
o URI do documento a ser atualizado.
- document
- Object
o documento atualizado.
- options
- RequestOptions
As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) CancellationToken que representa o cancelamento da solicitação.
Retornos
O objeto de tarefa que representa a resposta de serviço para a operação assíncrona.
Implementações
Aplica-se a
Azure SDK for .NET
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários