Compartilhar via

Offer class

Pacote:
@azure/cosmos

Use para ler ou substituir uma oferta 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 de oferta dedeterminado .

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 de oferta de especificado pelo OfferDefinitionespecificado.

Exemplo

Substitua a 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 da propriedade

client 

client: CosmosClient

Valor da propriedade

CosmosClient

id 

id: string

Valor da propriedade

string

url

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

string url

Valor da propriedade

string

Detalhes do método

read(RequestOptions)

Leia o OfferDefinition para o de oferta dedeterminado .

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

Retornos

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Substitua o de oferta de especificado pelo OfferDefinitionespecificado.

Exemplo

Substitua a 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 OfferDefinition especificado

options
RequestOptions

Retornos

Promise<OfferResponse>