Dela via

Offer class

Paket:
@azure/cosmos

Använd för att läsa eller ersätta ett befintligt erbjudande med ID.

Se Erbjudanden för att fråga efter eller läsa alla erbjudanden.

Egenskaper

client
id
url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

Metoder

read(RequestOptions)

Läs OfferDefinition- för det angivna Erbjudandet.

Exempel

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)

Ersätt det angivna erbjudandet med den angivna OfferDefinition.

Exempel

Ersätt erbjudandet med en ny erbjudandedefinition med uppdaterat dataflöde

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);

Egenskapsinformation

client 

client: CosmosClient

Egenskapsvärde

CosmosClient

id 

id: string

Egenskapsvärde

string

url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

string

Metodinformation

read(RequestOptions)

Läs OfferDefinition- för det angivna Erbjudandet.

Exempel

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>

Parametrar

options
RequestOptions

Returer

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Ersätt det angivna erbjudandet med den angivna OfferDefinition.

Exempel

Ersätt erbjudandet med en ny erbjudandedefinition med uppdaterat dataflöde

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>

Parametrar

body
OfferDefinition

Angiven OfferDefinition

options
RequestOptions

Returer

Promise<OfferResponse>