Offer class

  • リファレンス
パッケージ:
@azure/cosmos

既存の プラン を ID で読み取ったり置き換えたりするには、 を使用します。

「すべての オファー のクエリまたは読み取りを行うオファー」を参照してください。

プロパティ

client
id
url

リソースへの参照 URL を返します。 [アクセス許可] でリンクするために使用されます。

メソッド

read(RequestOptions)

指定された オファーの OfferDefinition を読み取 る。
replace(OfferDefinition, RequestOptions)

指定した オファー を指定した OfferDefinition に置き換えます。

プロパティの詳細

client 

client: CosmosClient

プロパティ値

CosmosClient

id 

id: string

プロパティ値

string

url

リソースへの参照 URL を返します。 [アクセス許可] でリンクするために使用されます。

string url

プロパティ値

string

メソッドの詳細

read(RequestOptions)

指定された オファーの OfferDefinition を読み取 る。

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

パラメーター

options
RequestOptions

戻り値

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

指定した オファー を指定した OfferDefinition に置き換えます。

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

パラメーター

body
OfferDefinition

指定された OfferDefinition

options
RequestOptions

戻り値

Promise<OfferResponse>