Instâncias de function

As funções do azion/applications que criam, listam, leem, atualizam e excluem as instâncias de function de uma application.

Última atualização

Ver como Markdown Configurar agente

Uma instância de function executa uma function existente para uma application, com os argumentos que a instância define. Estas funções do azion/applications criam, listam, leem, atualizam e excluem as instâncias de function de uma application.

createFunctionInstance

Cria uma instância de function em uma application. Uma instância executa uma function existente para essa application, com os argumentos que a instância define.

Duas coisas precisam existir antes. A application precisa ter functions ativadas, o que patchApplication faz com data: { edge_functions: true }. A function também precisa existir: a instância a identifica pelo ID dela em edge_function_id, e o pacote azion não tem um módulo que crie functions.

TypeScript
01function createFunctionInstance(params: {
02 applicationId: number;
03 data: ApiCreateFunctionInstancePayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionFunctionInstance>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
dataApiCreateFunctionInstancePayloadSimname, o edge_function_id da function e os args que a function recebe.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como a AzionFunctionInstance criada, com o id dela.

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}

Saída:

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

getFunctionInstances

Lista as instâncias de function de uma application, uma página por vez.

TypeScript
01function getFunctionInstances(params: {
02 applicationId: number;
03 params?: ApiListFunctionInstancesParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionFunctionInstance>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
paramsApiListFunctionInstancesParamsNãoPaginação: page e page_size.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionFunctionInstance.

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}

Saída:

Texto
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

Retorna uma instância de function de uma application pelo ID dela.

TypeScript
01function getFunctionInstance(params: {
02 applicationId: number;
03 functionInstanceId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionFunctionInstance>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
functionInstanceIdnumberSimO ID da instância de function.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como uma 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}

Saída:

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

updateFunctionInstance

Envia em uma requisição PATCH os campos da instância de function que você passa.

TypeScript
01function updateFunctionInstance(params: {
02 applicationId: number;
03 functionInstanceId: number;
04 data: ApiUpdateFunctionInstancePayload;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionFunctionInstance>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
functionInstanceIdnumberSimO ID da instância de function a atualizar.
dataApiUpdateFunctionInstancePayloadSimOs campos a mudar. O exemplo muda name.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como a AzionFunctionInstance atualizada.

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}

Saída:

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

deleteFunctionInstance

Exclui uma instância de function de uma application pelo ID dela.

TypeScript
01function deleteFunctionInstance(params: {
02 applicationId: number;
03 functionInstanceId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
functionInstanceIdnumberSimO ID da instância de function a excluir.
optionsAzionClientOptionsNãoOpções de requisição.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê a instância de volta com getFunctionInstance. Um erro 404 confirma a exclusão.

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}

Saída:

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

Recursos relacionados

Azion Lib

Os módulos da Azion Lib e o pacote npm em que cada um é distribuído.

Applications

A autenticação do módulo, o envelope de resposta dele e os erros que as funções reportam.

Tipos de application

Os tipos de payload e de resposta que estas funções recebem e retornam.

Instâncias de function

A instância de function que uma application executa, com os argumentos dela.