Azion CLI function

Azion CLI commands that create, list, describe, update, and delete the functions of your account, with each flag, its type, and its default.

Last updated

View as Markdown Agent setup

The Azion CLI function commands create, list, describe, update, and delete Functions in the functions library of your account. Each function holds its code, its default arguments, and the environment it runs in, an application or a firewall. An application runs a function through a function instance, which the function-instance commands manage. The options every command accepts, such as --format, --out, and -y, are on Global options.

Create

azion create function adds a function to the functions library from a code file and the settings you pass:

azion create function [flags]
FlagShortTypeDefaultDescription
--active—string—Required unless --file is set. Turns the function on (true) or off (false). Without it, the command asks you to select true or false.
--args—string—Path to a JSON file with the arguments of the function. The command stores the content of the file as default_args.
--code—string—Required unless --file is set. Path to the file with the code of the function. Without it, the command asks for the path.
--execution-environment—string—Where the function runs: application or firewall.
--file—string—Path to a JSON file with the attributes of the function. Use - to read the JSON from standard input.
--name—string—Name of the function.

--execution-environment takes only application or firewall. Any other value, such as edge_application, is refused with this error:

Error: Failed to create function: ["\"edge_application\" is not a valid choice."]. Check your settings and try again. If the error persists, contact Azion support

This file, ./code/function.js, holds the code of the function. It answers every request with the text my-function:

JavaScript
01async function handleRequest(request) {
02 return new Response("my-function", { status: 200 });
03}
04addEventListener("fetch", (event) => {
05 event.respondWith(handleRequest(event.request));
06});

This command creates an active function named my-function from that file, with the arguments in ./code/args.json, to run in an application:

azion create function --name my-function --code ./code/function.js --args ./code/args.json --active true --execution-environment application

The command prints the ID of the function:

Created function with ID 12359

List

azion list function lists the functions of your account, 50 to a page:

azion list function [flags]
FlagShortTypeDefaultDescription
--details———Adds the LAST EDITOR, REFERENCE COUNT, and EXECUTION ENVIRONMENT columns to the ID, NAME, and ACTIVE columns.
--filter—string—Name to filter the list by.
--order-by—string—Field to sort the list by.
--page—int1Number of the page to return.
--page-size—int50Number of functions on each page.

This command returns the first page of a list split into pages of two functions:

azion list function --page 1 --page-size 2

The command prints one row per function:

Text
01ID NAME ACTIVE
0212357 my-bot-filter true
0312358 my-api true

Describe

azion describe function prints the settings of one function:

azion describe function [flags]
FlagShortTypeDefaultDescription
--function-id—int—ID of the function to describe.
--with-code———Prints the same fields as the command without it. The code of the function is in the code field of the --format json output.

This command describes the function with ID 12359:

azion describe function --function-id 12359

The command prints the ID, the name, the last editor, the state, and the reference count of the function:

Text
01ID: 12359
02Name: my-function
03Last Editor: you@example.com
04Active: true
05Reference Count: 0

With --format json, the command prints the full object: active, azion_form, code, default_args, execution_environment, id, is_versioned, last_editor, last_modified, name, product_version, reference_count, resource_version, runtime, vendor, version, version_id, and version_state. The code field holds the source of the function, and default_args holds the content of the --args file.

With an ID that does not exist, the command fails with this error:

Error: Failed to get the Edge Function: The given ID or API's endpoint doesn't exist or isn't available. Check that the identifying information is correct. Check your settings and try again. If the error persists, contact Azion support

Update

azion update function changes the name, the state, the code, the arguments, or the environment of a function:

azion update function [flags]
FlagShortTypeDefaultDescription
--active—string—Turns the function on (true) or off (false).
--args—string—Path to a JSON file with the new arguments of the function. Its content replaces default_args.
--code—string—Path to the file with the new code of the function.
--execution-environment—string—Where the function runs: application or firewall.
--file—string—Path to a JSON file with the attributes to change. Use - to read the JSON from standard input.
--function-id—int—Required, with --file too. ID of the function to update. Without it, the command asks for the ID, even when the --file JSON carries "id".
--name—string—New name of the function.

This command renames the function with ID 12359 to my-function-renamed and turns it off:

azion update function --function-id 12359 --name my-function-renamed --active false

The command prints the ID of the updated function:

Updated function with ID 12359

With --code and --args, the same command replaces the code and the stored arguments of the function. The default_args field then holds the content of the new --args file.

Delete

azion delete function deletes a function from the functions library:

azion delete function [flags]
FlagShortTypeDefaultDescription
--function-id—int—ID of the function to delete.

This command deletes the function with ID 12370:

azion delete function --function-id 12370 -y

The command confirms the deletion:

Function 12370 was successfully deleted

Use a JSON file

azion create function and azion update function read the attributes of the function from a JSON file with --file.

This file creates an active function named my-firewall-function that runs in a firewall. It carries the code inline, in the code field:

JSON
01{
02 "name": "my-firewall-function",
03 "code": "addEventListener('firewall', (event) => { event.continue(); });",
04 "active": true,
05 "runtime": "azion_js",
06 "execution_environment": "firewall",
07 "default_args": {}
08}

Pass the file to the create command:

azion create function --file fn-create.json

The command prints the ID of the function:

Created function with ID 12370

On update, the command does not read "id" from the file, so pass --function-id on the command line. This file renames the function with ID 12370:

JSON
01{
02 "id": 12370,
03 "name": "my-firewall-function-updated"
04}

Pass the file and the ID to the update command:

azion update function --function-id 12370 --file fn-update.json

The command prints the ID of the updated function:

Updated function with ID 12370

The function keeps the fields the file leaves out. In this example, it stays active.

Global options

The options every command accepts, such as --format, --out, and -y.

Functions

What a function is and how a request reaches its code.

Azion CLI function-instance

The commands that add a function to an application.

Azion CLI firewall-instance

The commands that add a function to a firewall.