Package version:

Class UserDefinedFunction

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

See

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

Index

Properties

Accessors

Methods

delete read replace

Properties

`Readonly`container

container: Container

The parent Container.

`Readonly`id

id: string

The id of the given UserDefinedFunction.

Accessors

url

get url(): string
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string
- Defined in sdk/cosmosdb/cosmos/src/client/UserDefinedFunction/UserDefinedFunction.ts:27

Methods

delete

delete(options?): Promise<UserDefinedFunctionResponse>
Delete the given UserDefined.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<UserDefinedFunctionResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/UserDefinedFunction/UserDefinedFunction.ts:108

read

read(options?): Promise<UserDefinedFunctionResponse>
Read the UserDefinedFunctionDefinition for the given UserDefinedFunction.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<UserDefinedFunctionResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/UserDefinedFunction/UserDefinedFunction.ts:44

replace

replace(body, options?): Promise<UserDefinedFunctionResponse>
Replace the given UserDefinedFunction with the specified UserDefinedFunctionDefinition.
Parameters
- body: UserDefinedFunctionDefinition
- Optionaloptions: RequestOptions
Returns Promise<UserDefinedFunctionResponse>
- Defined in sdk/cosmosdb/cosmos/src/client/UserDefinedFunction/UserDefinedFunction.ts:70