.alter function folder command

Applies to: ✅ Azure Data Explorer

Alters the folder value of an existing function.

Note

If the function doesn't exist, an error is returned. For more information on how to create a new function, see .create function.

Permissions

You must have at least Function Admin permissions to run this command. The principal that creates the function is automatically made a Function Admin.

Syntax

.alter function FunctionName folder Folder

Learn more about syntax conventions.

Parameters

Name Type Required Description
FunctionName string ✔️ The name of the function to alter.
Folder string ✔️ The name of the folder to assign to the function.

Returns

Output parameter Type Description
Name string The name of the function.
Parameters string The parameters required by the function.
Body string Zero or more let statements followed by a valid CSL expression to be evaluated upon function invocation.
Folder string A folder to use for UI functions categorization. This parameter doesn't change the way function is invoked.
DocString string A description of the function for UI purposes.

Example

The following example changes the folder value and folder name to Updated Folder.

.alter function MyFunction1 folder "Updated Folder"
Name Parameters Body Folder DocString
MyFunction2 (myLimit: long) {StormEvents | take myLimit} Updated Folder Some DocString
.alter function MyFunction1 folder @"First Level\Second Level"
Name Parameters Body Folder DocString
MyFunction2 (myLimit: long) {StormEvents | take myLimit} First Level\Second Level Some DocString