Function instances

The azion/applications functions that create, list, read, update, and delete the function instances of an application.

Last updated

View as Markdown Agent setup

A function instance runs an existing function for an application, with the arguments the instance sets. These azion/applications functions create, list, read, update, and delete the function instances of an application.

createFunctionInstance

Creates a function instance in an application. An instance runs an existing function for that application, with the arguments the instance sets.

Two things must exist first. The application must have functions turned on, which patchApplication does with data: { edge_functions: true }. The function must exist too: the instance names it by its ID in edge_function_id, and the azion package has no module that creates functions.

TypeScript
01function createFunctionInstance(params: {
02 applicationId: number;
03 data: ApiCreateFunctionInstancePayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionFunctionInstance>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
dataApiCreateFunctionInstancePayloadYesname, the edge_function_id of the function, and the args the function receives.
optionsAzionClientOptionsNoRequest options.

Returns data as the created AzionFunctionInstance, with its id.

TypeScript
01import { createFunctionInstance } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Define the data for the new function instance
06const functionInstanceData = {
07 name: 'my-function-instance',
08 edge_function_id: 23456, // Replace with the ID of an existing function
09 args: { greeting: 'hello' },
10};
11
12// Create a new function instance
13const { data: newFunctionInstance, error } = await createFunctionInstance({ applicationId, data: functionInstanceData });
14
15if (error) {
16 console.error('Error creating function instance:', error);
17} else {
18 console.log('Function instance created successfully:', newFunctionInstance);
19}

Output:

Text
01Function instance created successfully: {
02 edge_function_id: 23456,
03 name: 'my-function-instance',
04 args: { greeting: 'hello' },
05 id: 12345
06}

getFunctionInstances

Lists the function instances of an application, one page at a time.

TypeScript
01function getFunctionInstances(params: {
02 applicationId: number;
03 params?: ApiListFunctionInstancesParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionFunctionInstance>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
paramsApiListFunctionInstancesParamsNoPagination: page and page_size.
optionsAzionClientOptionsNoRequest options.

Returns an AzionApplicationCollectionResponse whose data.results holds AzionFunctionInstance objects.

TypeScript
01import { getFunctionInstances } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05const { data: functionInstances, error } = await getFunctionInstances({
06 applicationId,
07 params: { page: 1, page_size: 10 },
08});
09
10if (error) {
11 console.error('Error listing function instances:', error);
12} else {
13 console.log(`Found ${functionInstances?.count} function instances:`, functionInstances?.results);
14}

Output:

Text
01Found 1 function instances: [
02 {
03 id: 12345,
04 edge_function_id: 23456,
05 name: 'my-function-instance',
06 args: { greeting: 'hello' }
07 }
08]

getFunctionInstance

Returns one function instance of an application by its ID.

TypeScript
01function getFunctionInstance(params: {
02 applicationId: number;
03 functionInstanceId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionFunctionInstance>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
functionInstanceIdnumberYesThe ID of the function instance.
optionsAzionClientOptionsNoRequest options.

Returns data as an AzionFunctionInstance.

TypeScript
01import { getFunctionInstance } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const functionInstanceId = 12345; // Replace with the actual function instance ID
05
06const { data: functionInstance, error } = await getFunctionInstance({ applicationId, functionInstanceId });
07
08if (error) {
09 console.error('Error retrieving function instance:', error);
10} else {
11 console.log('Function instance details:', functionInstance);
12}

Output:

Text
01Function instance details: {
02 id: 12345,
03 edge_function_id: 23456,
04 name: 'my-function-instance',
05 args: { greeting: 'hello' }
06}

updateFunctionInstance

Sends the function instance fields you pass in a PATCH request.

TypeScript
01function updateFunctionInstance(params: {
02 applicationId: number;
03 functionInstanceId: number;
04 data: ApiUpdateFunctionInstancePayload;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionFunctionInstance>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
functionInstanceIdnumberYesThe ID of the function instance to update.
dataApiUpdateFunctionInstancePayloadYesThe fields to change. The sample changes name.
optionsAzionClientOptionsNoRequest options.

Returns data as the updated AzionFunctionInstance.

TypeScript
01import { updateFunctionInstance } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const functionInstanceId = 12345; // Replace with the actual function instance ID
05
06const { data: updatedFunctionInstance, error } = await updateFunctionInstance({
07 applicationId,
08 functionInstanceId,
09 data: { name: 'my-function-instance-updated' },
10});
11
12if (error) {
13 console.error('Error updating function instance:', error);
14} else {
15 console.log('Function instance updated:', updatedFunctionInstance);
16}

Output:

Text
01Function instance updated: {
02 id: 12345,
03 edge_function_id: 23456,
04 name: 'my-function-instance-updated',
05 args: { greeting: 'hello' }
06}

deleteFunctionInstance

Deletes a function instance of an application by its ID.

TypeScript
01function deleteFunctionInstance(params: {
02 applicationId: number;
03 functionInstanceId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
functionInstanceIdnumberYesThe ID of the function instance to delete.
optionsAzionClientOptionsNoRequest options.

A successful delete returns error with the message Expected JSON response, but got: , so the sample reads the instance back with getFunctionInstance. A 404 error confirms the delete.

TypeScript
01import { deleteFunctionInstance, getFunctionInstance } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const functionInstanceId = 12345; // Replace with the actual function instance ID
05
06const { error: deleteError } = await deleteFunctionInstance({ applicationId, functionInstanceId });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading it back
09const { error } = await getFunctionInstance({ applicationId, functionInstanceId });
10if (error) {
11 console.log(`Function instance ${functionInstanceId} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting function instance:', deleteError);
14}

Output:

Function instance 12345 deleted (read back: HTTP error! Status: 404 - NOT FOUND)
Azion Lib

The Azion Lib modules and the npm package each one ships in.

Applications

The module’s authentication, its response envelope, and the errors its functions report.

Application types

The payload and response types these functions take and return.

Functions instances

The function instance an application runs, with its arguments.