Azion CLI config

Comandos da Azion CLI que criam o azion.json, aplicam os recursos de um azion.config e excluem os recursos que o azion.json lista, com cada flag e seu padrão.

Última atualização

Ver como Markdown Configurar agente

Os comandos config da Azion CLI gerenciam recursos da Azion a partir de arquivos de manifesto: init cria um arquivo azion.json vazio, apply cria ou atualiza os recursos que um arquivo azion.config declara, e delete exclui os recursos que o azion.json lista. As opções que todo comando aceita, como --format, --out e -y, estão em Opções globais da Azion CLI.

Uso

azion config agrupa os subcomandos init, apply e delete:

azion config [flags]

O comando não tem flags próprias. Execute-o com um subcomando.

Por padrão, os subcomandos config leem e gravam o azion.json no diretório atual. Os comandos azion init, azion link e azion deploy mantêm o mesmo arquivo na pasta azion. Para apontar um subcomando config para outra pasta, use --config-dir.

Init

azion config init cria um arquivo azion.json para guardar o estado da sua aplicação:

azion config init [flags]
FlagCurtaTipoPadrãoDescrição
--config-dir—string"."Caminho da pasta onde o comando cria o azion.json.
--force———Sobrescreve um arquivo azion.json que já existe.

Este comando cria o arquivo em uma pasta vazia:

azion config init

O comando imprime o caminho do arquivo que criou:

Texto
01Creating azion.json file
02Configuration file created successfully: <project-dir>/azion.json
03For more information on azion.config, visit: https://github.com/aziontech/lib?tab=readme-ov-file#config/

O novo azion.json traz todas as chaves com um valor vazio:

JSON
01{
02 "name": "",
03 "bucket": "",
04 "preset": "",
05 "env": "",
06 "prefix": "",
07 "function": null,
08 "application": {
09 "id": 0,
10 "name": ""
11 },
12 "domain": {
13 "id": 0,
14 "name": "",
15 "domain_name": "",
16 "url": ""
17 },
18 "rt-purge": {
19 "purge_on_publish": false
20 },
21 "origin": null,
22 "rules-engine": {
23 "created": false,
24 "rules": null
25 },
26 "cache-settings": null,
27 "workloads": {
28 "id": 0,
29 "name": "",
30 "domains": null,
31 "url": "",
32 "deployment_id": null
33 },
34 "connectors": null
35}

Quando a pasta já tem um arquivo azion.json, o comando mantém o arquivo e para com Error: Configuration file already exists. Para substituir o arquivo, adicione --force.

Apply

azion config apply lê o arquivo azion.config da pasta e cria ou atualiza na sua conta os recursos que ele declara:

azion config apply [flags]
FlagCurtaTipoPadrãoDescrição
--config-dir—string"."Caminho da pasta que contém o azion.json e o arquivo azion.config.
--config-file—string—Caminho para o arquivo azion.config a aplicar, como azion.staging.config.cjs. Enquanto --config-dir indica uma pasta, a que contém o azion.json e o arquivo azion.config, --config-file indica o próprio arquivo de configuração. Um caminho relativo é resolvido a partir do diretório atual. Um caminho para um arquivo inexistente faz o comando falhar.

Este arquivo azion.config.mjs declara uma aplicação com uma configuração de cache e uma regra de requisição, e um workload que faz o deploy da aplicação:

JavaScript
01export default {
02 applications: [
03 {
04 name: 'my-app',
05 active: true,
06 cache: [
07 {
08 name: 'my-app-cache',
09 browser: { maxAgeSeconds: 600 },
10 edge: { maxAgeSeconds: 600 }
11 }
12 ],
13 rules: {
14 request: [
15 {
16 name: 'Set cache policy',
17 active: true,
18 criteria: [[{ variable: '${uri}', conditional: 'if', operator: 'starts_with', argument: '/' }]],
19 behaviors: [{ type: 'set_cache_policy', attributes: { value: 'my-app-cache' } }]
20 }
21 ]
22 }
23 }
24 ],
25 workloads: [
26 {
27 name: 'my-app',
28 active: true,
29 infrastructure: 1,
30 deployments: [
31 {
32 name: 'my-app',
33 current: true,
34 active: true,
35 strategy: { type: 'default', attributes: { application: 'my-app' } }
36 }
37 ]
38 }
39 ]
40}

Este comando aplica o arquivo a partir da pasta que o contém e que contém o arquivo azion.json criado pelo config init:

azion config apply

O comando gera o .edge/manifest.json a partir do arquivo e depois imprime uma linha por recurso que cria:

Texto
01…
02[Azion] [IaC] › ✔ success Manifest generated successfully at <project-dir>/.edge/manifest.json
03Reading manifest.json file
04Edge Application my-app with id 1234567894 successfully created
05Cache Setting my-app-cache with id 123469 successfully created
06Rule Engine Set cache policy with id 123462 successfully created
07Rules Engine of Application with id 1234567894 successfully ordered (request phase)
08Workload my-app with id 1234567904 successfully created
09Workload Deployment my-app with id 123474 successfully created
10Configuration applied successfully: 3 resource(s) applied

O comando registra o ID de cada recurso no azion.json. Uma segunda execução com o mesmo arquivo atualiza os mesmos recursos pelo ID, em vez de criar recursos novos:

azion config apply

O comando imprime uma linha por recurso que atualiza:

Texto
01…
02[Azion] [IaC] › ✔ success Manifest generated successfully at <project-dir>/.edge/manifest.json
03Reading manifest.json file
04Edge Application my-app with id 1234567894 successfully updated
05Cache Setting my-app-cache with id 123469 successfully updated
06Rule Engine Set cache policy with id 123462 successfully updated
07Rules Engine of Application with id 1234567894 successfully ordered (request phase)
08Workload my-app with id 1234567904 successfully updated
09Workload Deployment my-app with id 123474 successfully updated
10Configuration applied successfully: 3 resource(s) applied

Delete

azion config delete exclui todos os recursos que o azion.json lista e depois redefine o azion.json para o arquivo vazio que o config init cria:

azion config delete [flags]
FlagCurtaTipoPadrãoDescrição
--config-dir—string"."Caminho relativo da pasta que contém o seu arquivo azion.json.
--force———Exclui os recursos sem pedir confirmação.

Sem --force, o comando pergunta This will delete all resources defined in azion.json. Continue? (y/N) antes de excluir qualquer coisa.

Recursos relacionados

Opções globais da Azion CLI

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

azion.config.js

As chaves que um arquivo azion.config declara, que o config apply transforma em recursos.

Azion CLI deploy

Como um projeto passa pelo build e pelo deploy, com os IDs que ele grava em azion/azion.json.

Workloads

O que um workload e o seu deployment fazem com a aplicação que o config apply cria.