Azion CLI function

Comandos da Azion CLI que criam, listam, descrevem, atualizam e excluem as functions da sua conta, com cada flag, seu tipo e seu padrão.

Última atualização

Ver como Markdown Configurar agente

Os comandos function da Azion CLI criam, listam, descrevem, atualizam e excluem Functions na biblioteca de functions da sua conta. Cada function guarda seu código, seus argumentos padrão e o ambiente em que roda, uma aplicação ou um firewall. Uma aplicação executa uma function por meio de uma instância de function, que os comandos function-instance gerenciam. As opções que todo comando aceita, como --format, --out e -y, estão em Opções globais da Azion CLI.

Criar

azion create function adiciona uma function à biblioteca de functions a partir de um arquivo de código e das configurações que você passa:

azion create function [flags]
FlagCurtaTipoPadrãoDescrição
--active—string—Obrigatório, a menos que --file esteja definida. Ativa (true) ou desativa (false) a function. Sem ela, o comando pede que você selecione true ou false.
--args—string—Caminho de um arquivo JSON com os argumentos da function. O comando armazena o conteúdo do arquivo como default_args.
--code—string—Obrigatório, a menos que --file esteja definida. Caminho do arquivo com o código da function. Sem ela, o comando pede o caminho.
--execution-environment—string—Onde a function roda: application ou firewall.
--file—string—Caminho de um arquivo JSON com os atributos da function. Use - para ler o JSON da entrada padrão.
--name—string—Nome da function.

--execution-environment aceita somente application ou firewall. Qualquer outro valor, como edge_application, é recusado com este erro:

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

Este arquivo, ./code/function.js, guarda o código da function. Ele responde a toda requisição com o texto 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});

Este comando cria uma function ativa chamada my-function a partir desse arquivo, com os argumentos de ./code/args.json, para rodar em uma aplicação:

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

O comando imprime o ID da function:

Created function with ID 12359

Listar

azion list function lista as functions da sua conta, 50 por página:

azion list function [flags]
FlagCurtaTipoPadrãoDescrição
--details———Adiciona as colunas LAST EDITOR, REFERENCE COUNT e EXECUTION ENVIRONMENT às colunas ID, NAME e ACTIVE.
--filter—string—Nome pelo qual a lista é filtrada.
--order-by—string—Campo pelo qual a lista é ordenada.
--page—int1Número da página a retornar.
--page-size—int50Número de functions em cada página.

Este comando retorna a primeira página de uma lista dividida em páginas de duas functions:

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

O comando imprime uma linha por function:

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

Descrever

azion describe function imprime as configurações de uma function:

azion describe function [flags]
FlagCurtaTipoPadrãoDescrição
--function-id—int—ID da function a descrever.
--with-code———Imprime os mesmos campos que o comando sem ela. O código da function está no campo code da saída de --format json.

Este comando descreve a function com ID 12359:

azion describe function --function-id 12359

O comando imprime o ID, o nome, o último editor, o estado e a contagem de referências da function:

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

Com --format json, o comando imprime o objeto completo: 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 e version_state. O campo code guarda o código-fonte da function, e default_args guarda o conteúdo do arquivo de --args.

Com um ID que não existe, o comando falha com este erro:

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

Atualizar

azion update function altera o nome, o estado, o código, os argumentos ou o ambiente de uma function:

azion update function [flags]
FlagCurtaTipoPadrãoDescrição
--active—string—Ativa (true) ou desativa (false) a function.
--args—string—Caminho de um arquivo JSON com os novos argumentos da function. Seu conteúdo substitui default_args.
--code—string—Caminho do arquivo com o novo código da function.
--execution-environment—string—Onde a function roda: application ou firewall.
--file—string—Caminho de um arquivo JSON com os atributos a alterar. Use - para ler o JSON da entrada padrão.
--function-id—int—Obrigatório, também com --file. ID da function a atualizar. Sem ela, o comando pede o ID, mesmo quando o JSON de --file traz "id".
--name—string—Novo nome da function.

Este comando renomeia a function com ID 12359 para my-function-renamed e a desativa:

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

O comando imprime o ID da function atualizada:

Updated function with ID 12359

Com --code e --args, o mesmo comando substitui o código e os argumentos armazenados da function. O campo default_args passa então a guardar o conteúdo do novo arquivo de --args.

Excluir

azion delete function exclui uma function da biblioteca de functions:

azion delete function [flags]
FlagCurtaTipoPadrãoDescrição
--function-id—int—ID da function a excluir.

Este comando exclui a function com ID 12370:

azion delete function --function-id 12370 -y

O comando confirma a exclusão:

Function 12370 was successfully deleted

Usar um arquivo JSON

azion create function e azion update function leem os atributos da function de um arquivo JSON com --file.

Este arquivo cria uma function ativa chamada my-firewall-function, que roda em um firewall. Ele traz o código inline, no campo code:

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}

Passe o arquivo para o comando de criação:

azion create function --file fn-create.json

O comando imprime o ID da function:

Created function with ID 12370

Na atualização, o comando não lê "id" do arquivo, então passe --function-id na linha de comando. Este arquivo renomeia a function com ID 12370:

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

Passe o arquivo e o ID para o comando de atualização:

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

O comando imprime o ID da function atualizada:

Updated function with ID 12370

A function mantém os campos que o arquivo deixa de fora. Neste exemplo, ela continua ativa.

Recursos relacionados

Opções globais da Azion CLI

As opções que todo comando aceita, como --format, --out e -y.

Functions

O que é uma function e como uma requisição chega ao seu código.

Azion CLI function-instance

Os comandos que adicionam uma function a uma aplicação.

Azion CLI firewall-instance

Os comandos que adicionam uma function a um firewall.