Item class

  • Référence
Paquet:
@azure/cosmos

Utilisé pour effectuer des opérations sur un élément spécifique.

Consultez Éléments pour connaître les opérations sur tous les éléments ; consultez container.items.

Propriétés

container
id
url

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

Méthodes

delete<T>(RequestOptions)

Supprimez l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.
patch<T>(PatchRequestBody, RequestOptions)

Effectuez un jsonPatch sur l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.
read<T>(RequestOptions)

Lisez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer. Si le type, T, est une classe, il ne passera pas de comparaisons typeof , car il n’aura pas de prototype de correspondance. Il est recommandé d’utiliser uniquement des interfaces.

Il n’existe aucun schéma défini pour les éléments JSON. Elles peuvent contenir n’importe quel nombre de propriétés personnalisées.

Exemple

Utilisation du type personnalisé pour la réponse

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

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

Remplacez la définition de l’élément.

Il n’existe aucun schéma défini pour les éléments JSON. Elles peuvent contenir n’importe quel nombre de propriétés personnalisées.
replace<T>(T, RequestOptions)

Remplacez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Elles peuvent contenir n’importe quel nombre de propriétés personnalisées.

Détails de la propriété

container 

container: Container

Valeur de propriété

Container

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

delete<T>(RequestOptions)

Supprimez l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

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

Paramètres

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Effectuez un jsonPatch sur l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

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

Paramètres

body
PatchRequestBody
options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Lisez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer. Si le type, T, est une classe, il ne passera pas de comparaisons typeof , car il n’aura pas de prototype de correspondance. Il est recommandé d’utiliser uniquement des interfaces.

Il n’existe aucun schéma défini pour les éléments JSON. Elles peuvent contenir n’importe quel nombre de propriétés personnalisées.

Exemple

Utilisation du type personnalisé pour la réponse

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

Paramètres

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Remplacez la définition de l’élément.

Il n’existe aucun schéma défini pour les éléments JSON. Elles peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body
ItemDefinition

Définition par laquelle remplacer la définition de l’élément existant.

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Remplacez la définition de l’élément.

Tout type fourni, T, n’est pas nécessairement appliqué par le SDK. Vous pouvez obtenir plus ou moins de propriétés et c’est à votre logique de les appliquer.

Il n’existe aucun schéma défini pour les éléments JSON. Elles peuvent contenir n’importe quel nombre de propriétés personnalisées.

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

Paramètres

body

T

Définition par laquelle remplacer la définition de l’élément existant.

options
RequestOptions

Options supplémentaires pour la demande

Retours

Promise<ItemResponse<T>>