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.
1. Listing your origins
List the origins available in your account.
Usage
$ azioncli origins --application-id 12738
Required flags
application-id
The --application-id
flag gives the ID for the edge application and, based on that, the origins related to the application are listed.
Optional flags
details
The --details
option displays all relevant fields when listing.
help
The --help
option displays more information about the list
subcommand.
2. Creating an origin
Creates an origin based on given attributes to be used with edge applications.
Usage
$ azioncli origins create --application-id 1673635839 --name "name" --addresses "xxxxxx.me" --host-header "host"
Required flags
name
The --name
flag gives the origin’s name.
application-id
The --application-id
flag gives the ID for the edge application related to this origin.
addresses
the --addresses
flag passes a list of addresses linked to the origin being created.
host-header
The --host-header
flag specifies the hostname of the server being accessed.
Optional flags
help
The --help
option displays more information about the create
subcommand.
hmac-authentication
The --hmac-authentication
option informs whether Hmac Authentication is used by the origin or not.
Expected values:
true
false
hmac-access-key
The --hmac-access-key
option informs the Hmac access key, if the value informed through the --hmac-authentication
flag is true
.
hmac-region-name
The --hmac-region-name
option informs the Hmac region name, if the value informed through the --hmac-authentication
flag is true
.
hmac-secret-key
The --hmac-secret-key
option informs the Hmac Secret Key, if the value informed through the --hmac-authentication
flag is true
.
host-header
The --host-header
option specifies the hostname of the server being accessed.
origin-path
The --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
The --origin-protocol-policy
option informs the protocol policy used in the origin.
origin-type
The --origin-type
option identifies the source of a record.
Expected values:
single_origin
load_balancer
in
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.
3. Updating an origin
Updates an Origin based on the ID informed and given attributes.
Usage
azioncli origins update --application-id 1673635839 --origin-key "58755fef-e830-4ea4-b9e0-6481f1ef496d" --name "newname" --addresses "xxxxxx.me" --host-header "host"
Required flags
application-id
The --application-id
flag informs the ID of the edge application related to the origin.
origin-key
The --origin-key
flag informs the origin key unique identifier.
Optional flags
name
The --name
flag gives the origin’s name.
addresses
the --addresses
flag passes a list of addresses linked to the origin being updated.
host-header
The --host-header
flag specifies the hostname of the server being accessed.
help
The --help
option displays more information about the update
subcommand.
hmac-authentication
The --hmac-authentication
option informs whether Hmac Authentication is used by the origin or not.
Expected values:
true
false
hmac-access-key
The --hmac-access-key
option informs the Hmac access key, if the value informed through the --hmac-authentication
flag is true
.
hmac-region-name
The --hmac-region-name
option informs the Hmac region name, if the value informed through the --hmac-authentication
flag is true
.
hmac-secret-key
The --hmac-secret-key
option informs the Hmac Secret Key, if the value informed through the --hmac-authentication
flag is true
.
host-header
The --host-header
option specifies the hostname of the server being accessed.
origin-path
The --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
The --origin-protocol-policy
option informs the protocol policy used in the origin.
origin-type
The --origin-type
option identifies the source of a record.
Expected values:
single_origin
load_balancer
in
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.
4. Describing an origin
Returns details about a specific origin, based on a given ID.
Usage
$ azioncli origins describe --application-id 4312 --origin-id 31223
Required flags
application-id
The --application-id
flag informs the ID of the edge application related to the origin that will be described.
origin-id
The --origin-id
flag informs the ID of the origin that will be 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 describe
subcommand.
5. Deleting an origin
Deletes an origin on the Azion platform.
Usage
$ azioncli origins delete --application-id 1234 --origin-key 03a6e7bf-8e26-49c7-a66e-ab8eaa425086
Required flags
application-id
The --application-id
flag informs the ID of the edge application related to the origin that will be deleted.
origin-key
The --origin-key
flag informs the origin key unique identifier.
Optional flags
help
The --help
option displays more information about the delete
subcommand.
Related documentation
- Edge applications command and its subcommands
- Edge functions command and its subcommands
- Managing your Edge Functions with Azion CLI
- Creating an edge application with Azion CLI
Didn’t find what you were looking for? Open a support ticket.