Users class

參考

套件:: @azure/cosmos

用來建立、upsert、查詢和讀取所有使用者。

請參閱使用者以識別碼讀取、取代或刪除特定使用者。

屬性

方法

create(UserDefinition, RequestOptions)	使用指定的 UserDefinition建立資料庫使用者。
query(SqlQuerySpec, FeedOptions)	查詢所有使用者。
query<T>(SqlQuerySpec, FeedOptions)	查詢所有使用者。
readAll(FeedOptions)	讀取所有使用者。- 範例讀取所有使用者以陣列。 `const {body: usersList} = await database.users.readAll().fetchAll();`
upsert(UserDefinition, RequestOptions)	使用指定的 UserDefinition來向上插入資料庫使用者。

屬性詳細資料

database

database: Database

屬性值

Database

方法詳細資料

create(UserDefinition, RequestOptions)

使用指定的 UserDefinition建立資料庫使用者。

function create(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

參數

body: UserDefinition

指定的 UserDefinition。

options: RequestOptions

傳回

Promise<UserResponse>

query(SqlQuerySpec, FeedOptions)

查詢所有使用者。

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

參數

query: SqlQuerySpec

作業的查詢組態。如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec 。

options: FeedOptions

傳回

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

查詢所有使用者。

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

參數

query: SqlQuerySpec

作業的查詢組態。如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec 。

options: FeedOptions

傳回

QueryIterator<T>

readAll(FeedOptions)

讀取所有使用者。-

範例

讀取所有使用者以陣列。

const {body: usersList} = await database.users.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<UserDefinition & Resource>

參數

options: FeedOptions

傳回

QueryIterator<UserDefinition & Resource>

upsert(UserDefinition, RequestOptions)

使用指定的 UserDefinition來向上插入資料庫使用者。

function upsert(body: UserDefinition, options?: RequestOptions): Promise<UserResponse>

參數

body: UserDefinition