通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Offer class

  • 参考
包:
@azure/cosmos

用于按 ID 读取或替换现有 产品/服务。

请参阅 产品/服务 查询或读取所有产品/服务。

属性

client
id
url

返回资源的引用 URL。 用于在权限中链接。

方法

read(RequestOptions)

阅读给定 套餐的 OfferDefinition。

示例

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { resource: offer } = await client.offer("<offer-id>").read();
replace(OfferDefinition, RequestOptions)

将给定的 套餐 替换为指定的 OfferDefinition。

示例

将 offer 替换为具有更新吞吐量的新 offer 定义

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: offer } = await client.offer("<offer-id>").read();
// @ts-preservewhitespace
offer.content.offerThroughput = 1000;
await client.offer("<offer-id>").replace(offer);

属性详细信息

client 

client: CosmosClient

属性值

CosmosClient

id 

id: string

属性值

string

url

返回资源的引用 URL。 用于在权限中链接。

string url

属性值

string

方法详细信息

read(RequestOptions)

阅读给定 套餐的 OfferDefinition。

示例

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { resource: offer } = await client.offer("<offer-id>").read();

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

参数

options
RequestOptions

返回

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

将给定的 套餐 替换为指定的 OfferDefinition。

示例

将 offer 替换为具有更新吞吐量的新 offer 定义

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { resource: offer } = await client.offer("<offer-id>").read();
// @ts-preservewhitespace
offer.content.offerThroughput = 1000;
await client.offer("<offer-id>").replace(offer);

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

参数

body
OfferDefinition

指定的 OfferDefinition

options
RequestOptions

返回

Promise<OfferResponse>