Azion CLI origins command and its subcommands
See the command and subcommands that enable the management of your origins used on the Azion Platform using Azion CLI.
Listing your origins
Section titled Listing your originsList the origins available in your account.
Usage
Section titled Usage $ azioncli origins --application-id 12738
Required flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag gives the ID for the edge application and, based on that, the origins related to the application are listed.
Optional flags
Section titled Optional flagsdetails
Section titled detailsThe --details
option displays all relevant fields when listing.
The --help
option displays more information about the list
subcommand.
Creating an origin
Section titled Creating an originCreates an origin based on given attributes to be used with edge applications.
Usage
Section titled Usage $ azioncli origins create --application-id 1673635839 --name "name" --addresses "xxxxxx.me" --host-header "host"
Required flags
Section titled Required flagsThe --name
flag gives the origin’s name.
application-id
Section titled application-idThe --application-id
flag gives the ID for the edge application related to this origin.
addresses
Section titled addressesthe --addresses
flag passes a list of addresses linked to the origin being created.
host-header
Section titled host-headerThe --host-header
flag specifies the hostname of the server being accessed.
Optional flags
Section titled Optional flagsThe --help
option displays more information about the create
subcommand.
hmac-authentication
Section titled hmac-authenticationThe --hmac-authentication
option informs whether Hmac Authentication is used by the origin or not.
Expected values:
true
false
hmac-access-key
Section titled hmac-access-keyThe --hmac-access-key
option informs the Hmac access key, if the value informed through the --hmac-authentication
flag is true
.
hmac-region-name
Section titled hmac-region-nameThe --hmac-region-name
option informs the Hmac region name, if the value informed through the --hmac-authentication
flag is true
.
hmac-secret-key
Section titled hmac-secret-keyThe --hmac-secret-key
option informs the Hmac Secret Key, if the value informed through the --hmac-authentication
flag is true
.
host-header
Section titled host-headerThe --host-header
option specifies the hostname of the server being accessed.
origin-path
Section titled origin-pathThe --origin-path
option gives the path to be appended to the URI when forwarding the request to the origin. Leave it in blank to use only the URI.
origin-protocol-policy
Section titled origin-protocol-policyThe --origin-protocol-policy
option informs the protocol policy used in the origin.
origin-type
Section titled origin-typeThe --origin-type
option identifies the source of a record.
Expected values:
single_origin
load_balancer
The --in
option informs the file path to a JSON file containing all attributes of the origin that will be created.
Note: if the flag
--in
is given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren’t necessary.
Updating an origin
Section titled Updating an originUpdates an Origin based on the ID informed and given attributes.
Usage
Section titled Usage azioncli origins update --application-id 1673635839 --origin-key "58755fef-e830-4ea4-b9e0-6481f1ef496d" --name "newname" --addresses "xxxxxx.me" --host-header "host"
Required flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag informs the ID of the edge application related to the origin.
origin-key
Section titled origin-keyThe --origin-key
flag informs the origin key unique identifier.
Optional flags
Section titled Optional flagsThe --name
flag gives the origin’s name.
addresses
Section titled addressesthe --addresses
flag passes a list of addresses linked to the origin being updated.
host-header
Section titled host-headerThe --host-header
flag specifies the hostname of the server being accessed.
The --help
option displays more information about the update
subcommand.
hmac-authentication
Section titled hmac-authenticationThe --hmac-authentication
option informs whether Hmac Authentication is used by the origin or not.
Expected values:
true
false
hmac-access-key
Section titled hmac-access-keyThe --hmac-access-key
option informs the Hmac access key, if the value informed through the --hmac-authentication
flag is true
.
hmac-region-name
Section titled hmac-region-nameThe --hmac-region-name
option informs the Hmac region name, if the value informed through the --hmac-authentication
flag is true
.
hmac-secret-key
Section titled hmac-secret-keyThe --hmac-secret-key
option informs the Hmac Secret Key, if the value informed through the --hmac-authentication
flag is true
.
host-header
Section titled host-headerThe --host-header
option specifies the hostname of the server being accessed.
origin-path
Section titled origin-pathThe --origin-path
option gives the path to be appended to the URI when forwarding the request to the origin. Leave it in blank to use only the URI.
origin-protocol-policy
Section titled origin-protocol-policyThe --origin-protocol-policy
option informs the protocol policy used in the origin.
origin-type
Section titled origin-typeThe --origin-type
option identifies the source of a record.
Expected values:
single_origin
load_balancer
The --in
option informs the file path to a JSON file containing all attributes of the origin that will be updated.
Note: if the flag
--in
is given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren’t necessary.
Describing an origin
Section titled Describing an originReturns details about a specific origin, based on a given ID.
Usage
Section titled Usage $ azioncli origins describe --application-id 4312 --origin-id 31223
Required flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag informs the ID of the edge application related to the origin that will be described.
origin-id
Section titled origin-idThe --origin-id
flag informs the ID of the origin that will be 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 describe
subcommand.
Deleting an origin
Section titled Deleting an originDeletes an origin on the Azion platform.
Usage
Section titled Usage $ azioncli origins delete --application-id 1234 --origin-key 03a6e7bf-8e26-49c7-a66e-ab8eaa425086
Required flags
Section titled Required flagsapplication-id
Section titled application-idThe --application-id
flag informs the ID of the edge application related to the origin that will be deleted.
origin-key
Section titled origin-keyThe --origin-key
flag informs the origin key unique identifier.
Optional flags
Section titled Optional flagsThe --help
option displays more information about the delete
subcommand.