# Azion CLI describe Com o comando `azion describe [recurso]` você pode acessar informações de suas: - [Applications](#applications). - [Functions](#functions). - [Rules engine](#rules-engine). - [Cache settings](#cache-settings). - [Workloads](#workloads). - [Connectors](#edge-connectors). - [Variables](#variables). - [Object Storage object](#edge-storage-object). - [WAF](#waf). - [WAF exceptions](#waf-exceptions). :::note No caso de um ou mais campos obrigatórios não serem informados através das flags específicas, uma mensagem interativa será exibida, solicitando essas informações. ::: --- ## Applications ### Uso ```bash azion describe edge-application --application-id [flags] ``` ### Flags obrigatórias #### application-id A flag `--application-id` especifica o identificador exclusivo da application para exibir seus atributos em detalhes. ### Flags opcionais #### format A flag `--format` altera o formato de saída passando o valor `json` para a flag. #### help A flag `--help` exibe mais informações sobre o comando de descrição. #### application-id A flag `--application-id` especifica o identificador exclusivo da application. #### out A flag `--out` exporta a saída para o caminho/arquivo fornecido ``. :::note Substitua `` na flag `--application-id` pelo ID real da application que deseja descrever. ::: --- ## Functions ### Uso ```bash azion describe edge-function --function-id ``` ### Flags obrigatórias #### function-id A flag `--function-id` é o identificador único da function. ### Flags opcionais #### format A flag `--format` altera o formato de saída. As opções incluem `json` e outros formatos suportados. #### out A flag `--out` exporta a saída para o dado ``. #### with-code A flag `--with-code` exibe o código da function; desativado por padrão. #### help A opção `--help` exibe mais informações sobre o comando `azion describe edge-function`. --- ## Rules engine ### Uso ```bash azion describe rules-engine --application-id --rule-id --phase ``` ### Flags obrigatórias #### application-id A flag `--application-id` especifica o ID da sua application. #### rule-id A flag `--rule-id` especifica o ID da regra do Rules Engine. #### phase A flag `--phase` especifica a fase da regra do Rules Engine. Pode ser `request` ou `response`. O padrão é `request`. ### Flags opcionais #### format A flag `--format` altera o formato de saída e você pode usar `json` como valor para especificar o formato JSON. #### out A flag `--out` exporta a saída do comando para o caminho do arquivo fornecido, incluindo o nome do arquivo e a extensão. #### help A flag `-h` ou `--help` exibe mais informações sobre o comando `azion describe rules-engine`. --- ## Cache settings ### Uso ```bash $ azion describe cache-setting --application-id 1673635839 --cache-setting-id 107313 ``` ### Flags obrigatórias #### application-id A flag `--application-id` define o identificador único para a application. #### cache-setting-id A flag `--cache-setting-id` define o identificador único para uma configuração de cache. ### Flags opcionais #### format A opção `--format` altera o formato de saída. Passe o valor `json` para a opção para obter a saída em formato JSON. #### help A opção `--help` exibe mais informações sobre o comando `azion describe cache-setting`. #### out A opção `--out` exporta a saída para o caminho ou nome do arquivo fornecido com a extensão. Exemplo: `--out "./tmp/test.json"`. --- ## Connectors ### Uso ```bash $ azion describe origin --application-id --origin-key ``` ### Flags obrigatórias #### application-id A flag `--application-id` define o identificador único para uma application. #### origin-key A flag `--origin-key` define o identificador único para uma origem. ### Flags opcionais #### format A flag `--format` altera o formato de saída. Passe o valor `json` com a flag para obter a saída em formato JSON. #### out A flag `--out` exporta a saída para o caminho ou nome do arquivo fornecido com a extensão. ### help A opção `-h` ou `--help` exibe mais informações sobre a ação `azion describe origin`. --- ## Variables ### Uso ```bash azion describe variables --variable-id 1673635839 ``` ### Flags obrigatórias #### variable-id A flag `--variable-id` fornece o UUID da variável que está sendo descrita. ### Flags opcionais #### out A opção `--out` exporta a saída do comando `describe` para um determinado caminho de arquivo. #### format A opção `--format` , seguida pelo valor `json`, altera o formato de saída para JSON. #### help A opção `--help` exibe mais informações sobre o comando `azion describe variables`. --- ## Object Storage object #### Uso ```bash azion describe edge-storage objects --bucket-name 'asdf' --object-key 'test.json' azion describe edge-storage objects --bucket-name 'asdf' --object-key 'test.json' --format json azion describe edge-storage objects --bucket-name 'asdf' --object-key 'test.json' --out './tmp/test.json' ``` #### Flags obrigatórias ##### bucket-name A flag `--bucket-name` especifica o nome do bucket no Object Storage que contém o objeto que você deseja descrever. ##### object-key A flag `--object-key` especifica a chave (nome) do objeto no bucket que você deseja descrever. #### Flags opcionais ##### help A opção `-h` ou `--help` exibe informações mais detalhadas sobre o comando `azion describe edge-storage object`. ##### format A opção `--format` permite que você especifique o formato em que a saída do comando é exibida. Por exemplo, 'json'. ##### out A opção `--out` permite que você especifique um caminho onde a saída do comando será armazenada. Por exemplo, './tmp/test.json'. --- ## WAF Descreve um WAF (Web Application Firewall). #### Uso ```bash azion describe waf --waf-id [flags] ``` #### Flags obrigatórias ##### waf-id A flag `--waf-id` especifica o identificador único do WAF. #### Flags opcionais ##### format A flag `--format` altera o formato de saída. Passe `json` para obter saída em JSON. ##### out A flag `--out` exporta a saída para o caminho de arquivo fornecido. ##### help A flag `--help` exibe mais informações sobre o comando `azion describe waf`. --- ## WAF exceptions Descreve uma exceção de WAF. #### Uso ```bash azion describe waf-exceptions --exception-id --waf-id [flags] ``` #### Flags obrigatórias ##### exception-id A flag `--exception-id` especifica o identificador único da exceção de WAF. ##### waf-id A flag `--waf-id` especifica o identificador único do WAF. #### Flags opcionais ##### format A flag `--format` altera o formato de saída. Passe `json` para obter saída em JSON. ##### out A flag `--out` exporta a saída para o caminho de arquivo fornecido. ##### help A flag `--help` exibe mais informações sobre o comando `azion describe waf-exceptions`.