Condividi tramite

Offer class

Pacchetto:
@azure/cosmos

Usare per leggere o sostituire un'offerta di esistente in base all'ID.

Vedere Offerte per eseguire query o leggere tutte le offerte.

Proprietà

client
id
url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

Metodi

read(RequestOptions)

Leggere il OfferDefinition per l'offerta specificata.

Esempio

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)

Sostituire la offerta specificata con l'OfferDefinition specificato.

Esempio

Sostituisci l'offerta con una nuova definizione di offerta con velocità effettiva aggiornata

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

Dettagli proprietà

client 

client: CosmosClient

Valore della proprietà

CosmosClient

id 

id: string

Valore della proprietà

string

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

Dettagli metodo

read(RequestOptions)

Leggere il OfferDefinition per l'offerta specificata.

Esempio

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>

Parametri

options
RequestOptions

Restituisce

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Sostituire la offerta specificata con l'OfferDefinition specificato.

Esempio

Sostituisci l'offerta con una nuova definizione di offerta con velocità effettiva aggiornata

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>

Parametri

body
OfferDefinition

Oggetto OfferDefinition specificato

options
RequestOptions

Restituisce

Promise<OfferResponse>