Skip to content

Profile command

The sidra.exe 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.

Usage Options

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.

Parameters

    --devOpsRepositoryUrl
The URL of the target Azure DevOps repository, where code and template files are to be copied. It comes in the format like https://dev.azure.com/<organizationName>/<projectName>/_git/<repositoryName>.

    --devOpsPAT
The Azure DevOps Personal Access Token (PAT) to use for deploying Sidra. To get it, click on the User Settings icon in Azure DevOps site and choose Personal Access Token. When the user is performing the deployment, must have full access to the Azure DevOps project and the Personal Access Token should be issued with Scope being Full access.
    --environment
The name of the environment where Sidra is being installed / deployed: test, dev, or prod. The environment parameter cannot have more than 4 characters.
    --tenant
The Azure Active Directory Tenant ID of the Azure subscription, the GUID identifying the tenant of the customer organization for which Sidra is deployed.

Note

In Sidra versions prior to 1.12, 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".

Usage example

    .\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 profile.json file.

It is common that Sidra is installed on two or more environments - dev, test, 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.

Parameters

    --environment
The name of the environment where Sidra is being installed / deployed: test, dev, or prod.

The environment parameter cannot have more than 4 characters.

Usage example

    .\sidra.exe profile switch `
        --environment="test"

Next: The Install command


Last update: 2022-05-03
Back to top