locally runbooks

Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

locally runbooks

This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally runbooks --help prints.

For more information see Locally Runbooks.

locally runbooks

Manage Locally Runbooks.

List and deploy the Locally Runbooks shared with your team.

Usage

locally runbooks [flags]
  locally runbooks [command]

Flags

-h, --help[=true|false]   help for runbooks

Subcommands

locally runbooks datascripts

List and execute team data scripts.

Usage

locally runbooks datascripts [flags]
  locally runbooks datascripts [command]

Flags

-h, --help[=true|false]   help for datascripts

Subcommands

locally runbooks datascripts execute

Execute a data script by title.

Execute a data script by title against its target resource. Use 'locally
runbooks datascripts list' to see available titles.

Examples:
locally runbooks datascripts execute seed-orders-db

Usage

locally runbooks datascripts execute <title> [flags]

Flags

-h, --help[=true|false]     help for execute
      --subscription string   Subscription UUID to execute against (defaults to the primary subscription).

locally runbooks datascripts list

List all synced data scripts.

Usage

locally runbooks datascripts list [flags]

Flags

-h, --help[=true|false]   help for list

locally runbooks deploy

Deploy a runbook by name.

Deploys a runbook by name.

The runbook may be an ARM template (deployed at subscription or resource group
scope) or a data script (run against a specific resource). Use 'locally runbooks
list' to see available runbooks and their types.

Examples:
locally runbooks deploy my-first-runbook

Usage

locally runbooks deploy <name> [flags]

Flags

-h, --help[=true|false]   help for deploy

locally runbooks directory

List and provision team directory objects (users, groups, applications, service principals).

Usage

locally runbooks directory [flags]
  locally runbooks directory [command]

Flags

-h, --help[=true|false]   help for directory

Subcommands

locally runbooks directory list

List all synced directory objects.

Usage

locally runbooks directory list [flags]

Flags

-h, --help[=true|false]   help for list

locally runbooks directory provision

Provision all synced directory objects onto the running instance.

Provision every synced directory object (users, groups, applications and
service principals) into the running instance's directory. Objects that already
exist are left untouched, so this is safe to run repeatedly.

Examples:
locally runbooks directory provision

Usage

locally runbooks directory provision [flags]

Flags

-h, --help[=true|false]   help for provision

locally runbooks list

List all synced runbooks.

Usage

locally runbooks list [flags]

Flags

-h, --help[=true|false]   help for list
Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

A local cloud for you and your AI agents.

Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.