你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Item class

包:

@azure/cosmos

用于对特定项执行操作。

有关所有 项 的操作，请参阅 Items;请参阅 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>>