User class

套件:

@azure/cosmos

用來讀取、取代和刪除使用者。

此外，您可以透過 user.permission 和 user.permissions 存取指定使用者的許可權。

請參閱 使用者 以建立、upsert、查詢或全部讀取。

屬性

database
id
permissions	用於建立、更新插入、查詢或讀取所有作業的作業。 請參閱 client.permission(id) 以識別碼讀取、取代或刪除特定許可權。
url	傳回資源的參考 URL。 用於在 [許可權] 中連結。

方法

delete(RequestOptions)	刪除指定的 使用者。
permission(string)	依識別碼讀取、取代或刪除特定許可權的作業。 請參閱 client.permissions 建立、更新插入、查詢或讀取所有作業。
read(RequestOptions)	讀取指定使用者的 UserDefinition。
replace(UserDefinition, RequestOptions)	以指定的UserDefinition取代指定的使用者定義。

屬性詳細資料

database

database: Database

屬性值

Database

id

id: string

屬性值

string

permissions

用於建立、更新插入、查詢或讀取所有作業的作業。

請參閱 client.permission(id) 以識別碼讀取、取代或刪除特定許可權。

permissions: Permissions

屬性值

Permissions

url

傳回資源的參考 URL。 用於在 [許可權] 中連結。

string url

屬性值

string

方法詳細資料

delete(RequestOptions)

刪除指定的 使用者。

function delete(options?: RequestOptions): Promise<UserResponse>

參數

options

RequestOptions

傳回

Promise<UserResponse>

permission(string)

依識別碼讀取、取代或刪除特定許可權的作業。

請參閱 client.permissions 建立、更新插入、查詢或讀取所有作業。

function permission(id: string): Permission

參數

id

string

傳回

Permission

read(RequestOptions)

讀取指定使用者的 UserDefinition。

function read(options?: RequestOptions): Promise<UserResponse>

參數

options

RequestOptions

傳回

Promise<UserResponse>

replace(UserDefinition, RequestOptions)

以指定的UserDefinition取代指定的使用者定義。

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

參數

body

UserDefinition

要取代定義的指定 UserDefinition 。

options

RequestOptions

傳回

Promise<UserResponse>