UserDefinedFunction class

Package:

@azure/cosmos

Used to read, replace, or delete a specified User Definied Function by id.

See UserDefinedFunction to create, upsert, query, read all User Defined Functions.

Properties

container
id
url	Returns a reference URL to the resource. Used for linking in Permissions.

Methods

delete(RequestOptions)	Delete the given <xref:UserDefined>.
read(RequestOptions)	Read the UserDefinedFunctionDefinition for the given UserDefinedFunction.
replace(UserDefinedFunctionDefinition, RequestOptions)	Replace the given UserDefinedFunction with the specified UserDefinedFunctionDefinition.

Property Details

container

container: Container

Property Value

Container

id

id: string

Property Value

string

url

Returns a reference URL to the resource. Used for linking in Permissions.

string url

Property Value

string

Method Details

delete(RequestOptions)

Delete the given <xref:UserDefined>.

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

Parameters

options

RequestOptions

Returns

Promise<UserDefinedFunctionResponse>

read(RequestOptions)

Read the UserDefinedFunctionDefinition for the given UserDefinedFunction.

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

Parameters

options

RequestOptions

Returns

Promise<UserDefinedFunctionResponse>

replace(UserDefinedFunctionDefinition, RequestOptions)

Replace the given UserDefinedFunction with the specified UserDefinedFunctionDefinition.

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

Parameters

body

UserDefinedFunctionDefinition

options

RequestOptions

Returns

Promise<UserDefinedFunctionResponse>