Package version:

Class Offer

Use to read or replace an existing Offer by id.

See

Offers to query or read all offers.

Index

Properties

Accessors

Methods

Properties

`Readonly`client

client: CosmosClient

The parent CosmosClient for the Database Account.

`Readonly`id

id: string

The id of the given Offer.

Accessors

url

get url(): string
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string
- Defined in sdk/cosmosdb/cosmos/src/client/Offer/Offer.ts:21

Methods

read

read(options?): Promise<OfferResponse>
Read the OfferDefinition for the given Offer.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<OfferResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Offer/Offer.ts:38

replace

replace(body, options?): Promise<OfferResponse>
Replace the given Offer with the specified OfferDefinition.
Parameters
- body: OfferDefinition
  The specified OfferDefinition
- Optionaloptions: RequestOptions
Returns Promise<OfferResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/Offer/Offer.ts:61