profile command persists those commonly used parameters that are needed for the other commands of the tool. Hence, this command is usually executed before the other installation, deployment, or update commands.
The process of installing Sidra through the CLI tool requires to pass over the same information, at different steps. To avoid duplicating typing efforts, the profile command creates a JSON file with the common shared information for the installation steps. The JSON file is saved in the same folder where the Sidra.exe resides, from where it was launched.
The profile command can also be used to alter the existing profile, such as changing the environment for which the profile will be applied.
The usage options are the create and the switch options.
.\sidra.exe profile create [parameters] .\sidra.exe profile switch [parameters] .\sidra.exe profile [create|switch] --help
1. Create option¶
This option is creating the profile JSON file, persisting the passed information.
environmentparameter cannot have more than 4 characters.
In Sidra versions prior to 1.12 (2022.R2), the information from the parameter --devOpsRepositoryUrl was provided with --devOpsProjectUrl, the --devOpsProject, and --gitRepository parameters. The --devOpsProjectUrl was actually expecting the Azure Dev Ops Organization URL, like "https://dev.azure.com/MyOrganization".
.\sidra.exe profile create ` --devOpsRepositoryUrl="https://dev.azure.com/MyOrganization/MyProject/_git/MyRepository" ` --devOpsPAT="j6zqsNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNtquda" ` --environment="test" ` --tenant="GUIDGUID-GUID-GUID-GUID-GUIDGUIDGUID"
2. Switch option¶
This option complements the
create option, allowing to update the parameter values in the
It is common that Sidra is installed on two or more environments -
prod - for the same organization or Azure subscription. The
switch option is mostly used for replacing the
environment name of the profile being used for installation. Usually, in such cases, most of the other parameters remain unchanged, and it is only the
environment being changed, on which we're applying same steps.
environment parameter cannot have more than 4 characters.