Offer class

  • Reference
Package:
@azure/cosmos

Use to read or replace an existing Offer by id.

See Offers to query or read all offers.

Properties

client
id
url

Returns a reference URL to the resource. Used for linking in Permissions.

Methods

read(RequestOptions)

Read the OfferDefinition for the given Offer.
replace(OfferDefinition, RequestOptions)

Replace the given Offer with the specified OfferDefinition.

Property Details

client 

client: CosmosClient

Property Value

CosmosClient

id 

id: string

Property Value

string

url

Returns a reference URL to the resource. Used for linking in Permissions.

string url

Property Value

string

Method Details

read(RequestOptions)

Read the OfferDefinition for the given Offer.

function read(options?: RequestOptions): Promise<OfferResponse>

Parameters

options
RequestOptions

Returns

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Replace the given Offer with the specified OfferDefinition.

function replace(body: OfferDefinition, options?: RequestOptions): Promise<OfferResponse>

Parameters

body
OfferDefinition

The specified OfferDefinition

options
RequestOptions

Returns

Promise<OfferResponse>