Поделиться через

Offer class

Пакет:
@azure/cosmos

Используется для чтения или замены существующего предложения по идентификатору.

Ознакомьтесь с предложениями для запроса или чтения всех предложений.

Свойства

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)

Замените данное предложение на указанное определение предложения.

Пример

Замена предложения на новое определение предложения с обновленной пропускной способностью

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)

Замените данное предложение на указанное определение предложения.

Пример

Замена предложения на новое определение предложения с обновленной пропускной способностью

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>