Azion CLI waf-exceptions
Comandos da Azion CLI que criam, listam, descrevem, atualizam e excluem exceções do WAF, com cada flag, seu tipo e seu padrão.
Os comandos waf-exceptions da Azion CLI criam, listam, descrevem, atualizam e excluem as exceções de um Web Application Firewall (WAF). Uma exceção isenta uma parte de uma requisição de uma regra do WAF. Todo comando recebe o --waf-id do WAF que guarda as exceções. As opções que todo comando aceita, como --format, --out e -y, estão em Opções globais.
Criar
azion create waf-exceptions cria uma exceção em um WAF a partir de um arquivo JSON:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--active | — | string | "true" | Ativa (true) ou desativa (false) a exceção. |
--conditions | — | string | — | Condições da exceção, em formato JSON. |
--file | — | string | — | Obrigatório. Caminho de um arquivo JSON com os atributos da exceção. Use - para ler o JSON da entrada padrão. Sem ela, o comando falha com Error: failed to create the WAF Exception: ["Ensure this field has at least 1 elements."], qualquer que seja o conteúdo de --conditions. |
--name | — | string | — | Nome da exceção. |
--operator | — | string | — | Operador que compara as condições: regex ou contains. |
--path | — | string | — | Caminho ao qual a exceção se aplica. |
--rule-id | — | int | — | ID da regra do WAF à qual a exceção se aplica. |
--waf-id | — | int | — | ID do WAF que guarda a exceção. |
Este arquivo descreve uma exceção ativa chamada my-exception. Ela isenta o parâmetro de query string chamado docs da regra 1000 do WAF nas requisições cujo caminho contém /my-path:
Este comando cria a exceção a partir do arquivo exception.json no WAF com ID 12347:
O comando imprime o ID da exceção:
Listar
azion list waf-exceptions lista as exceções de um WAF, 50 por página:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--details | — | — | — | Adiciona as colunas LAST EDITOR e LAST MODIFIED às colunas ID, NAME, RULE ID, PATH e ACTIVE. |
--filter | — | string | — | Nome pelo qual filtrar a lista. |
--order-by | — | string | — | Campo pelo qual ordenar a lista. |
--page | — | int | 1 | Número da página a retornar. |
--page-size | — | int | 50 | Número de exceções em cada página. |
--waf-id | — | int | — | ID do WAF cujas exceções o comando lista. |
Este comando lista as exceções do WAF com ID 12347:
O comando imprime uma linha por exceção:
Descrever
azion describe waf-exceptions imprime as configurações de uma exceção:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--exception-id | — | int | — | ID da exceção a descrever. |
--waf-id | — | int | — | ID do WAF que guarda a exceção. |
Este comando descreve a exceção com ID 123486 no WAF com ID 12347:
O comando imprime a regra, o caminho, o operador e o estado da exceção:
Com --format json, o comando imprime o objeto completo: active, conditions, id, last_editor, last_modified, name, operator, path e rule_id. O array conditions aparece somente na saída JSON.
Atualizar
azion update waf-exceptions altera o nome, a regra, o caminho, as condições ou o estado de uma exceção:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--active | — | string | "true" | Ativa (true) ou desativa (false) a exceção. |
--conditions | — | string | — | Condições da exceção, em formato JSON. |
--exception-id | — | int | — | ID da exceção a atualizar. |
--file | — | string | — | Caminho de um arquivo JSON com os atributos a alterar. Use - para ler o JSON da entrada padrão. |
--name | — | string | — | Novo nome da exceção. |
--operator | — | string | — | Operador que compara as condições: regex ou contains. |
--path | — | string | — | Caminho ao qual a exceção se aplica. |
--rule-id | — | int | — | ID da regra do WAF à qual a exceção se aplica. |
--waf-id | — | int | — | ID do WAF que guarda a exceção. |
Excluir
azion delete waf-exceptions exclui uma exceção de um WAF:
| Flag | Curta | Tipo | Padrão | Descrição |
|---|---|---|---|---|
--exception-id | — | int | — | ID da exceção a excluir. |
--waf-id | — | int | — | ID do WAF que guarda a exceção. |
Usar um arquivo JSON
azion create waf-exceptions lê os atributos de uma exceção de um arquivo JSON com --file. O arquivo carrega name, rule_id, path, operator, active e conditions, e o ID do WAF vai na linha de comando com --waf-id.
Cada entrada de conditions recebe um valor match, que nomeia a parte da requisição que a exceção cobre. O valor specific_query_string_name recebe também uma chave name, que guarda o nome do parâmetro de query string. Para cada valor que match aceita e as chaves que cada um recebe, consulte Exceções.
Quando a plataforma recusa uma condição, o erro que o comando imprime não nomeia o campo. Um valor match que a plataforma não aceita falha com este erro:
Uma condição specific_query_string_name que carrega value no lugar de name falha com Error: failed to create the WAF Exception: ["This field is required."]. Para ver qual campo a plataforma recusou, adicione --debug e mantenha a linha que carrega o erro detalhado:
A linha nomeia o campo pelo seu JSON pointer, depois de Source::