Azion CLI describe
With the azion describe [resource]
command you can describe:
Edge applications
Section titled Edge applicationsUsage
Section titled UsageRequired flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag specifies the unique identifier of the edge application to display its attributes in detail.
Optional flags
Section titled Optional flagsformat
Section titled formatThe --format
flag changes the output format by passing the json
value to the flag.
The --help
flag displays more information about the describe command.
application-id
Section titled application-idThe --application-id
flag specifies the unique identifier of the edge application.
The --out
flag exports the output to the given <file_path/file_name.ext>
.
Edge functions
Section titled Edge functionsUsage
Section titled UsageRequired flags
Section titled Required flagsfunction-id
Section titled function-idThe --function-id
flag is the unique identifier of the edge function.
Optional flags
Section titled Optional flagsformat
Section titled formatThe --format
flag changes the output format. Options include json
and other supported formats.
The --out
flag exports the output to the given <file_path/file_name.ext>
.
with-code
Section titled with-codeThe --with-code
flag displays the edge function’s code; disabled by default.
The --help
option displays more information about the azion describe edge-function
command.
Rules engine
Section titled Rules engineUsage
Section titled UsageRequired flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag specifies your edge application ID.
rule-id
Section titled rule-idThe --rule-id
flag specifies your Rules Engine’s rule ID.
phase
Section titled phaseThe --phase
flag specifies the phase of your Rules Engine’s rule. It’s either request
or response
. The default is request
.
Optional flags
Section titled Optional flagsformat
Section titled formatThe --format
flag changes the output format, and you can use json
as a value to specify JSON format.
The --out
flag exports the output of the command to the given file path, including the file name and extension.
The -h
or --help
flag displays more information about the azion describe rules-engine
command.
Cache settings
Section titled Cache settingsUsage
Section titled UsageRequired flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag sets the unique identifier for the edge application.
cache-setting-id
Section titled cache-setting-idThe --cache-setting-id
flag sets the unique identifier for a Cache Settings configuration.
Optional flags
Section titled Optional flagsformat
Section titled formatThe --format
option changes the output format. Pass the value json
to the flag to get the output in JSON format.
The --help
option displays more information about the azion describe cache-setting
command.
The --out
option exports the output to the given file path or file name with an extension. Example: --out "./tmp/test.json"
.
Domains
Section titled DomainsDescription
Section titled DescriptionDisplays information about the domain via a given ID to show the application’s attributes in detail.
Usage
Section titled UsageRequired flags
Section titled Required flagsdomain-id
Section titled domain-idThe --domain-id
flag specifies the unique identifier of the domain you want to retrieve detailed information from.
Optional flags
Section titled Optional flagsformat
Section titled formatThe --format
option changes the output format. You can pass the value json
to the flag to get the output in JSON format.
The --out
option exports the output to the given file path and filename with the specified extension.
The -h
or --help
option displays more information about the azion describe domain
command.
Examples
Section titled ExamplesOrigins
Section titled OriginsUsage
Section titled UsageRequired flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag sets the unique identifier for an edge application. It’s a mandatory field.
origin-key
Section titled origin-keyThe --origin-key
flag sets the unique identifier for an origin. It’s a mandatory field.
Optional flags
Section titled Optional flagsformat
Section titled formatThe --format
flag changes the output format. Pass the value json
to the flag to get the output in JSON format.
The --out
flag exports the output to the given file path or filename with extension.
The -h
or --help
option displays more information about the azion describe origin
action.
Variables
Section titled VariablesUsage
Section titled UsageRequired flags
Section titled Required flagsvariable-id
Section titled variable-idThe --variable-id
flag gives the UUID for the variable being described.
Optional flags
Section titled Optional flagsThe --out
option exports the output of the describe
command to a given filepath.
format
Section titled formatThe --format
option, followed by the value json
, changes the output format to JSON.
The --help
option displays more information about the azion describe variables
command.
Edge Storage object
Section titled Edge Storage objectUsage
Section titled UsageRequired flags
Section titled Required flagsbucket-name
Section titled bucket-nameThe --bucket-name
flag specifies the name of the Edge Storage bucket that includes the object you want to describe.
object-key
Section titled object-keyThe --object-key
flag specifies the key (name) of the object in the bucket that you want to describe.
Optional flags
Section titled Optional flagsThe -h
or --help
option displays more detailed information about the azion describe edge-storage object
command.
format
Section titled formatThe --format
option allows you to specify the format in which the command output is displayed. For example, ‘json’.
The --out
option lets you specify a path where the output of the command will be stored. For example, ‘./tmp/test.json’.