DocumentClient.ReplaceOfferAsync(Offer) DocumentClient.ReplaceOfferAsync(Offer) Method

Definition

Namespace:: Microsoft.Azure.Documents.Client Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Replaces a Offer in the Azure Cosmos DB service as an asynchronous operation.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Offer>> ReplaceOfferAsync (Microsoft.Azure.Documents.Offer offer);

abstract member ReplaceOfferAsync : Microsoft.Azure.Documents.Offer -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Offer>>
override this.ReplaceOfferAsync : Microsoft.Azure.Documents.Offer -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Offer>>

Parameters

offer: Offer Offer

The updated Offer to replace the existing resource with.

Returns

Task<ResourceResponse<Offer>>

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a Offer containing the updated resource record.

Implements

ReplaceOfferAsync(Offer)

Exceptions

System.ArgumentNullException System.ArgumentNullException

If offer is not set.

DocumentClientException DocumentClientException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCode	Reason for exception
404	NotFound - This means the resource you tried to delete did not exist.

Examples


  //Fetch the resource to be updated
  Offer offer = client.CreateOfferQuery()
                           .Where(r => r.ResourceLink == "collection selfLink")    
                           .AsEnumerable()
                           .SingleOrDefault();
                
  //Change the user mode to All
  offer.OfferType = "S3";
          
  //Now persist these changes to the database by replacing the original resource
  Offer updated = await client.ReplaceOfferAsync(offer);