Skip to content

babylon

babylon

CLI used for cloud interactions between CosmoTech and multiple cloud environment

The following environment variables are required:

  • BABYLON_SERVICE: Vault Service URI
  • BABYLON_TOKEN: Access Token Vault Service
  • BABYLON_ORG_NAME: Organization Name

Usage:

babylon [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--verbosity, -v text Either CRITICAL, ERROR, WARNING, INFO or DEBUG INFO
--bare, --raw, --tests boolean Enable test mode, this mode changes output formatting. False
-n, --dry-run boolean Will run commands in dry-run mode. False
--version boolean Print version number and return. False
--help boolean Show this message and exit. False

Subcommands

  • abba: Cosmotech ABBA
  • api: Cosmotech API
  • apply: Macro Apply
  • azure: Group allowing communication with Microsoft Azure Cloud
  • destroy: Macro Destroy
  • github: Group allowing communication with Github REST API
  • hvac: Group handling Vault Hashicorp
  • namespace: Babylon namespace
  • powerbi: Group handling communication with PowerBI API
  • webapp: Group handling Cosmo Sample WebApp configuration

abba

Cosmotech ABBA

Usage:

babylon abba [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • check: Check the status of running simulations and save results to disk.
  • run: Run a series of simulations

check

Check the status of running simulations and save results to disk.

Args: input (Any): Table with details of the simulations

Usage:

babylon abba check [OPTIONS] INPUT VAR_TYPES

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

run

Run a series of simulations

Args: input (str): Table with details of the simulations var_types (str): A table declaring the variable types of columns in input

Usage:

babylon abba run [OPTIONS] INPUT VAR_TYPES

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False

api

Cosmotech API

Usage:

babylon api [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • connectors: Connectors - Cosmotech API
  • datasets: Datasets - Cosmotech API
  • organizations: Organizations - Cosmotech API
  • scenarioruns: Scenarioruns - Cosmotech API
  • scenarios: Scenarios - Cosmotech API
  • solutions: Solutions - Cosmotech API
  • workspaces: Workspaces - Cosmotech API

connectors

Connectors - Cosmotech API

Usage:

babylon api connectors [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete: Delete a registered connector
  • get: Get a registered connector details
  • get-all:
create

Register new Connector

Usage:

babylon api connectors create [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
delete

Delete a registered connector

Usage:

babylon api connectors delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--connector-id text N/A None
--help boolean Show this message and exit. False
get

Get a registered connector details

Usage:

babylon api connectors get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--connector-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all connectors details. Can be filtered with jmespath queries: https://jmespath.org/specification.html#grammar

Usage:

babylon api connectors get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False

datasets

Datasets - Cosmotech API

Usage:

babylon api datasets [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • apply: Apply dataset deployment
  • create:
  • delete: Delete a dataset
  • get: Get a dataset
  • get-all:
  • search: Get dataset with the given tag from the organization
  • security: Group allowing dataset security management
  • update:
apply

Apply dataset deployment

Usage:

babylon api datasets apply [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--dataset-id text N/A None
--payload-file Path N/A None
--dataset-zip Path N/A None
--help boolean Show this message and exit. False
create

Register new dataset

Usage:

babylon api datasets create [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--dataset-zip path N/A None
--help boolean Show this message and exit. False
delete

Delete a dataset

Usage:

babylon api datasets delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text N/A None
--dataset-id text N/A None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get a dataset

Usage:

babylon api datasets get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--dataset-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all datasets from the organization

Usage:

babylon api datasets get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False

Get dataset with the given tag from the organization

Usage:

babylon api datasets search [OPTIONS] TAG

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text N/A None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
security

Group allowing dataset security management

Usage:

babylon api datasets security [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • delete:
  • get:
  • get-all:
  • set-default:
  • update:
add

Add dataset users RBAC access

Usage:

babylon api datasets security add [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--dataset-id text N/A None
--role text Role RBAC _required
--email text Email valid _required
--help boolean Show this message and exit. False
delete

Delete dataset users RBAC access

Usage:

babylon api datasets security delete [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--dataset-id text N/A None
--help boolean Show this message and exit. False
get

Get dataset user RBAC access

Usage:

babylon api datasets security get [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get dataset users RBAC access

Usage:

babylon api datasets security get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
set-default

Update dataset default security

Usage:

babylon api datasets security set-default [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--help boolean Show this message and exit. False
update

Update dataset users RBAC access

Usage:

babylon api datasets security update [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--email text Email valid _required
--help boolean Show this message and exit. False
update

Update a registered dataset

Usage:

babylon api datasets update [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--dataset-id text N/A None
--help boolean Show this message and exit. False

organizations

Organizations - Cosmotech API

Usage:

babylon api organizations [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • apply: Apply organization deployment
  • create:
  • delete: Delete an organization
  • get: Get an organization details
  • get-all:
  • security: Group allowing organization security management
  • update:
apply

Apply organization deployment

Usage:

babylon api organizations apply [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--payload-file Path N/A None
--help boolean Show this message and exit. False
create

Register new organization

Usage:

babylon api organizations create [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
delete

Delete an organization

Usage:

babylon api organizations delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--organization-id text N/A None
--help boolean Show this message and exit. False
get

Get an organization details

Usage:

babylon api organizations get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all organization details

Usage:

babylon api organizations get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
security

Group allowing organization security management

Usage:

babylon api organizations security [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • delete:
  • get:
  • get-all:
  • set-default:
  • update:
add

Add organization users RBAC access

Usage:

babylon api organizations security add [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--email text Email valid _required
--help boolean Show this message and exit. False
delete

Delete organization users RBAC access

Usage:

babylon api organizations security delete [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--help boolean Show this message and exit. False
get

Get organization user RBAC access

Usage:

babylon api organizations security get [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get all RBAC access to the organization

Usage:

babylon api organizations security get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
set-default

Set default RBAC access to organization

Usage:

babylon api organizations security set-default [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--organization-id text N/A None
--help boolean Show this message and exit. False
update

Update organization users RBAC access

Usage:

babylon api organizations security update [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--email text Email valid _required
--help boolean Show this message and exit. False
update

Update an organization

Usage:

babylon api organizations update [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--help boolean Show this message and exit. False

scenarioruns

Scenarioruns - Cosmotech API

Usage:

babylon api scenarioruns [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • cumulated-logs:
  • logs:
  • status:
  • stop:
cumulated-logs

Get the cumulated logs for the scenarioRun

Usage:

babylon api scenarioruns cumulated-logs [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--scenariorun-id text N/A None
--help boolean Show this message and exit. False
logs

Get the logs for the scenarioRun

Usage:

babylon api scenarioruns logs [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--scenariorun-id text N/A None
--help boolean Show this message and exit. False
status

Get the status of the scenarioRun

Usage:

babylon api scenarioruns status [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--scenariorun-id text N/A None
--help boolean Show this message and exit. False
stop

Stop the scenarioRun

Usage:

babylon api scenarioruns stop [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--scenariorun-id text N/A None
--help boolean Show this message and exit. False

scenarios

Scenarios - Cosmotech API

Usage:

babylon api scenarios [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • apply: No description was provided with this command.
  • create:
  • delete:
  • get:
  • get-all:
  • run:
  • security: Group allowing scenario security management
  • update:
apply

Usage:

babylon api scenarios apply [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--payload-file Path N/A None
--help boolean Show this message and exit. False
create

Create new scenario

Usage:

babylon api scenarios create [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--help boolean Show this message and exit. False
delete

Delete a scenario

Usage:

babylon api scenarios delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get scenario details

Usage:

babylon api scenarios get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all scenarios in the workspace

Usage:

babylon api scenarios get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
run

Start a scenario run

Usage:

babylon api scenarios run [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
security

Group allowing scenario security management

Usage:

babylon api scenarios security [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • delete:
  • get:
  • get-all:
  • set-default:
  • update:
add

Add scenario users RBAC access

Usage:

babylon api scenarios security add [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--email text Valid email _required
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
delete

Delete scenario RBAC access

Usage:

babylon api scenarios security delete [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
get

Get scenario RBAC access for user

Usage:

babylon api scenarios security get [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all scenario RBAC access

Usage:

babylon api scenarios security get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
set-default

Add scenario users RBAC access

Usage:

babylon api scenarios security set-default [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
update

Update scenario RBAC access for user

Usage:

babylon api scenarios security update [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False
update

Update a scenario

Usage:

babylon api scenarios update [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--scenario-id text N/A None
--help boolean Show this message and exit. False

solutions

Solutions - Cosmotech API

Usage:

babylon api solutions [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • apply:
  • create:
  • delete:
  • get:
  • get-all:
  • handler: Group allowing solution handler management
  • security: Group allowing solutions security management
  • update:
apply

Apply solution deployment

Usage:

babylon api solutions apply [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text N/A None
--solution-id text N/A None
--payload-file Path N/A None
--help boolean Show this message and exit. False
create

Register a new solution

Usage:

babylon api solutions create [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--help boolean Show this message and exit. False
delete

Delete a solution

Usage:

babylon api solutions delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text N/A None
--solution-id text N/A None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get a solution details

Usage:

babylon api solutions get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--solution-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all solutions details

Usage:

babylon api solutions get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
handler

Group allowing solution handler management

Usage:

babylon api solutions handler [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • download: Download a solution handler zip from the solution
  • upload: Upload a solution handler zip to the solution
download

Download a solution handler zip from the solution

Usage:

babylon api solutions handler download [OPTIONS] HANDLER_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text Organization id or referenced in state None
--solution-id text Solution id or referenced in state None
--run-template text The run Template identifier _required
--help boolean Show this message and exit. False
upload

Upload a solution handler zip to the solution

Usage:

babylon api solutions handler upload [OPTIONS] {validator|prerun|engine|postru
                                     n|scenariodata_transform|parameters_handl
                                     er} HANDLER_PATH

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text Organization id or referenced in state None
--solution-id text Solution id or referenced in state None
--run-template text The run Template identifier name example: 'Sensitive analysis' _required
--override boolean Override handler solution False
--help boolean Show this message and exit. False
security

Group allowing solutions security management

Usage:

babylon api solutions security [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • get:
  • get-all:
  • get-users:
  • remove:
  • set-default:
  • update:
add

Add a control access to the Solution

Usage:

babylon api solutions security add [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC viewer
--email text Email valid _required
--help boolean Show this message and exit. False
get

Get a control access for the Solution

Usage:

babylon api solutions security get [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get the Solution security information

Usage:

babylon api solutions security get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-users

Get the Solution security users list

Usage:

babylon api solutions security get-users [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
remove

Remove the specified access from the Solution

Usage:

babylon api solutions security remove [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
set-default

Set the Solution default security

Usage:

babylon api solutions security set-default [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC viewer
--email text Email valid _required
--help boolean Show this message and exit. False
update

Update the specified access to User for a Solution

Usage:

babylon api solutions security update [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--role text Role RBAC _required
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
update

Update a solution

Usage:

babylon api solutions update [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--solution-id text N/A None
--help boolean Show this message and exit. False

workspaces

Workspaces - Cosmotech API

Usage:

babylon api workspaces [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • apply:
  • create:
  • delete:
  • get:
  • get-all:
  • security: Group allowing workspace security management
  • send-key:
  • update:
apply

Apply workspace deployment

Usage:

babylon api workspaces apply [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--payload-file Path N/A None
--help boolean Show this message and exit. False
create

Register a workspace.

Usage:

babylon api workspaces create [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--help boolean Show this message and exit. False
delete

Delete a workspace

Usage:

babylon api workspaces delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--organization-id text N/A None
--workspace-id text N/A None
--help boolean Show this message and exit. False
get

Get a workspace details

Usage:

babylon api workspaces get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--help boolean Show this message and exit. False
get-all

Get all workspaces details

Usage:

babylon api workspaces get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
security

Group allowing workspace security management

Usage:

babylon api workspaces security [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • delete:
  • get:
  • get-all:
  • set-default:
  • update:
add

Add workspace users RBAC access

Usage:

babylon api workspaces security add [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC viewer
--email text Email valid _required
--help boolean Show this message and exit. False
delete

Delete workspace users RBAC access

Usage:

babylon api workspaces security delete [OPTIONS] ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get

Get workspace users RBAC access

Usage:

babylon api workspaces security get [OPTIONS] IDENTITY_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get all RBAC access for the workspace

Usage:

babylon api workspaces security get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text N/A None
--workspace-id text N/A None
--help boolean Show this message and exit. False
set-default

Set default RBAC access to workspace

Usage:

babylon api workspaces security set-default [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC _required
--organization-id text N/A None
--workspace-id text N/A None
--help boolean Show this message and exit. False
update

Update workspace users RBAC access

Usage:

babylon api workspaces security update [OPTIONS] ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--role text Role RBAC viewer
--email text Email valid _required
--help boolean Show this message and exit. False
send-key

Send Event Hub key to given workspace

Usage:

babylon api workspaces send-key [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--organization-id text N/A None
--workspace-id text N/A None
--workspace-key text N/A None
--help boolean Show this message and exit. False
update

Update a workspace

Usage:

babylon api workspaces update [OPTIONS] PAYLOAD_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--organization-id text Organization Id Cosmotech Platform None
--workspace-id text N/A None
--help boolean Show this message and exit. False

apply

Macro Apply

Usage:

babylon apply [OPTIONS] DEPLOY_DIR

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--var-file path Specify the path of your variable file. By default, it takes the variables.yaml file. ['./variables.yaml']
--organization boolean Deploy or update an organization. False
--solution boolean Deploy or update a solution. False
--workspace boolean Deploy or update a workspace. False
--webapp boolean Deploy or update a webapp. False
--dataset boolean Deploy or update a dataset. False
--help boolean Show this message and exit. False

azure

Group allowing communication with Microsoft Azure Cloud

Usage:

babylon azure [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • acr: Azure Container Registry
  • ad: Azure Active Directory
  • adt: Azure Digital Twin
  • adx: Azure Data Explorer
  • appinsight: Azure App Insight
  • arm: Azure Resources Manager
  • func: Azure scenario download function
  • iam: Azure Access Control IAM
  • staticwebapp: Azure Static Webapps
  • storage: Azure Storage Blob
  • token: Azure access token

acr

Azure Container Registry

Requires the program docker to run

Usage:

babylon azure acr [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • delete:
  • list:
  • pull:
  • push:
delete

Delete docker image from selected repository

Usage:

babylon azure acr delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--image text Remote docker image to pull, example hello-world:latest None
--help boolean Show this message and exit. False
list

List all docker images in the specified registry

Usage:

babylon azure acr list [OPTIONS] [SERVER]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
pull

Pulls a docker image from the ACR registry

Usage:

babylon azure acr pull [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--image text Remote docker image to pull, example hello-world:latest None
--help boolean Show this message and exit. False
push

Push a docker image to the ACR registry

Usage:

babylon azure acr push [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--image text Local docker image to push None
--help boolean Show this message and exit. False

Azure Active Directory

Usage:

babylon azure ad [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • app: Azure Active Directory Apps
  • group: Azure Directory Groups
app

Azure Active Directory Apps

Usage:

babylon azure ad app [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get:
  • get-all:
  • get-principal:
  • password: Group interactiving with app registration passwords and secrets
  • update:
create

Register an app in Active Directory https://learn.microsoft.com/en-us/graph/api/application-post-applications

Usage:

babylon azure ad app create [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--file file path file payload None
--help boolean Show this message and exit. False
delete

Delete an app in Active Directory https://learn.microsoft.com/en-us/graph/api/application-delete

Usage:

babylon azure ad app delete [OPTIONS] [OBJECT_ID]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get

Get an app registration in active directory https://learn.microsoft.com/en-us/graph/api/application-get

Usage:

babylon azure ad app get [OPTIONS] OBJECT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get all apps registered in Active Directory https://learn.microsoft.com/en-us/graph/api/application-list

Usage:

babylon azure ad app get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
get-principal

Get an app registration service principal https://learn.microsoft.com/en-us/graph/api/serviceprincipal-get

Usage:

babylon azure ad app get-principal [OPTIONS] OBJECT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
password

Group interactiving with app registration passwords and secrets

Usage:

babylon azure ad app password [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
# create

Register a password or secret to an app registration in active directory https://learn.microsoft.com/en-us/graph/api/application-addpassword

Usage:

babylon azure ad app password create [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--name text Password display name None
--object-id text Object Id Azure App Registration None
--help boolean Show this message and exit. False
# delete

Delete a password for an app registration in active directory https://learn.microsoft.com/en-us/graph/api/application-removepassword

Usage:

babylon azure ad app password delete [OPTIONS] OBJECT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--key text Password Key ID _required
-D boolean Force Delete False
--help boolean Show this message and exit. False
update

Update an app registration in Active Directory https://learn.microsoft.com/en-us/graph/api/application-update

Usage:

babylon azure ad app update [OPTIONS] OBJECT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom app description file yaml _required
--help boolean Show this message and exit. False
group

Azure Directory Groups

Usage:

babylon azure ad group [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get-all:
  • member: Azure Directory Group members
get-all

Get all AD groups from current subscription https://learn.microsoft.com/en-us/graph/api/group-list

Usage:

babylon azure ad group get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
member

Azure Directory Group members

Usage:

babylon azure ad group member [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • get-all:
  • remove:
# add

Add a member in a group in active directory https://learn.microsoft.com/en-us/graph/api/group-post-members

Usage:

babylon azure ad group member add [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--gi, --group-id text Group Id Azure Directory _required
--pi, --principal-id text Principal Id Azure Directory _required
--help boolean Show this message and exit. False
# get-all

Get members of a group in active directory https://learn.microsoft.com/en-us/graph/api/group-post-members

Usage:

babylon azure ad group member get-all [OPTIONS] GROUP_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
# remove

Remove a member from a group in active directory

Usage:

babylon azure ad group member remove [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--gi, --group-id text Group Id Azure Directory _required
--pi, --principal-id text Principal Id Azure Directory _required
-D boolean Force Delete False
--help boolean Show this message and exit. False

adt

Azure Digital Twin

Usage:

babylon azure adt [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • instance: Subgroup dedicate to Azure digital twins instance management
  • model: Subgroup dedicate to Azure digital twins models management
instance

Subgroup dedicate to Azure digital twins instance management

Usage:

babylon azure adt instance [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get:
  • get-all:
create

Create a new ADT instance in current platform resource group

Usage:

babylon azure adt instance create [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
delete

Delete a ADT instance in current platform resource group

Usage:

babylon azure adt instance delete [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get an azure digital twins instance details

Usage:

babylon azure adt instance get [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get all azure digital twins instances

Usage:

babylon azure adt instance get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
model

Subgroup dedicate to Azure digital twins models management

Usage:

babylon azure adt model [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get-all:
  • upload:
get-all

Get all models id from ADT

Usage:

babylon azure adt model get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
upload

Upload MODEL_FILE_FOLDER content to adt

Usage:

babylon azure adt model upload [OPTIONS] MODEL_FILE_FOLDER

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--override boolean Override existing models False
--help boolean Show this message and exit. False

adx

Azure Data Explorer

Usage:

babylon azure adx [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • connections: ADX database DataConnections
  • consumer: Consumers Event Hub
  • database: Azure Data Explorer
  • get-all:
  • permission: ADX permissions
  • script: Azure Data Explorer scripts
connections

ADX database DataConnections

Usage:

babylon azure adx connections [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
create

Create new connection in ADX database

Usage:

babylon azure adx connections create [OPTIONS] CONNECTION_NAME DATABASE_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--mapping text ADX mapping name None
--compression choice (None | GZip) Compression Gzip or None None
--consumer-group text Consumer group name $Default
--table-name text ADX table name None
--data-format choice (JSON | CSV | TXT) Data format _required
--help boolean Show this message and exit. False
consumer

Consumers Event Hub

Usage:

babylon azure adx consumer [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
add

Create new consumer group in EventHub

Usage:

babylon azure adx consumer add [OPTIONS] NAME EVENT_HUB_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
database

Azure Data Explorer

Usage:

babylon azure adx database [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get:
create

Create database in ADX cluster

Usage:

babylon azure adx database create [OPTIONS] [NAME]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--retention integer Retention days 365
--help boolean Show this message and exit. False
delete

Delete database in ADX cluster

Usage:

babylon azure adx database delete [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--current text Delete database adx referenced in configuration False
--help boolean Show this message and exit. False
get

Get database from ADX cluster

Usage:

babylon azure adx database get [OPTIONS] [NAME]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get-all

List scripts on the database

Usage:

babylon azure adx get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
permission

ADX permissions

Usage:

babylon azure adx permission [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • delete:
  • get:
  • get-all:
  • set:
delete

Delete all permission assignments applied to the given principal id

Usage:

babylon azure adx permission delete [OPTIONS] PRINCIPAL_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get permission assignments applied to the given principal id

Usage:

babylon azure adx permission get [OPTIONS] PRINCIPAL_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get-all

Get all permission assignments in the database

Usage:

babylon azure adx permission get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
set

Set permission assignments applied to the given principal id

Usage:

babylon azure adx permission set [OPTIONS] PRINCIPAL_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--role choice (User | Viewer | Admin) Assignment Role to Add _required
--principal-type choice (User | Group | App) Principal type of the given ID _required
--tenant-id text N/A None
--help boolean Show this message and exit. False
script

Azure Data Explorer scripts

Usage:

babylon azure adx script [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get-all:
  • run-folder:
get-all

List scripts on the database

Usage:

babylon azure adx script get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
run-folder

Run all script files (.kql) from SCRIPT_FOLDER

Usage:

babylon azure adx script run-folder [OPTIONS] SCRIPT_FOLDER

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

appinsight

Azure App Insight

Usage:

babylon azure appinsight [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get:
  • get-all:
create

Create a app insight resource in the given resource group https://learn.microsoft.com/en-us/rest/api/application-insights/components/create-or-update

Usage:

babylon azure appinsight create [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom appinsight description file yaml None
--help boolean Show this message and exit. False
delete

Delete app insight data from a name https://learn.microsoft.com/en-us/rest/api/application-insights/components/delete

Usage:

babylon azure appinsight delete [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get app insight data from a name https://learn.microsoft.com/en-us/rest/api/application-insights/components/get

Usage:

babylon azure appinsight get [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get-all

get all app insight data from a resource group https://learn.microsoft.com/en-us/rest/api/application-insights/components/list-by-resource-group

Usage:

babylon azure appinsight get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False

arm

Azure Resources Manager

Usage:

babylon azure arm [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get-all:
  • run:
get-all

Get all the deployments for a resource group

Usage:

babylon azure arm get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
run

Apply a resource deployment config via arm template file in working directory

Usage:

babylon azure arm run [OPTIONS] DEPLOYMENT_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--complete-mode boolean Mode deployment False
--help boolean Show this message and exit. False

func

Azure scenario download function

Usage:

babylon azure func [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • delete:
  • deploy:
delete

Deploy a new function Scenario Donwload

Usage:

babylon azure func delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
deploy

Deploy a new function Scenario Donwload

Usage:

babylon azure func deploy [OPTIONS] DEPLOYMENT_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--complete-mode boolean Flag to run on complete mode False
--help boolean Show this message and exit. False

iam

Azure Access Control IAM

Usage:

babylon azure iam [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • set:
set

Assign a new role in resource given

Usage:

babylon azure iam set [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--resource-type text Ressource Type Id Azure None
--resource-name text Ressource Name Azure None
--principal-type choice (User | Group | ServicePrincipal | ForeignGroup | Device) Principal Type Azure ServicePrincipal
--principal-id text Principal Id Ressource _required
--role-id text Role Id Ressource _required
--help boolean Show this message and exit. False

staticwebapp

Azure Static Webapps

Usage:

babylon azure staticwebapp [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • app-settings: Group initialized from a template
  • create:
  • custom-domain: Azure Static Webapps custom domains
  • delete:
  • get:
  • get-all:
  • update:
app-settings

Group initialized from a template

Usage:

babylon azure staticwebapp app-settings [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get:
  • update:
get

Get static webapp app settings for the given static web app https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/list-static-site-app-settings

Usage:

babylon azure staticwebapp app-settings get [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
update

Update static webapp app settings in the given webapp https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/create-or-update-static-site-app-settings

Usage:

babylon azure staticwebapp app-settings update [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom settings description file yaml None
--help boolean Show this message and exit. False
create

Create a static webapp data in the given resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/create-or-update-static-site

Usage:

babylon azure staticwebapp create [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom staticwebapp description file yaml None
--help boolean Show this message and exit. False
custom-domain

Azure Static Webapps custom domains

Usage:

babylon azure staticwebapp custom-domain [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get:
  • get-all:
  • update:
create

Create a static webapp custom domain in the given resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/create-or-update-static-site-custom-domain

Usage:

babylon azure staticwebapp custom-domain create [OPTIONS] WEBAPP_NAME
                                                DOMAIN_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom custom-domain description file yaml None
--help boolean Show this message and exit. False
delete

Delete static webapp data from a resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/delete-static-site-custom-domain

Usage:

babylon azure staticwebapp custom-domain delete [OPTIONS] WEBAPP_NAME
                                                DOMAIN_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get a static webapp custom domain for the given static web app https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/get-static-site-custom-domain

Usage:

babylon azure staticwebapp custom-domain get [OPTIONS] WEBAPP_NAME DOMAIN_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get-all

Get static webapp custom domains for the given static web app https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/list-static-site-custom-domains

Usage:

babylon azure staticwebapp custom-domain get-all [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
update

Update a static webapp custom domain in the given resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/create-or-update-static-site

Usage:

babylon azure staticwebapp custom-domain update [OPTIONS] WEBAPP_NAME
                                                DOMAIN_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom custom-domain description file yaml None
--help boolean Show this message and exit. False
delete

Delete static webapp data from a resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/delete-static-site

Usage:

babylon azure staticwebapp delete [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get static webapp data from a resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/get-static-site

Usage:

babylon azure staticwebapp get [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get-all

Get all static webapps within the subscription https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/list

Usage:

babylon azure staticwebapp get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
update

Update a static webapp data in the given resource group https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/create-or-update-static-site

Usage:

babylon azure staticwebapp update [OPTIONS] WEBAPP_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file file Your custom staticwebapp description file yaml None
--help boolean Show this message and exit. False

storage

Azure Storage Blob

Usage:

babylon azure storage [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • container: Azure Storage Blob containers
  • policy: Azure Storage Blob Default Policy
container

Azure Storage Blob containers

Usage:

babylon azure storage container [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get-all:
  • upload:
create

Creates a blob storage container

Usage:

babylon azure storage container create [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
delete

Delete a blob storage container

Usage:

babylon azure storage container delete [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get-all

Get all blob storage containers

Usage:

babylon azure storage container get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
upload

Upload csv files to blob storage container

Usage:

babylon azure storage container upload [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--folder path Folder with cvs files to upload _required
--organization-id text Organization id None
--workspace-id text Workspace id None
--dataset-id text Dataset id None
--help boolean Show this message and exit. False
policy

Azure Storage Blob Default Policy

Usage:

babylon azure storage policy [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
create

Create or update default policy storage account

Usage:

babylon azure storage policy create [OPTIONS] ACCOUNT_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--days integer Days after last modification 365
--help boolean Show this message and exit. False
delete

Delete default policy storage account

Usage:

babylon azure storage policy delete [OPTIONS] ACCOUNT_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

token

Azure access token

Usage:

babylon azure token [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get:
  • store:
get

Get un acces token using a secret key

Usage:

babylon azure token get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--scope choice (default | powerbi | graph) API Scope _required
--help boolean Show this message and exit. False
store

Store a refresh token using a secret key

Usage:

babylon azure token store [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--scope choice (default | powerbi | graph) API Scope _required
--help boolean Show this message and exit. False

destroy

Macro Destroy

Usage:

babylon destroy [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--state-to-destroy Path N/A None
--help boolean Show this message and exit. False

github

Group allowing communication with Github REST API

Usage:

babylon github [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • runs: github workflows runs

runs

github workflows runs

Usage:

babylon github runs [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • cancel:
  • get:
cancel

Cancel a github workflow from run url

Usage:

babylon github runs cancel [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
get

Get github workflow

Usage:

babylon github runs get [OPTIONS] WORKFLOW_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

hvac

Group handling Vault Hashicorp

Usage:

babylon hvac [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • login:
  • set: Group handling Vault Hashicorp

login

Login vault hashicorp

Usage:

babylon hvac login [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

set

Group handling Vault Hashicorp

Usage:

babylon hvac set [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • babylon:
  • global:
  • platform:
  • project:
  • user:
babylon

Set a secret in babylon scope

Usage:

babylon hvac set babylon [OPTIONS] NAME VALUE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
global

Set a secret in global scope

Usage:

babylon hvac set global [OPTIONS] RESOURCE NAME VALUE

Options:

Name Type Description Default
--help boolean Show this message and exit. False
platform

Set a secret in platform scope

Usage:

babylon hvac set platform [OPTIONS] RESOURCE NAME VALUE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
project

Set a secret in project scope

Usage:

babylon hvac set project [OPTIONS] {azf|powerbi|eventhub|func} VALUE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False
user

Set a secret in user scope

Usage:

babylon hvac set user [OPTIONS] EMAIL RESOURCE NAME VALUE

Options:

Name Type Description Default
--help boolean Show this message and exit. False

namespace

Babylon namespace

Usage:

babylon namespace [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • use: No description was provided with this command.

use

Usage:

babylon namespace use [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name _required
-p, --platform text Platform Name _required
-s, --state-id text State Id _required
--help boolean Show this message and exit. False

powerbi

Group handling communication with PowerBI API

Optional:

Environment variable to get access token with a user email

  • BABYLON_ENCODING_KEY

Usage:

babylon powerbi [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • dataset: Command group handling PowerBI datasets
  • report: Command group handling PowerBI reports
  • resume:
  • suspend:
  • workspace: Command group handling PowerBI workspaces

dataset

Command group handling PowerBI datasets

Usage:

babylon powerbi dataset [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • delete:
  • get:
  • get-all: Get a list of all powerbi datasets in the current workspace
  • parameters: Command group handling PowerBI dataset parameters
  • take-over:
  • update-credentials:
  • users: Command group handling PowerBI dataset users
delete

Delete a powerbi dataset in the current workspace

Usage:

babylon powerbi dataset delete [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get

Get a powerbi dataset in the current workspace

Usage:

babylon powerbi dataset get [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
-o, --output text File to which content should be outputted None
--help boolean Show this message and exit. False
get-all

Get a list of all powerbi datasets in the current workspace

Usage:

babylon powerbi dataset get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--workspace-id text PowerBI workspace ID None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
parameters

Command group handling PowerBI dataset parameters

Usage:

babylon powerbi dataset parameters [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • get:
  • update:
get

Get parameters of a given dataset

Usage:

babylon powerbi dataset parameters get [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--workspace-id text PowerBI workspace ID None
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
update

Update parameters of a given dataset

Usage:

babylon powerbi dataset parameters update [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--parameter Report parameter _required
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
take-over

Take ownership of a powerbi dataset in the current workspace

Usage:

babylon powerbi dataset take-over [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
update-credentials

Update azure credentials of a given datasource

Usage:

babylon powerbi dataset update-credentials [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
users

Command group handling PowerBI dataset users

Usage:

babylon powerbi dataset users [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
add

Add user to dataset

Usage:

babylon powerbi dataset users add [OPTIONS] DATASET_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
--email text Email valid None
--help boolean Show this message and exit. False

report

Command group handling PowerBI reports

Usage:

babylon powerbi report [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • delete:
  • download:
  • download-all:
  • get:
  • get-all:
  • pages:
  • upload:
delete

Delete a powerbi report in the current workspace

Usage:

babylon powerbi report delete [OPTIONS] REPORT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
-D boolean Force Delete False
--help boolean Show this message and exit. False
download

Download a report in the current workspace

Usage:

babylon powerbi report download [OPTIONS] REPORT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
-o, --output path Output folder powerbi
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
download-all

Download all reports from a workspace

Usage:

babylon powerbi report download-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
-o, --output path Output folder powerbi
--help boolean Show this message and exit. False
get

Get info from a powerbi report of a workspace

Usage:

babylon powerbi report get [OPTIONS] REPORT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
get-all

Get info from every powerbi reports of a workspace

Usage:

babylon powerbi report get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--workspace-id text PowerBI workspace ID None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
pages

Get info from a powerbi report of a workspace

Usage:

babylon powerbi report pages [OPTIONS] REPORT_ID

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--report-type choice (scenario_view | dashboard_view) Report Type None
--workspace-id text PowerBI workspace ID None
--help boolean Show this message and exit. False
upload

Publish the given pbxi file to the PowerBI workspace

Usage:

babylon powerbi report upload [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--file file Your report file _required
--workspace-id text PowerBI workspace ID None
--override boolean override reports in case of name conflict False
--name text Report name None
--type choice (scenario_view | dashboard_view) Report type _required
--help boolean Show this message and exit. False

resume

Resume a PowerBI Service

Usage:

babylon powerbi resume [OPTIONS] POWERBI_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

suspend

Suspend a PowerBI Service

Usage:

babylon powerbi suspend [OPTIONS] POWERBI_NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

workspace

Command group handling PowerBI workspaces

Usage:

babylon powerbi workspace [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • create:
  • delete:
  • get:
  • get-all:
  • user: Subgroup allowing control of the users and their access to the workspace
create

Create workspace named WORKSPACE_NAME into Power Bi App

Usage:

babylon powerbi workspace create [OPTIONS] NAME

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--help boolean Show this message and exit. False
delete

Delete workspace from Power Bi APP

Usage:

babylon powerbi workspace delete [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
-D boolean Force Delete False
--workspace-id text Workspace Id PowerBI None
--help boolean Show this message and exit. False
get

Get a specific workspace information

Usage:

babylon powerbi workspace get [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text PowerBI workspace ID None
--name text PowerBI workspace name None
--help boolean Show this message and exit. False
get-all

Get all workspace information for the given account

Usage:

babylon powerbi workspace get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
user

Subgroup allowing control of the users and their access to the workspace

Usage:

babylon powerbi workspace user [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • add:
  • delete:
  • get-all:
  • update:
add

Adds a new user to the power bi workspace using the following information:

Usage:

babylon powerbi workspace user add [OPTIONS] IDENTIFIER {App|Group|User|None}
                                   {Admin|Contributor|Member|Viewer|None}

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text Workspace Id PowerBI None
--help boolean Show this message and exit. False
delete

Delete IDENTIFIER from the power bi workspace

Usage:

babylon powerbi workspace user delete [OPTIONS] EMAIL

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text Workspace Id PowerBI None
-D boolean Force Delete False
--help boolean Show this message and exit. False
get-all

List all exisiting users in the power bi workspace

Usage:

babylon powerbi workspace user get-all [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--email text User email None
--workspace-id text Workspace Id PowerBI None
--filter text Filter response with a jmespath query None
--help boolean Show this message and exit. False
update

Updates an existing user in the power bi workspace

Usage:

babylon powerbi workspace user update [OPTIONS] EMAIL {App|Group|User|None}
                                      {Admin|Contributor|Member|Viewer|None}

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--email text User email None
--workspace-id text Workspace Id PowerBI None
--help boolean Show this message and exit. False

webapp

Group handling Cosmo Sample WebApp configuration

Usage:

babylon webapp [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • download:
  • export-config:
  • update-workflow:
  • upload-file:
  • upload-many:

download

Download the github repository locally

Usage:

babylon webapp download [OPTIONS] DESTINATION_FOLDER

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

export-config

Export webapp configuration in a json file

Usage:

babylon webapp export-config [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
-o, --output text File to which content should be outputted None
--file file Your custom config description file yaml None
--help boolean Show this message and exit. False

update-workflow

Update a github workflow file to read environment from a config.json file during deployment

Usage:

babylon webapp update-workflow [OPTIONS] WORKFLOW_FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

upload-file

Upload a file to the webapp github repository

Usage:

babylon webapp upload-file [OPTIONS] FILE

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--help boolean Show this message and exit. False

upload-many

Upload files to the webapp github repository

Usage:

babylon webapp upload-many [OPTIONS]

Options:

Name Type Description Default
-c, --context text Context Name without any special character None
-p, --platform text Platform Id without any special character None
-s, --state-id text State Id None
--file Path Add a combination that will be sent as parameter to all your datasets None
--help boolean Show this message and exit. False