مشاركة عبر

Item class

  • ‏‏المرجع
الحزمة:
@azure/cosmos

يستخدم لتنفيذ عمليات على عنصر معين.

راجع عناصر للعمليات على كافة العناصر؛ راجع container.items.

الخصائص

container
id
url

إرجاع URL مرجع إلى المورد. يستخدم للارتباط في الأذونات.

الأساليب

delete<T>(RequestOptions)

حذف العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.
patch<T>(PatchRequestBody, RequestOptions)

تنفيذ JSONPatch على العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.
read<T>(RequestOptions)

اقرأ تعريف العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه. إذا كان النوع، T، فئة، فلن يمرر مقارنات typeof، لأنه لن يحتوي على نموذج أولي للمطابقة. يوصى باستخدام الواجهات فقط.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

المثال

استخدام نوع مخصص للاستجابة

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

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

استبدل تعريف العنصر.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.
replace<T>(T, RequestOptions)

استبدل تعريف العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

تفاصيل الخاصية

container 

container: Container

قيمة الخاصية

Container

id 

id: string

قيمة الخاصية

string

url

إرجاع URL مرجع إلى المورد. يستخدم للارتباط في الأذونات.

string url

قيمة الخاصية

string

تفاصيل الأسلوب

delete<T>(RequestOptions)

حذف العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

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

المعلمات

options
RequestOptions

خيارات إضافية للطلب

المرتجعات

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

تنفيذ JSONPatch على العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

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

المعلمات

body
PatchRequestBody
options
RequestOptions

خيارات إضافية للطلب

المرتجعات

Promise<ItemResponse<T>>

read<T>(RequestOptions)

اقرأ تعريف العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه. إذا كان النوع، T، فئة، فلن يمرر مقارنات typeof، لأنه لن يحتوي على نموذج أولي للمطابقة. يوصى باستخدام الواجهات فقط.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

المثال

استخدام نوع مخصص للاستجابة

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

المعلمات

options
RequestOptions

خيارات إضافية للطلب

المرتجعات

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

استبدل تعريف العنصر.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

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

المعلمات

body
ItemDefinition

تعريف لاستبدال تعريف عنصر الموجودب.

options
RequestOptions

خيارات إضافية للطلب

المرتجعات

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

استبدل تعريف العنصر.

لا يتم بالضرورة فرض أي نوع متوفر، T، بواسطة SDK. قد تحصل على خصائص أكثر أو أقل، الأمر متروك لمنطقك لفرضه.

لا يوجد مخطط مجموعة لعناصر JSON. قد تحتوي على أي عدد من الخصائص المخصصة.

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

المعلمات

body

T

تعريف لاستبدال تعريف عنصر الموجودب.

options
RequestOptions

خيارات إضافية للطلب

المرتجعات

Promise<ItemResponse<T>>