Aggregator CLI Commands #
This is the complete list of Aggregator CLI commands. Click on a link to read a full description.
| Verb | Use | Action |
|---|---|---|
| logon.azure | Azure | Logon into Azure. This must be done before other verbs. |
| logon.ado | Both | Logon into Azure DevOps. This must be done before other verbs. |
| logon.env | Both | Logon into both Azure and Azure DevOps using Environment Variables. [v0.9.14] |
| install.instance | Azure | Creates a new Aggregator instance in Azure. |
| add.rule | Azure | Add a rule to existing Aggregator instance in Azure. |
| map.rule | Azure | Maps an Aggregator Rule in Azure to existing Azure DevOps Projects, DevOps events are sent to the rule. |
| map.local.rule | Docker | Maps an Aggregator Rule hosted in Docker to existing Azure DevOps Projects, DevOps events are sent to the rule. [v1.0] |
| list.instances | Azure | Lists Aggregator instances in the specified Azure Region or Resource Group or in the entire Subscription. |
| list.rules | Azure | List the rules in an existing Aggregator instance in Azure. |
| list.mappings | Azure | Lists mappings from existing Azure DevOps Projects to Aggregator Rules. |
| invoke.rule | Both | Executes a rule locally or in an existing Aggregator instance. |
| configure.instance | Azure | Configures an existing Aggregator instance (currently the Azure DevOps authentication). |
| update.instance | Azure | Updates the runtime of an Aggregator instance in Azure. |
| configure.rule | Azure | Change a rule configuration (currently only enabling/disabling). |
| update.rule | Azure | Update the code of a rule and/or its runtime. |
| update.mappings | Azure | Updates any mapping from an old Aggregator instance in Azure to a new Aggregator instance. |
| unmap.rule | Azure | Removes a mapping to an Aggregator Rule from a Azure DevOps Project. |
| remove.rule | Azure | Remove a rule from existing Aggregator instance in Azure, removing any mapping to the Rule. |
| uninstall.instance | Azure | Destroy an Aggregator instance in Azure, removing any mapping to the Rules. |
| logoff | Both | Logoff removing any locally cached credential. |
| help | Both | Display more information on a specific command. |
| version | Both | Displays the Aggregator version. |
You can see a few Command examples in Sample Aggregator CLI usage.
Exit codes #
Aggregator CLI returns 0 when a command completes successfully. You can check the return code using %ERRORLEVEL% in cmd, $LastExitCode in PowerShell, or $? in bash.
| Exit Code | Meaning |
|---|---|
| 0 | Command succeeded |
| 1 | Command failed |
| 2 | Invalid argument(s) or unknown command |
| 3 | Specified resource(s) not found e.g. in list commands |
| 99 | Unexpected internal error |
Environment Variables #
Telemetry [v0.9.14] #
Aggregator CLI collects anonymised telemetry data, to report on which commands and command options are most used.
You can turn off telemetry by setting the AGGREGATOR_TELEMETRY_DISABLED to a true value, e.g.
AGGREGATOR_TELEMETRY_DISABLED=1
The Runtime Engine, running in the Azure Function, does not collect any telemetry data.
Automatic Version Check [v1.0] #
You can turn off the automatic check for new CLI version, setting to a true value:
AGGREGATOR_NEW_VERSION_CHECK_DISABLED=1
Shared secret [v1.0] #
Aggregator_SharedSecret is used by the map.local.rule command for initial authentication.
Use a long complex password.
This value must be identical on CLI and the Docker container.