Delen via

Offer class

Pakket:
@azure/cosmos

Gebruik dit om een bestaande aanbieding op id te lezen of te vervangen.

Zie Aanbiedingen om alle aanbiedingen op te vragen of te lezen.

Eigenschappen

client
id
url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

Methoden

read(RequestOptions)

Lees de OfferDefinition- voor de opgegeven Aanbieding.

Voorbeeld

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)

Vervang de opgegeven Aanbieding door de opgegeven OfferDefinition.

Voorbeeld

Vervang aanbieding door een nieuwe aanbiedingsdefinitie met bijgewerkte doorvoer

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

Eigenschapdetails

client 

client: CosmosClient

Waarde van eigenschap

CosmosClient

id 

id: string

Waarde van eigenschap

string

url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

string url

Waarde van eigenschap

string

Methodedetails

read(RequestOptions)

Lees de OfferDefinition- voor de opgegeven Aanbieding.

Voorbeeld

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>

Parameters

options
RequestOptions

Retouren

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Vervang de opgegeven Aanbieding door de opgegeven OfferDefinition.

Voorbeeld

Vervang aanbieding door een nieuwe aanbiedingsdefinitie met bijgewerkte doorvoer

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>

Parameters

body
OfferDefinition

De opgegeven OfferDefinition-

options
RequestOptions

Retouren

Promise<OfferResponse>