Partilhar via

Offer class

Pacote:
@azure/cosmos

Use para ler ou substituir um de Oferta de existente por id.

Consulte Ofertas para consultar ou ler todas as ofertas.

Propriedades

client
id
url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

Métodos

read(RequestOptions)

Leia o OfferDefinition para o Oferta deem questão.

Exemplo

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)

Substitua o Oferta de pelo especificadoOfferDefinition .

Exemplo

substituir oferta por uma nova definição de oferta com taxa de transferência atualizada

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

Detalhes de Propriedade

client 

client: CosmosClient

Valor de Propriedade

CosmosClient

id 

id: string

Valor de Propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

string url

Valor de Propriedade

string

Detalhes de Método

read(RequestOptions)

Leia o OfferDefinition para o Oferta deem questão.

Exemplo

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>

Parâmetros

options
RequestOptions

Devoluções

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Substitua o Oferta de pelo especificadoOfferDefinition .

Exemplo

substituir oferta por uma nova definição de oferta com taxa de transferência atualizada

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>

Parâmetros

body
OfferDefinition

O especificado OfferDefinition

options
RequestOptions

Devoluções

Promise<OfferResponse>