Azion CLI describe

With the azion describe [resource] command you can describe:

• Edge applications.
  • Edge functions.
  • Rules engine.
  • Cache settings.
  • Domains.
  • Origins.
  • Variables.
  • Edge Storage object.

Edge applications

Usage

azion describe edge-application --application-id <application_id> [flags]

Required flags

application-id

The --application-id flag specifies the unique identifier of the edge application to display its attributes in detail.

Optional flags

format

The --format flag changes the output format by passing the json value to the flag.

help

The --help flag displays more information about the describe command.

application-id

The --application-id flag specifies the unique identifier of the edge application.

out

The --out flag exports the output to the given <file_path/file_name.ext>.

Edge functions

Usage

azion describe edge-function --function-id <function_id>

Required flags

function-id

The --function-id flag is the unique identifier of the edge function.

Optional flags

format

The --format flag changes the output format. Options include json and other supported formats.

out

The --out flag exports the output to the given <file_path/file_name.ext>.

with-code

The --with-code flag displays the edge function’s code; disabled by default.

help

The --help option displays more information about the azion describe edge-function command.

Rules engine

Usage

azion describe rules-engine --application-id <application-id> --rule-id <rule-id> --phase <phase> [--format <format>] [--out <output-file>]

Required flags

application-id

The --application-id flag specifies your edge application ID.

rule-id

The --rule-id flag specifies your Rules Engine’s rule ID.

phase

The --phase flag specifies the phase of your Rules Engine’s rule. It’s either request or response. The default is request.

Optional flags

format

The --format flag changes the output format, and you can use json as a value to specify JSON format.

out

The --out flag exports the output of the command to the given file path, including the file name and extension.

help

The -h or --help flag displays more information about the azion describe rules-engine command.

Cache settings

Usage

azion describe cache-setting --application-id 1673635839 --cache-setting-id 107313

Required flags

application-id

The --application-id flag sets the unique identifier for the edge application.

cache-setting-id

The --cache-setting-id flag sets the unique identifier for a Cache Settings configuration.

Optional flags

format

The --format option changes the output format. Pass the value json to the flag to get the output in JSON format.

help

The --help option displays more information about the azion describe cache-setting command.

out

The --out option exports the output to the given file path or file name with an extension. Example: --out "./tmp/test.json".

Domains

Description

Displays information about the domain via a given ID to show the application’s attributes in detail.

Usage

azion describe domain --domain-id 4312

Required flags

domain-id

The --domain-id flag specifies the unique identifier of the domain you want to retrieve detailed information from.

Optional flags

format

The --format option changes the output format. You can pass the value json to the flag to get the output in JSON format.

out

The --out option exports the output to the given file path and filename with the specified extension.

help

The -h or --help option displays more information about the azion describe domain command.

Examples

azion describe domain --domain-id 1337 --out "./tmp/test.json"
azion describe domain --domain-id 1337 --format json

Origins

Usage

azion describe origin --application-id <application-id> --origin-key <origin-key>

Required flags

application-id

The --application-id flag sets the unique identifier for an edge application. It’s a mandatory field.

origin-key

The --origin-key flag sets the unique identifier for an origin. It’s a mandatory field.

Optional flags

format

The --format flag changes the output format. Pass the value json to the flag to get the output in JSON format.

out

The --out flag exports the output to the given file path or filename with extension.

help

The -h or --help option displays more information about the azion describe origin action.

Variables

Usage

  azion describe variables --variable-id 1673635839

Required flags

variable-id

The --variable-id flag gives the UUID for the variable being described.

Optional flags

out

The --out option exports the output of the describe command to a given filepath.

format

The --format option, followed by the value json, changes the output format to JSON.

help

The --help option displays more information about the azion describe variables command.

Edge Storage object

Usage

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'

Required flags

bucket-name

The --bucket-name flag specifies the name of the Edge Storage bucket that includes the object you want to describe.

object-key

The --object-key flag specifies the key (name) of the object in the bucket that you want to describe.

Optional flags

help

The -h or --help option displays more detailed information about the azion describe edge-storage object command.

format

The --format option allows you to specify the format in which the command output is displayed. For example, ‘json’.

out

The --out option lets you specify a path where the output of the command will be stored. For example, ‘./tmp/test.json’.