UserDefinedFunction class

パッケージ:

@azure/cosmos

ID で指定されたユーザー定義関数の読み取り、置換、または削除に使用されます。

UserDefinedFunction 、作成、アップサート、クエリ、すべてのユーザー定義関数の読み取りを参照してください。

プロパティ

container
id
url	リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

メソッド

delete(RequestOptions)	指定した <xref:UserDefined>を削除します。
read(RequestOptions)	指定された UserDefinedFunctionの UserDefinedFunctionDefinition を読み取る。
replace(UserDefinedFunctionDefinition, RequestOptions)	指定した UserDefinedFunction を、指定した UserDefinedFunctionDefinitionに置き換えます。

プロパティの詳細

container

container: Container

プロパティ値

Container

id

id: string

プロパティ値

string

url

リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

string url

プロパティ値

string

メソッドの詳細

delete(RequestOptions)

指定した <xref:UserDefined>を削除します。

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

パラメーター

options

RequestOptions

戻り値

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

指定された UserDefinedFunctionの UserDefinedFunctionDefinition を読み取る。

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

パラメーター

options

RequestOptions

戻り値

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

指定した UserDefinedFunction を、指定した UserDefinedFunctionDefinitionに置き換えます。

function replace(body: UserDefinedFunctionDefinition, options?: RequestOptions): Promise<UserDefinedFunctionResponse>

パラメーター

body

UserDefinedFunctionDefinition

options

RequestOptions

戻り値

Promise<UserDefinedFunctionResponse>