Item class

  • Referenz
Paket:
@azure/cosmos

Wird zum Ausführen von Vorgängen für ein bestimmtes Element verwendet.

Unter Elemente finden Sie Vorgänge für alle Elemente. siehe container.items.

Eigenschaften

container
id
url

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

Methoden

delete<T>(RequestOptions)

Löschen Sie das Element.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.
patch<T>(PatchRequestBody, RequestOptions)

Führen Sie einen JSONPatch für das Element aus.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.
read<T>(RequestOptions)

Lesen Sie die Definition des Elements.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen. Wenn der Typ T eine Klasse ist, besteht er keine typeof Vergleiche, da er keinen Übereinstimmungsprototyp aufweist. Es wird empfohlen, nur Schnittstellen zu verwenden.

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.

Beispiel

Verwenden eines benutzerdefinierten Typs für die Antwort

interface TodoItem {
  title: string;
  done: bool;
  id: string;
}

let item: TodoItem;
({body: item} = await item.read<TodoItem>());
replace(ItemDefinition, RequestOptions)

Ersetzen Sie die Definition des Elements.

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.
replace<T>(T, RequestOptions)

Ersetzen Sie die Definition des Elements.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.

Details zur Eigenschaft

container 

container: Container

Eigenschaftswert

Container

id 

id: string

Eigenschaftswert

string

url

Gibt eine Verweis-URL für die Ressource zurück. Wird zum Verknüpfen in Berechtigungen verwendet.

string url

Eigenschaftswert

string

Details zur Methode

delete<T>(RequestOptions)

Löschen Sie das Element.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

function delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

options
RequestOptions

Zusätzliche Optionen für die Anforderung

Gibt zurück

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Führen Sie einen JSONPatch für das Element aus.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

function patch<T>(body: PatchRequestBody, options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

body
PatchRequestBody
options
RequestOptions

Zusätzliche Optionen für die Anforderung

Gibt zurück

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Lesen Sie die Definition des Elements.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen. Wenn der Typ T eine Klasse ist, besteht er keine typeof Vergleiche, da er keinen Übereinstimmungsprototyp aufweist. Es wird empfohlen, nur Schnittstellen zu verwenden.

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.

Beispiel

Verwenden eines benutzerdefinierten Typs für die Antwort

interface TodoItem {
  title: string;
  done: bool;
  id: string;
}

let item: TodoItem;
({body: item} = await item.read<TodoItem>());

function read<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

options
RequestOptions

Zusätzliche Optionen für die Anforderung

Gibt zurück

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Ersetzen Sie die Definition des Elements.

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.

function replace(body: ItemDefinition, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

Parameter

body
ItemDefinition

Die Definition, durch die die Definition des vorhandenen Elements ersetzt werden soll.

options
RequestOptions

Zusätzliche Optionen für die Anforderung

Gibt zurück

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Ersetzen Sie die Definition des Elements.

Jeder bereitgestellte Typ, T, wird nicht unbedingt vom SDK erzwungen. Möglicherweise erhalten Sie mehr oder weniger Eigenschaften, und es liegt an Ihrer Logik, sie zu erzwingen.

Es gibt kein festgelegtes Schema für JSON-Elemente. Sie können eine beliebige Anzahl benutzerdefinierter Eigenschaften enthalten.

function replace<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parameter

body

T

Die Definition, durch die die Definition des vorhandenen Elements ersetzt werden soll.

options
RequestOptions

Zusätzliche Optionen für die Anforderung

Gibt zurück

Promise<ItemResponse<T>>