Partager via

Offer class

Paquet:
@azure/cosmos

Permet de lire ou de remplacer une offre existante par ID.

Consultez offres pour interroger ou lire toutes les offres.

Propriétés

client
id
url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

Méthodes

read(RequestOptions)

Lisez le OfferDefinition pour le d’offredonné.

Exemple

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)

Remplacez le d’offre donné par le OfferDefinitionspécifié.

Exemple

Remplacer l’offre par une nouvelle définition d’offre avec un débit mis à jour

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

Détails de la propriété

client 

client: CosmosClient

Valeur de propriété

CosmosClient

id 

id: string

Valeur de propriété

string

url

Retourne une URL de référence à la ressource. Utilisé pour la liaison dans Autorisations.

string url

Valeur de propriété

string

Détails de la méthode

read(RequestOptions)

Lisez le OfferDefinition pour le d’offredonné.

Exemple

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>

Paramètres

options
RequestOptions

Retours

Promise<OfferResponse>

replace(OfferDefinition, RequestOptions)

Remplacez le d’offre donné par le OfferDefinitionspécifié.

Exemple

Remplacer l’offre par une nouvelle définition d’offre avec un débit mis à jour

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>

Paramètres

body
OfferDefinition

Le OfferDefinition spécifié

options
RequestOptions

Retours

Promise<OfferResponse>