Sign in during Public Preview to get the Team plan free, plus an early-adopter discount when we launch. Sign in
Every command the locally CLI ships, in one place. This page is generated from the CLI's own help output, so it matches what locally <command> --help prints. Flags that apply to locally run itself must come before the command being run.
| Command | Does |
|---|---|
| locally account | Show the signed-in account. |
| locally analytics | Show the analytics this installation has collected. |
| locally audit | View audit events. |
| locally build | Launch the Locally environment on this machine. |
| locally certificate | Manage the TLS certificate Locally uses. |
| locally chaos | Simulate transient failures in Locally. |
| locally ci | Launch the Locally environment in CI mode. |
| locally completion | Generate the autocompletion script for the specified shell |
| locally configure | Configure this machine for Locally, one change at a time. |
| locally connect | Connect to a Virtual Machine or a Virtual Machine Scale Set instance. |
| locally dashboard | Open the Locally Dashboard in your browser. |
| locally deploy | Deploy an ARM or Bicep template to Locally. |
| locally docs | Open the Locally documentation in your browser. |
| locally eventhub | Interact with Event Hubs Namespaces within Locally. |
| locally function | Interact with Function Apps within Locally. |
| locally iothub | Interact with IoT Hubs within Locally. |
| locally login | Sign this installation in to a Locally Account. |
| locally logout | Sign out and deregister this installation. |
| locally logs | View HTTP request/response logs. |
| locally mcp | Launch the Locally MCP server. |
| locally mysql | Interact with MySQL Flexible Servers within Locally. |
| locally plugin | Manage Resource Provider plugins. |
| locally postgres | Interact with PostgreSQL Flexible Servers within Locally. |
| locally redis | Interact with Redis Caches within Locally. |
| locally refresh | Refresh this installation's Locally licence. |
| locally refresh-reference-data | Refresh Locally's reference-data override files from real Azure via the Azure CLI. |
| locally regions | List Azure regions known to Locally. |
| locally run | Run a tool against Locally using Automatic Configuration (az, terraform, pulumi, curl, ...). |
| locally runbooks | Manage Locally Runbooks. |
| locally servicebus | Interact with Service Bus Namespaces within Locally. |
| locally setup | Set up this machine to run Locally. |
| locally storage | Interact with Storage Accounts within Locally. |
| locally subscriptions | Manage Locally subscriptions. |
| locally update | Update this copy of Locally to the latest version. |
| locally validate | Check that Locally is fully configured and ready to run. |
| locally version | Print the version of Locally in this binary. |
Show the signed-in account.
Show the signed-in user and organisation. Run 'locally account sync' to refresh from the Locally API.
Usage
locally account [flags] locally account [command]
Subcommands
Sign this installation in to a Locally Account.
Connects an installation that was set up without an account to a Locally Account. Signing in lifts the plugin allowance and gives you a longer session. To set up a new installation, use 'locally setup' instead.
Usage
locally account login [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --skip-browser | Print the sign-in URL instead of opening a browser. |
Sign out and deregister this installation.
Signs you out of your Locally Account on this machine and removes this installation's certificate. Locally will not run again until you re-run 'locally setup'.
Usage
locally account logout [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --force | Skip the confirmation prompt. |
Refresh the signed-in account from the Locally API.
Fetches your profile, organisation, teams, and team policies, runbooks and data scripts, and updates the local cache.
Usage
locally account sync [flags]
Show the analytics this installation has collected.
Shows whether analytics submission is enabled, your installation ID, uptime, version, and the resource types and API versions you've provisioned. Analytics are held in memory and only sent if you opted in during 'locally setup'. Submitted analytics also feed Locally Directory, which shows your team who knows which resource types.
Usage
locally analytics [flags]
View audit events.
View audit events from all services, with interactive filtering.
Usage
locally audit [flags] locally audit [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --json | Output audit events as JSON |
Subcommands
Clear all audit events.
Usage
locally audit clear [flags]
Launch the Locally environment on this machine.
Launches the Locally environment on this machine, which includes: * The Dashboard * The Control Plane API * The Authorization API * The Directory API The Dashboard opens in your browser. Use 'locally run' to point az, Terraform, Pulumi and the Azure SDKs at it. In CI, use 'locally ci' instead. Before launching, this checks that *.locally resolves and that any installed container runtime can reach Locally, and refuses to start if not. Skip a check with its --skip-*-check flag or the matching LOCALLY_SKIP_*_CHECK=1 environment variable. Locally listens on 127.0.0.1, except for these, which listen on every interface so containers can reach them: the *.locally DNS server (port 5673), the identity endpoint that containers fetch managed-identity tokens from, and the authenticated entry port in front of each database engine (Postgres, MySQL, Redis). If you run a host firewall, expect these ports to be open. On Docker Desktop, Locally also starts a DNS forwarder container so the containers it launches can resolve *.locally. See 'locally configure docker', or set LOCALLY_CONTAINER_DNS=none to opt out.
Usage
locally build [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --skip-browser | Skip opening the dashboard in a browser on launch | |
| --skip-certificate-check | Start even if the TLS certificate does not cover every name Locally serves. Also LOCALLY_SKIP_CERTIFICATE_CHECK=1. | |
| --skip-dns-check | Start even if *.locally does not resolve. Also LOCALLY_SKIP_DNS_CHECK=1. | |
| --skip-docker-check | Start even if Docker cannot reach Locally. Also LOCALLY_SKIP_DOCKER_CHECK=1. | |
| --skip-podman-check | Start even if Podman cannot reach Locally. Also LOCALLY_SKIP_PODMAN_CHECK=1. |
Manage the TLS certificate Locally uses.
Usage
locally certificate [flags] locally certificate [command]
Subcommands
Generate a TLS certificate covering every domain Locally needs.
Generates a TLS certificate covering every hostname and IP Locally serves. Uses mkcert (https://github.com/FiloSottile/mkcert) if it's on your $PATH, otherwise Locally's built-in certificate authority. Pass --source to choose. Asks before overwriting existing files in --out-dir; without a terminal, pass --force. Works before Locally is configured. Examples: # Generate a certificate, preferring mkcert and falling back to the built-in CA locally certificate generate # Use the built-in CA even if mkcert is installed locally certificate generate --source builtin # Write into another directory, leaving this installation's configuration alone locally certificate generate --out-dir ./certs --no-update-config
Usage
locally certificate generate [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --force | Overwrite an existing certificate, key or CA already in --out-dir without prompting. | |
| --no-update-config | Leave this installation's configuration untouched, without prompting. | |
| --out-dir | string | Directory to write the certificate, key and CA into (created if missing). (default "~/.config/locally") |
| --source | string | Which generator to use: auto (prefer mkcert, fall back to the built-in CA), mkcert (require mkcert) or builtin (force the built-in CA). (default "auto") |
| --update-config | Point this installation's configuration at the newly generated certificate, without prompting. |
Print a ready-to-run mkcert command covering every domain Locally needs.
Prints an mkcert command that generates a TLS certificate covering every hostname and IP Locally serves. The output is unquoted so it can be run with `$(locally certificate get-mkcert-command)`. To run mkcert without going through the shell, use `locally certificate generate`. Works before Locally is configured. Examples: # Print the command and run it interactively locally certificate get-mkcert-command # Run it (bash / zsh) $(locally certificate get-mkcert-command) # Override the output file paths locally certificate get-mkcert-command --out-dir ./certs --cert-file dev.pem --key-file dev.key
Usage
locally certificate get-mkcert-command [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --cert-file | string | Filename for the generated certificate (passed to mkcert -cert-file). (default "local-cert.pem") |
| --key-file | string | Filename for the generated private key (passed to mkcert -key-file). (default "local-cert.key") |
| --out-dir | string | Directory to prepend to --cert-file and --key-file. Defaults to the current working directory. |
Print the domains Locally's TLS certificate must cover, comma-separated.
Prints the domains Locally's TLS certificate must cover, for CI jobs that generate a certificate before starting Locally. Works before Locally is configured. Examples: # Capture the list into an env var for later steps echo "DOMAINS=$(locally certificate get-required-domains)" >> $GITHUB_ENV # Pass directly to a cert tool (converting commas to spaces) mkcert $(locally certificate get-required-domains | tr ',' ' ')
Usage
locally certificate get-required-domains [flags]
Simulate transient failures in Locally.
Simulate transient failures in Locally's control plane (ARM), directory (Microsoft Graph) or a data-plane service. Each fault has a rate, plus optional rules that override it for one location or plugin. Requests that match no rule use the fault's rate, so "everywhere except one place" is a rate of 100 plus a rule at 0. 'locally chaos enable' switches the control plane and data-plane services on or off; 'locally chaos directory enable' does the same for the directory. Setting a fault switches its surface on. Examples: # Inject 500s on 10% of ARM requests locally chaos control-plane 500 --percentage 10 # An outage in one location, for one plugin only locally chaos control-plane outage --percentage 100 --location london --plugin Microsoft.Storage # Throttle everywhere EXCEPT one location locally chaos storage 429 --percentage 100 locally chaos storage 429 --percentage 0 --location london # Put one rule back, then everything back locally chaos storage 429 reset --location london locally chaos storage reset # See what is configured locally chaos show locally chaos control-plane show
Usage
locally chaos [flags] locally chaos [command]
Subcommands
Simulate ARM (control plane) failure modes.
Simulate ARM (control plane) failure modes. Without --plugin / --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos control-plane <fault> --percentage N locally chaos control-plane <fault> reset locally chaos control-plane show locally chaos control-plane reset
Usage
locally chaos control-plane [flags] locally chaos control-plane [command]
Subcommands
Set the 403 fault's rate on ARM (control plane).
Set the 403 fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane 403 --percentage 25 locally chaos control-plane 403 --percentage 100 --location london locally chaos control-plane 403 reset --location london locally chaos control-plane 403 --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane 403 [flags] locally chaos control-plane 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on ARM (control plane).
Set the 429 fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane 429 --percentage 25 locally chaos control-plane 429 --percentage 100 --location london locally chaos control-plane 429 reset --location london locally chaos control-plane 429 --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane 429 [flags] locally chaos control-plane 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on ARM (control plane).
Set the 500 fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane 500 --percentage 25 locally chaos control-plane 500 --percentage 100 --location london locally chaos control-plane 500 reset --location london locally chaos control-plane 500 --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane 500 [flags] locally chaos control-plane 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on ARM (control plane).
Set the drop-connection fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane drop-connection --percentage 25 locally chaos control-plane drop-connection --percentage 100 --location london locally chaos control-plane drop-connection reset --location london locally chaos control-plane drop-connection --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane drop-connection [flags] locally chaos control-plane drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on ARM (control plane).
Set the latency fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos control-plane latency --percentage 25 --seconds 30 locally chaos control-plane latency --percentage 100 --seconds 30 --location london locally chaos control-plane latency reset --location london locally chaos control-plane latency --percentage 100 --seconds 30 --plugin Microsoft.Compute
Usage
locally chaos control-plane latency [flags] locally chaos control-plane latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the lro-delay fault's rate on ARM (control plane).
Set the lro-delay fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos control-plane lro-delay --percentage 25 --seconds 30 locally chaos control-plane lro-delay --percentage 100 --seconds 30 --location london locally chaos control-plane lro-delay reset --location london locally chaos control-plane lro-delay --percentage 100 --seconds 30 --plugin Microsoft.Compute
Usage
locally chaos control-plane lro-delay [flags] locally chaos control-plane lro-delay [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one lro-delay rule, or put the whole fault back to zero.
Reset the lro-delay fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane lro-delay reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the lro-failure fault's rate on ARM (control plane).
Set the lro-failure fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane lro-failure --percentage 25 locally chaos control-plane lro-failure --percentage 100 --location london locally chaos control-plane lro-failure reset --location london locally chaos control-plane lro-failure --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane lro-failure [flags] locally chaos control-plane lro-failure [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one lro-failure rule, or put the whole fault back to zero.
Reset the lro-failure fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane lro-failure reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the out-of-capacity fault's rate on ARM (control plane).
Set the out-of-capacity fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane out-of-capacity --percentage 25 locally chaos control-plane out-of-capacity --percentage 100 --location london locally chaos control-plane out-of-capacity reset --location london locally chaos control-plane out-of-capacity --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane out-of-capacity [flags] locally chaos control-plane out-of-capacity [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one out-of-capacity rule, or put the whole fault back to zero.
Reset the out-of-capacity fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane out-of-capacity reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on ARM (control plane).
Set the outage fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane outage --percentage 25 locally chaos control-plane outage --percentage 100 --location london locally chaos control-plane outage reset --location london locally chaos control-plane outage --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane outage [flags] locally chaos control-plane outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the quota-exceeded fault's rate on ARM (control plane).
Set the quota-exceeded fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane quota-exceeded --percentage 25 locally chaos control-plane quota-exceeded --percentage 100 --location london locally chaos control-plane quota-exceeded reset --location london locally chaos control-plane quota-exceeded --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane quota-exceeded [flags] locally chaos control-plane quota-exceeded [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one quota-exceeded rule, or put the whole fault back to zero.
Reset the quota-exceeded fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane quota-exceeded reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the recase-names fault's rate on ARM (control plane).
Set the recase-names fault's rate on ARM (control plane). Without scope flags this sets the fault's rate. With --plugin / --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos control-plane recase-names --percentage 25 locally chaos control-plane recase-names --percentage 100 --location london locally chaos control-plane recase-names reset --location london locally chaos control-plane recase-names --percentage 100 --plugin Microsoft.Compute
Usage
locally chaos control-plane recase-names [flags] locally chaos control-plane recase-names [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one recase-names rule, or put the whole fault back to zero.
Reset the recase-names fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos control-plane recase-names reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --plugin | string | Scope this rule to one ARM provider, e.g. Microsoft.Compute |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every ARM (control plane) fault and drop every rule.
Zero every ARM (control plane) fault and drop every rule. Examples: locally chaos control-plane reset
Usage
locally chaos control-plane reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current ARM (control plane) chaos configuration.
Print the current ARM (control plane) chaos configuration. Examples: locally chaos control-plane show
Usage
locally chaos control-plane show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Cosmos DB (data plane) failure modes.
Simulate Cosmos DB (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos cosmos <fault> --percentage N locally chaos cosmos <fault> reset locally chaos cosmos show locally chaos cosmos reset
Usage
locally chaos cosmos [flags] locally chaos cosmos [command]
Subcommands
Set the 403 fault's rate on Cosmos DB (data plane).
Set the 403 fault's rate on Cosmos DB (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos cosmos 403 --percentage 25 locally chaos cosmos 403 --percentage 100 --location london locally chaos cosmos 403 reset --location london
Usage
locally chaos cosmos 403 [flags] locally chaos cosmos 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos cosmos 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Cosmos DB (data plane).
Set the 429 fault's rate on Cosmos DB (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos cosmos 429 --percentage 25 locally chaos cosmos 429 --percentage 100 --location london locally chaos cosmos 429 reset --location london
Usage
locally chaos cosmos 429 [flags] locally chaos cosmos 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos cosmos 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Cosmos DB (data plane).
Set the 500 fault's rate on Cosmos DB (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos cosmos 500 --percentage 25 locally chaos cosmos 500 --percentage 100 --location london locally chaos cosmos 500 reset --location london
Usage
locally chaos cosmos 500 [flags] locally chaos cosmos 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos cosmos 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Cosmos DB (data plane).
Set the drop-connection fault's rate on Cosmos DB (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos cosmos drop-connection --percentage 25 locally chaos cosmos drop-connection --percentage 100 --location london locally chaos cosmos drop-connection reset --location london
Usage
locally chaos cosmos drop-connection [flags] locally chaos cosmos drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos cosmos drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Cosmos DB (data plane).
Set the latency fault's rate on Cosmos DB (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos cosmos latency --percentage 25 --seconds 30 locally chaos cosmos latency --percentage 100 --seconds 30 --location london locally chaos cosmos latency reset --location london
Usage
locally chaos cosmos latency [flags] locally chaos cosmos latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos cosmos latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Cosmos DB (data plane).
Set the outage fault's rate on Cosmos DB (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos cosmos outage --percentage 25 locally chaos cosmos outage --percentage 100 --location london locally chaos cosmos outage reset --location london
Usage
locally chaos cosmos outage [flags] locally chaos cosmos outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos cosmos outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Cosmos DB (data plane) fault and drop every rule.
Zero every Cosmos DB (data plane) fault and drop every rule. Examples: locally chaos cosmos reset
Usage
locally chaos cosmos reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Cosmos DB (data plane) chaos configuration.
Print the current Cosmos DB (data plane) chaos configuration. Examples: locally chaos cosmos show
Usage
locally chaos cosmos show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Microsoft Graph (directory) failure modes.
Simulate Microsoft Graph (directory) failure modes. Without no scope flags (this surface has no rules), a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos directory <fault> --percentage N locally chaos directory <fault> reset locally chaos directory show locally chaos directory reset
Usage
locally chaos directory [flags] locally chaos directory [command]
Subcommands
Set the 403 fault's rate on Microsoft Graph (directory).
Set the 403 fault's rate on Microsoft Graph (directory). Graph is regionless and has no plugins, so this fault is a single rate. Examples: locally chaos directory 403 --percentage 25
Usage
locally chaos directory 403 [flags] locally chaos directory 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --percentage | int | How often this fault fires, 0-100 (required) |
| --tenant | string | Tenant UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos directory 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Set the 429 fault's rate on Microsoft Graph (directory).
Set the 429 fault's rate on Microsoft Graph (directory). Graph is regionless and has no plugins, so this fault is a single rate. Examples: locally chaos directory 429 --percentage 25
Usage
locally chaos directory 429 [flags] locally chaos directory 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --percentage | int | How often this fault fires, 0-100 (required) |
| --tenant | string | Tenant UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos directory 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Set the 500 fault's rate on Microsoft Graph (directory).
Set the 500 fault's rate on Microsoft Graph (directory). Graph is regionless and has no plugins, so this fault is a single rate. Examples: locally chaos directory 500 --percentage 25
Usage
locally chaos directory 500 [flags] locally chaos directory 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --percentage | int | How often this fault fires, 0-100 (required) |
| --tenant | string | Tenant UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos directory 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Turn chaos OFF for the directory.
Turn chaos OFF for the directory. Disabling keeps every fault's configuration, so a later enable restores it.
Usage
locally chaos directory disable [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Microsoft Graph (directory).
Set the drop-connection fault's rate on Microsoft Graph (directory). Graph is regionless and has no plugins, so this fault is a single rate. Examples: locally chaos directory drop-connection --percentage 25
Usage
locally chaos directory drop-connection [flags] locally chaos directory drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --percentage | int | How often this fault fires, 0-100 (required) |
| --tenant | string | Tenant UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos directory drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Turn chaos ON for the directory.
Turn chaos ON for the directory. Disabling keeps every fault's configuration, so a later enable restores it.
Usage
locally chaos directory enable [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Set the eventual-consistency fault's rate on Microsoft Graph (directory).
Set the eventual-consistency fault's rate on Microsoft Graph (directory). Graph is regionless and has no plugins, so this fault is a single rate. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos directory eventual-consistency --percentage 25 --seconds 30
Usage
locally chaos directory eventual-consistency [flags] locally chaos directory eventual-consistency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --tenant | string | Tenant UUID (defaults to the configured default) |
Subcommands
Remove one eventual-consistency rule, or put the whole fault back to zero.
Reset the eventual-consistency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos directory eventual-consistency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Set the latency fault's rate on Microsoft Graph (directory).
Set the latency fault's rate on Microsoft Graph (directory). Graph is regionless and has no plugins, so this fault is a single rate. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos directory latency --percentage 25 --seconds 30
Usage
locally chaos directory latency [flags] locally chaos directory latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --tenant | string | Tenant UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos directory latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Zero every Microsoft Graph (directory) fault and drop every rule.
Zero every Microsoft Graph (directory) fault and drop every rule. Examples: locally chaos directory reset
Usage
locally chaos directory reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Print the current Microsoft Graph (directory) chaos configuration.
Print the current Microsoft Graph (directory) chaos configuration. Examples: locally chaos directory show
Usage
locally chaos directory show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --tenant | string | Tenant UUID (defaults to the configured default) |
Turn chaos OFF for the control plane and data-plane services.
Turn chaos OFF for the control plane and data-plane services. Disabling keeps every fault's configuration, so a later enable restores it.
Usage
locally chaos disable [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Turn chaos ON for the control plane and data-plane services.
Turn chaos ON for the control plane and data-plane services. Disabling keeps every fault's configuration, so a later enable restores it.
Usage
locally chaos enable [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Event Grid (data plane) failure modes.
Simulate Event Grid (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos eventgrid <fault> --percentage N locally chaos eventgrid <fault> reset locally chaos eventgrid show locally chaos eventgrid reset
Usage
locally chaos eventgrid [flags] locally chaos eventgrid [command]
Subcommands
Set the 403 fault's rate on Event Grid (data plane).
Set the 403 fault's rate on Event Grid (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventgrid 403 --percentage 25 locally chaos eventgrid 403 --percentage 100 --location london locally chaos eventgrid 403 reset --location london
Usage
locally chaos eventgrid 403 [flags] locally chaos eventgrid 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventgrid 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Event Grid (data plane).
Set the 429 fault's rate on Event Grid (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventgrid 429 --percentage 25 locally chaos eventgrid 429 --percentage 100 --location london locally chaos eventgrid 429 reset --location london
Usage
locally chaos eventgrid 429 [flags] locally chaos eventgrid 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventgrid 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Event Grid (data plane).
Set the 500 fault's rate on Event Grid (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventgrid 500 --percentage 25 locally chaos eventgrid 500 --percentage 100 --location london locally chaos eventgrid 500 reset --location london
Usage
locally chaos eventgrid 500 [flags] locally chaos eventgrid 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventgrid 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Event Grid (data plane).
Set the drop-connection fault's rate on Event Grid (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventgrid drop-connection --percentage 25 locally chaos eventgrid drop-connection --percentage 100 --location london locally chaos eventgrid drop-connection reset --location london
Usage
locally chaos eventgrid drop-connection [flags] locally chaos eventgrid drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventgrid drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Event Grid (data plane).
Set the latency fault's rate on Event Grid (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos eventgrid latency --percentage 25 --seconds 30 locally chaos eventgrid latency --percentage 100 --seconds 30 --location london locally chaos eventgrid latency reset --location london
Usage
locally chaos eventgrid latency [flags] locally chaos eventgrid latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventgrid latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Event Grid (data plane).
Set the outage fault's rate on Event Grid (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventgrid outage --percentage 25 locally chaos eventgrid outage --percentage 100 --location london locally chaos eventgrid outage reset --location london
Usage
locally chaos eventgrid outage [flags] locally chaos eventgrid outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventgrid outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Event Grid (data plane) fault and drop every rule.
Zero every Event Grid (data plane) fault and drop every rule. Examples: locally chaos eventgrid reset
Usage
locally chaos eventgrid reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Event Grid (data plane) chaos configuration.
Print the current Event Grid (data plane) chaos configuration. Examples: locally chaos eventgrid show
Usage
locally chaos eventgrid show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Event Hubs (data plane) failure modes.
Simulate Event Hubs (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos eventhub <fault> --percentage N locally chaos eventhub <fault> reset locally chaos eventhub show locally chaos eventhub reset
Usage
locally chaos eventhub [flags] locally chaos eventhub [command]
Subcommands
Set the 403 fault's rate on Event Hubs (data plane).
Set the 403 fault's rate on Event Hubs (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventhub 403 --percentage 25 locally chaos eventhub 403 --percentage 100 --location london locally chaos eventhub 403 reset --location london
Usage
locally chaos eventhub 403 [flags] locally chaos eventhub 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventhub 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Event Hubs (data plane).
Set the 429 fault's rate on Event Hubs (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventhub 429 --percentage 25 locally chaos eventhub 429 --percentage 100 --location london locally chaos eventhub 429 reset --location london
Usage
locally chaos eventhub 429 [flags] locally chaos eventhub 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventhub 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Event Hubs (data plane).
Set the 500 fault's rate on Event Hubs (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventhub 500 --percentage 25 locally chaos eventhub 500 --percentage 100 --location london locally chaos eventhub 500 reset --location london
Usage
locally chaos eventhub 500 [flags] locally chaos eventhub 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventhub 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Event Hubs (data plane).
Set the drop-connection fault's rate on Event Hubs (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventhub drop-connection --percentage 25 locally chaos eventhub drop-connection --percentage 100 --location london locally chaos eventhub drop-connection reset --location london
Usage
locally chaos eventhub drop-connection [flags] locally chaos eventhub drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventhub drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Event Hubs (data plane).
Set the latency fault's rate on Event Hubs (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos eventhub latency --percentage 25 --seconds 30 locally chaos eventhub latency --percentage 100 --seconds 30 --location london locally chaos eventhub latency reset --location london
Usage
locally chaos eventhub latency [flags] locally chaos eventhub latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventhub latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Event Hubs (data plane).
Set the outage fault's rate on Event Hubs (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos eventhub outage --percentage 25 locally chaos eventhub outage --percentage 100 --location london locally chaos eventhub outage reset --location london
Usage
locally chaos eventhub outage [flags] locally chaos eventhub outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos eventhub outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Event Hubs (data plane) fault and drop every rule.
Zero every Event Hubs (data plane) fault and drop every rule. Examples: locally chaos eventhub reset
Usage
locally chaos eventhub reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Event Hubs (data plane) chaos configuration.
Print the current Event Hubs (data plane) chaos configuration. Examples: locally chaos eventhub show
Usage
locally chaos eventhub show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Functions (data plane) failure modes.
Simulate Functions (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos functions <fault> --percentage N locally chaos functions <fault> reset locally chaos functions show locally chaos functions reset
Usage
locally chaos functions [flags] locally chaos functions [command]
Subcommands
Set the 403 fault's rate on Functions (data plane).
Set the 403 fault's rate on Functions (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos functions 403 --percentage 25 locally chaos functions 403 --percentage 100 --location london locally chaos functions 403 reset --location london
Usage
locally chaos functions 403 [flags] locally chaos functions 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos functions 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Functions (data plane).
Set the 429 fault's rate on Functions (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos functions 429 --percentage 25 locally chaos functions 429 --percentage 100 --location london locally chaos functions 429 reset --location london
Usage
locally chaos functions 429 [flags] locally chaos functions 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos functions 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Functions (data plane).
Set the 500 fault's rate on Functions (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos functions 500 --percentage 25 locally chaos functions 500 --percentage 100 --location london locally chaos functions 500 reset --location london
Usage
locally chaos functions 500 [flags] locally chaos functions 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos functions 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Functions (data plane).
Set the drop-connection fault's rate on Functions (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos functions drop-connection --percentage 25 locally chaos functions drop-connection --percentage 100 --location london locally chaos functions drop-connection reset --location london
Usage
locally chaos functions drop-connection [flags] locally chaos functions drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos functions drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Functions (data plane).
Set the latency fault's rate on Functions (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos functions latency --percentage 25 --seconds 30 locally chaos functions latency --percentage 100 --seconds 30 --location london locally chaos functions latency reset --location london
Usage
locally chaos functions latency [flags] locally chaos functions latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos functions latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Functions (data plane).
Set the outage fault's rate on Functions (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos functions outage --percentage 25 locally chaos functions outage --percentage 100 --location london locally chaos functions outage reset --location london
Usage
locally chaos functions outage [flags] locally chaos functions outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos functions outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Functions (data plane) fault and drop every rule.
Zero every Functions (data plane) fault and drop every rule. Examples: locally chaos functions reset
Usage
locally chaos functions reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Functions (data plane) chaos configuration.
Print the current Functions (data plane) chaos configuration. Examples: locally chaos functions show
Usage
locally chaos functions show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Key Vault (data plane) failure modes.
Simulate Key Vault (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos keyvault <fault> --percentage N locally chaos keyvault <fault> reset locally chaos keyvault show locally chaos keyvault reset
Usage
locally chaos keyvault [flags] locally chaos keyvault [command]
Subcommands
Set the 403 fault's rate on Key Vault (data plane).
Set the 403 fault's rate on Key Vault (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos keyvault 403 --percentage 25 locally chaos keyvault 403 --percentage 100 --location london locally chaos keyvault 403 reset --location london
Usage
locally chaos keyvault 403 [flags] locally chaos keyvault 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos keyvault 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Key Vault (data plane).
Set the 429 fault's rate on Key Vault (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos keyvault 429 --percentage 25 locally chaos keyvault 429 --percentage 100 --location london locally chaos keyvault 429 reset --location london
Usage
locally chaos keyvault 429 [flags] locally chaos keyvault 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos keyvault 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Key Vault (data plane).
Set the 500 fault's rate on Key Vault (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos keyvault 500 --percentage 25 locally chaos keyvault 500 --percentage 100 --location london locally chaos keyvault 500 reset --location london
Usage
locally chaos keyvault 500 [flags] locally chaos keyvault 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos keyvault 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Key Vault (data plane).
Set the drop-connection fault's rate on Key Vault (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos keyvault drop-connection --percentage 25 locally chaos keyvault drop-connection --percentage 100 --location london locally chaos keyvault drop-connection reset --location london
Usage
locally chaos keyvault drop-connection [flags] locally chaos keyvault drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos keyvault drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Key Vault (data plane).
Set the latency fault's rate on Key Vault (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos keyvault latency --percentage 25 --seconds 30 locally chaos keyvault latency --percentage 100 --seconds 30 --location london locally chaos keyvault latency reset --location london
Usage
locally chaos keyvault latency [flags] locally chaos keyvault latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos keyvault latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Key Vault (data plane).
Set the outage fault's rate on Key Vault (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos keyvault outage --percentage 25 locally chaos keyvault outage --percentage 100 --location london locally chaos keyvault outage reset --location london
Usage
locally chaos keyvault outage [flags] locally chaos keyvault outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos keyvault outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Key Vault (data plane) fault and drop every rule.
Zero every Key Vault (data plane) fault and drop every rule. Examples: locally chaos keyvault reset
Usage
locally chaos keyvault reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Key Vault (data plane) chaos configuration.
Print the current Key Vault (data plane) chaos configuration. Examples: locally chaos keyvault show
Usage
locally chaos keyvault show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Managed HSM (data plane) failure modes.
Simulate Managed HSM (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos managedhsm <fault> --percentage N locally chaos managedhsm <fault> reset locally chaos managedhsm show locally chaos managedhsm reset
Usage
locally chaos managedhsm [flags] locally chaos managedhsm [command]
Subcommands
Set the 403 fault's rate on Managed HSM (data plane).
Set the 403 fault's rate on Managed HSM (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos managedhsm 403 --percentage 25 locally chaos managedhsm 403 --percentage 100 --location london locally chaos managedhsm 403 reset --location london
Usage
locally chaos managedhsm 403 [flags] locally chaos managedhsm 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos managedhsm 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Managed HSM (data plane).
Set the 429 fault's rate on Managed HSM (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos managedhsm 429 --percentage 25 locally chaos managedhsm 429 --percentage 100 --location london locally chaos managedhsm 429 reset --location london
Usage
locally chaos managedhsm 429 [flags] locally chaos managedhsm 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos managedhsm 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Managed HSM (data plane).
Set the 500 fault's rate on Managed HSM (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos managedhsm 500 --percentage 25 locally chaos managedhsm 500 --percentage 100 --location london locally chaos managedhsm 500 reset --location london
Usage
locally chaos managedhsm 500 [flags] locally chaos managedhsm 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos managedhsm 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Managed HSM (data plane).
Set the drop-connection fault's rate on Managed HSM (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos managedhsm drop-connection --percentage 25 locally chaos managedhsm drop-connection --percentage 100 --location london locally chaos managedhsm drop-connection reset --location london
Usage
locally chaos managedhsm drop-connection [flags] locally chaos managedhsm drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos managedhsm drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Managed HSM (data plane).
Set the latency fault's rate on Managed HSM (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos managedhsm latency --percentage 25 --seconds 30 locally chaos managedhsm latency --percentage 100 --seconds 30 --location london locally chaos managedhsm latency reset --location london
Usage
locally chaos managedhsm latency [flags] locally chaos managedhsm latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos managedhsm latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Managed HSM (data plane).
Set the outage fault's rate on Managed HSM (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos managedhsm outage --percentage 25 locally chaos managedhsm outage --percentage 100 --location london locally chaos managedhsm outage reset --location london
Usage
locally chaos managedhsm outage [flags] locally chaos managedhsm outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos managedhsm outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Managed HSM (data plane) fault and drop every rule.
Zero every Managed HSM (data plane) fault and drop every rule. Examples: locally chaos managedhsm reset
Usage
locally chaos managedhsm reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Managed HSM (data plane) chaos configuration.
Print the current Managed HSM (data plane) chaos configuration. Examples: locally chaos managedhsm show
Usage
locally chaos managedhsm show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Monitor (data plane) failure modes.
Simulate Monitor (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos monitor <fault> --percentage N locally chaos monitor <fault> reset locally chaos monitor show locally chaos monitor reset
Usage
locally chaos monitor [flags] locally chaos monitor [command]
Subcommands
Set the 403 fault's rate on Monitor (data plane).
Set the 403 fault's rate on Monitor (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos monitor 403 --percentage 25 locally chaos monitor 403 --percentage 100 --location london locally chaos monitor 403 reset --location london
Usage
locally chaos monitor 403 [flags] locally chaos monitor 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos monitor 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Monitor (data plane).
Set the 429 fault's rate on Monitor (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos monitor 429 --percentage 25 locally chaos monitor 429 --percentage 100 --location london locally chaos monitor 429 reset --location london
Usage
locally chaos monitor 429 [flags] locally chaos monitor 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos monitor 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Monitor (data plane).
Set the 500 fault's rate on Monitor (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos monitor 500 --percentage 25 locally chaos monitor 500 --percentage 100 --location london locally chaos monitor 500 reset --location london
Usage
locally chaos monitor 500 [flags] locally chaos monitor 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos monitor 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Monitor (data plane).
Set the drop-connection fault's rate on Monitor (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos monitor drop-connection --percentage 25 locally chaos monitor drop-connection --percentage 100 --location london locally chaos monitor drop-connection reset --location london
Usage
locally chaos monitor drop-connection [flags] locally chaos monitor drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos monitor drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Monitor (data plane).
Set the latency fault's rate on Monitor (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos monitor latency --percentage 25 --seconds 30 locally chaos monitor latency --percentage 100 --seconds 30 --location london locally chaos monitor latency reset --location london
Usage
locally chaos monitor latency [flags] locally chaos monitor latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos monitor latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Monitor (data plane).
Set the outage fault's rate on Monitor (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos monitor outage --percentage 25 locally chaos monitor outage --percentage 100 --location london locally chaos monitor outage reset --location london
Usage
locally chaos monitor outage [flags] locally chaos monitor outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos monitor outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Monitor (data plane) fault and drop every rule.
Zero every Monitor (data plane) fault and drop every rule. Examples: locally chaos monitor reset
Usage
locally chaos monitor reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Monitor (data plane) chaos configuration.
Print the current Monitor (data plane) chaos configuration. Examples: locally chaos monitor show
Usage
locally chaos monitor show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Service Bus (data plane) failure modes.
Simulate Service Bus (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos servicebus <fault> --percentage N locally chaos servicebus <fault> reset locally chaos servicebus show locally chaos servicebus reset
Usage
locally chaos servicebus [flags] locally chaos servicebus [command]
Subcommands
Set the 403 fault's rate on Service Bus (data plane).
Set the 403 fault's rate on Service Bus (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos servicebus 403 --percentage 25 locally chaos servicebus 403 --percentage 100 --location london locally chaos servicebus 403 reset --location london
Usage
locally chaos servicebus 403 [flags] locally chaos servicebus 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos servicebus 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Service Bus (data plane).
Set the 429 fault's rate on Service Bus (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos servicebus 429 --percentage 25 locally chaos servicebus 429 --percentage 100 --location london locally chaos servicebus 429 reset --location london
Usage
locally chaos servicebus 429 [flags] locally chaos servicebus 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos servicebus 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Service Bus (data plane).
Set the 500 fault's rate on Service Bus (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos servicebus 500 --percentage 25 locally chaos servicebus 500 --percentage 100 --location london locally chaos servicebus 500 reset --location london
Usage
locally chaos servicebus 500 [flags] locally chaos servicebus 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos servicebus 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Service Bus (data plane).
Set the drop-connection fault's rate on Service Bus (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos servicebus drop-connection --percentage 25 locally chaos servicebus drop-connection --percentage 100 --location london locally chaos servicebus drop-connection reset --location london
Usage
locally chaos servicebus drop-connection [flags] locally chaos servicebus drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos servicebus drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Service Bus (data plane).
Set the latency fault's rate on Service Bus (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos servicebus latency --percentage 25 --seconds 30 locally chaos servicebus latency --percentage 100 --seconds 30 --location london locally chaos servicebus latency reset --location london
Usage
locally chaos servicebus latency [flags] locally chaos servicebus latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos servicebus latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Service Bus (data plane).
Set the outage fault's rate on Service Bus (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos servicebus outage --percentage 25 locally chaos servicebus outage --percentage 100 --location london locally chaos servicebus outage reset --location london
Usage
locally chaos servicebus outage [flags] locally chaos servicebus outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos servicebus outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Service Bus (data plane) fault and drop every rule.
Zero every Service Bus (data plane) fault and drop every rule. Examples: locally chaos servicebus reset
Usage
locally chaos servicebus reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Service Bus (data plane) chaos configuration.
Print the current Service Bus (data plane) chaos configuration. Examples: locally chaos servicebus show
Usage
locally chaos servicebus show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the chaos configuration for every subscription-scoped surface.
Print the chaos configuration for every subscription-scoped surface. Examples: locally chaos show
Usage
locally chaos show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Simulate Storage (data plane) failure modes.
Simulate Storage (data plane) failure modes. Without --location, a fault command sets the fault's rate; with them, it adds or edits a rule. Examples: locally chaos storage <fault> --percentage N locally chaos storage <fault> reset locally chaos storage show locally chaos storage reset
Usage
locally chaos storage [flags] locally chaos storage [command]
Subcommands
Set the 403 fault's rate on Storage (data plane).
Set the 403 fault's rate on Storage (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos storage 403 --percentage 25 locally chaos storage 403 --percentage 100 --location london locally chaos storage 403 reset --location london
Usage
locally chaos storage 403 [flags] locally chaos storage 403 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 403 rule, or put the whole fault back to zero.
Reset the 403 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos storage 403 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 429 fault's rate on Storage (data plane).
Set the 429 fault's rate on Storage (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos storage 429 --percentage 25 locally chaos storage 429 --percentage 100 --location london locally chaos storage 429 reset --location london
Usage
locally chaos storage 429 [flags] locally chaos storage 429 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 429 rule, or put the whole fault back to zero.
Reset the 429 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos storage 429 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the 500 fault's rate on Storage (data plane).
Set the 500 fault's rate on Storage (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos storage 500 --percentage 25 locally chaos storage 500 --percentage 100 --location london locally chaos storage 500 reset --location london
Usage
locally chaos storage 500 [flags] locally chaos storage 500 [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one 500 rule, or put the whole fault back to zero.
Reset the 500 fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos storage 500 reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the drop-connection fault's rate on Storage (data plane).
Set the drop-connection fault's rate on Storage (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos storage drop-connection --percentage 25 locally chaos storage drop-connection --percentage 100 --location london locally chaos storage drop-connection reset --location london
Usage
locally chaos storage drop-connection [flags] locally chaos storage drop-connection [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one drop-connection rule, or put the whole fault back to zero.
Reset the drop-connection fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos storage drop-connection reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the latency fault's rate on Storage (data plane).
Set the latency fault's rate on Storage (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. --seconds is a maximum: each firing delays a random 0..N seconds, and is required whenever --percentage is above 0. Examples: locally chaos storage latency --percentage 25 --seconds 30 locally chaos storage latency --percentage 100 --seconds 30 --location london locally chaos storage latency reset --location london
Usage
locally chaos storage latency [flags] locally chaos storage latency [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --seconds | int | Maximum delay this fault adds, in seconds (each firing picks 0 to N) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one latency rule, or put the whole fault back to zero.
Reset the latency fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos storage latency reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Set the outage fault's rate on Storage (data plane).
Set the outage fault's rate on Storage (data plane). Without scope flags this sets the fault's rate. With --location it adds or edits one rule, leaving the rate and other rules alone. A rule can be lower than the rate: "everywhere except one place" is a rate of 100 plus a rule at 0. Examples: locally chaos storage outage --percentage 25 locally chaos storage outage --percentage 100 --location london locally chaos storage outage reset --location london
Usage
locally chaos storage outage [flags] locally chaos storage outage [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --percentage | int | How often this fault fires, 0-100 (required) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Subcommands
Remove one outage rule, or put the whole fault back to zero.
Reset the outage fault. With a scope flag, removes that rule so those requests use the fault's rate. Without one, removes every rule and sets the rate to 0. 'reset --location X' removes the rule; '--percentage 0 --location X' keeps a rule that never fires, which is how to say "everywhere except X".
Usage
locally chaos storage outage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --location | string | Scope this rule to one location, e.g. london |
| --subscription | string | Subscription UUID (defaults to the configured default) |
Zero every Storage (data plane) fault and drop every rule.
Zero every Storage (data plane) fault and drop every rule. Examples: locally chaos storage reset
Usage
locally chaos storage reset [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Print the current Storage (data plane) chaos configuration.
Print the current Storage (data plane) chaos configuration. Examples: locally chaos storage show
Usage
locally chaos storage show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID (defaults to the configured default) |
Launch the Locally environment in CI mode.
Launches the Locally environment in CI mode on this machine, and leaves it running for the rest of the job. CI mode is a subset of the Locally environment and includes: * The Control Plane API * The Authorization API * The Directory API * An Automation API This lets your CI pipeline build and test against Locally. Run 'locally ci --stop' at the end of the job to stop what it started. Authentication is attempted in the following order: 1. LOCALLY_OIDC_TOKEN or LOCALLY_OIDC_TOKEN_FILE (custom OIDC provider, or Jenkins via its OpenID Connect Provider plugin credential binding) 2. GitHub Actions OIDC (auto-detected) 3. GitLab CI OIDC (via id_tokens) Set exactly one of: - LOCALLY_TEAM_UUID for team OIDC trusts - LOCALLY_USER_UUID for personal OIDC trusts
Usage
locally ci [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --stop | Stop a running Locally CI environment |
Generate the autocompletion script for the specified shell
Generate the autocompletion script for locally for the specified shell. See each sub-command's help for details on how to use the generated script.
Usage
locally completion [command]
Subcommands
Generate the autocompletion script for bash
Generate the autocompletion script for the bash shell. This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager. To load completions in your current shell session: source <(locally completion bash) To load completions for every new session, execute once: #### Linux: locally completion bash > /etc/bash_completion.d/locally #### macOS: locally completion bash > $(brew --prefix)/etc/bash_completion.d/locally You will need to start a new shell for this setup to take effect.
Usage
locally completion bash
Flags
| Flag | Type | Description |
|---|---|---|
| --no-descriptions | disable completion descriptions |
Generate the autocompletion script for fish
Generate the autocompletion script for the fish shell. To load completions in your current shell session: locally completion fish | source To load completions for every new session, execute once: locally completion fish > ~/.config/fish/completions/locally.fish You will need to start a new shell for this setup to take effect.
Usage
locally completion fish [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --no-descriptions | disable completion descriptions |
Generate the autocompletion script for powershell
Generate the autocompletion script for powershell. To load completions in your current shell session: locally completion powershell | Out-String | Invoke-Expression To load completions for every new session, add the output of the above command to your powershell profile.
Usage
locally completion powershell [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --no-descriptions | disable completion descriptions |
Generate the autocompletion script for zsh
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(locally completion zsh)
To load completions for every new session, execute once:
#### Linux:
locally completion zsh > "${fpath[1]}/_locally"
#### macOS:
locally completion zsh > $(brew --prefix)/share/zsh/site-functions/_locally
You will need to start a new shell for this setup to take effect.
Usage
locally completion zsh [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --no-descriptions | disable completion descriptions |
Configure this machine for Locally, one change at a time.
Each subcommand makes one configuration change, and is safe to re-run. Use --status to check it, or --remove to undo it. To be walked through every change, run `locally setup`; to check them all, run `locally validate`. For TLS certificates, see `locally certificate`.
Usage
locally configure [flags] locally configure [command]
Subcommands
Add Locally to Azure Storage Explorer as a custom environment.
Adds a "Locally" custom environment to Azure Storage Explorer using this instance's endpoints, and installs the Locally CA so that Storage Explorer trusts it. Locally must be running and Storage Explorer must be closed. Afterwards, sign out of any account already in the Locally environment and add it again. Re-run this if Locally's ports change. Examples: locally configure azure-storage-explorer locally configure azure-storage-explorer --status locally configure azure-storage-explorer --remove
Usage
locally configure azure-storage-explorer [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dry-run | Print what would change, without changing it. | |
| --remove | Undo this configuration, removing only what Locally added. | |
| --status | Report whether this is configured, without changing anything. |
Configure this machine's resolver so *.locally addresses resolve.
Usage
locally configure dns [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dry-run | Print what would change, without changing it. | |
| --remove | Undo this configuration, removing only what Locally added. | |
| --status | Report whether this is configured, without changing anything. |
Set up Locally's DNS forwarder so containers on Docker Desktop resolve *.locally.
Builds the DNS forwarder image Locally runs alongside Docker Desktop, so the containers Locally launches can resolve *.locally. Docker Desktop's VM can't be configured the way Podman's can, so `locally build` runs a dnsmasq container that forwards *.locally to Locally, and starts its own containers (Container Instances, databases, Web Apps) with --dns pointing at it. Your own containers are not touched. Running this ahead of time saves the first `locally build` pulling the image. While Locally is running, it also starts the forwarder and checks that it resolves. Pushing images to Locally's registry from Docker Desktop isn't supported, since --dns only applies to containers and the Docker daemon can't be pointed at Locally. Use podman for that, via `locally configure podman`. Set LOCALLY_CONTAINER_DNS to "docker=<address>" to use your own forwarder, or "none" to opt out.
Usage
locally configure docker [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dry-run | Print what would change, without changing it. | |
| --remove | Undo this configuration, removing only what Locally added. | |
| --status | Report whether this is configured, without changing anything. |
Configure Podman's VM so its daemon and containers resolve *.locally.
Usage
locally configure podman [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dry-run | Print what would change, without changing it. | |
| --remove | Undo this configuration, removing only what Locally added. | |
| --restart-wsl | When enabling WSL mirrored networking on Windows, restart WSL to apply it without prompting (shuts down all WSL distributions). | |
| --status | Report whether this is configured, without changing anything. |
Connect to a Virtual Machine or a Virtual Machine Scale Set instance.
Connects to a Virtual Machine, or an instance of a Virtual Machine Scale Set, using its admin credentials. Linux VMs open an SSH session in your terminal. Windows VMs open an .rdp file on macOS; elsewhere, the file's path is printed. The VM needs a public IP, or a Load Balancer inbound NAT rule targeting its network interface. Pass --bastion alone to list the VMs reachable through it, or with --virtual-machine to connect through it. Examples: locally connect --virtual-machine my-vm locally connect --virtual-machine my-vm --subscription 00000000-0000-0000-0000-000000000000 locally connect --virtual-machine-scale-set my-scale-set --instance-id 0 locally connect --bastion my-bastion locally connect --bastion my-bastion --virtual-machine my-vm
Usage
locally connect [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --bastion | string | Name of a bastion; lists reachable VMs, or connects through it when combined with --virtual-machine |
| --instance-id | string | Instance ID within the scale set (use with --virtual-machine-scale-set) |
| --subscription | string | Subscription UUID (defaults to the configured default) |
| --virtual-machine | string | Name of the virtual machine to connect to |
| --virtual-machine-scale-set | string | Name of the virtual machine scale set holding the instance to connect to |
Open the Locally Dashboard in your browser.
Usage
locally dashboard [flags]
Deploy an ARM or Bicep template to Locally.
Deploys an ARM template, or a Bicep file (using the bicep CLI on your PATH), and follows it to completion. The scope (resource group or subscription) is read from the template's $schema. Without flags, the default Subscription is used and the Resource Group and deployment names are generated. Examples: # Deploy into a generated resource group in the default subscription locally deploy ./template.json # Deploy into an existing resource group locally deploy --resource-group example ./template.json # With an ARM parameters file locally deploy --parameters ./parameters.json ./template.json # Bicep: a .bicep template with a .bicepparam parameters file (needs 'bicep' on your PATH) locally deploy --parameters ./main.bicepparam ./main.bicep # A subscription-scoped template, recording the deployment in a chosen location locally deploy --location berlin ./subscription-template.json # Into a specific subscription, under a chosen deployment name locally deploy --subscription 00000000-0000-0000-0000-000000000000 --deployment nightly ./template.json
Usage
locally deploy [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --deployment | string | Name to record the deployment under (e.g. --deployment=test) |
| --location | string | Location for a subscription-scoped deployment (e.g. --location=berlin) |
| --parameters | string | Path to an ARM parameters file (e.g. --parameters=./parameters.json) |
| --resource-group | string | Resource group for a group-scoped deployment (e.g. --resource-group=some-group) |
| --subscription | string | Subscription to deploy into (e.g. --subscription=abc123) |
Open the Locally documentation in your browser.
Usage
locally docs [flags]
Interact with Event Hubs Namespaces within Locally.
Usage
locally eventhub [flags] locally eventhub [command]
Subcommands
Print the primary connection string for an Event Hubs Namespace.
Print the primary connection string for an Event Hubs Namespace. Examples: locally eventhub connection-string --namespace ns1
Usage
locally eventhub connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Event Hubs namespace |
Manage Consumer Groups in an Event Hub within Locally.
Usage
locally eventhub consumer-group [flags] locally eventhub consumer-group [command]
Subcommands
Create a Consumer Group for an Event Hub.
Create a Consumer Group for an Event Hub. Examples: locally eventhub consumer-group create --namespace ns1 --hub orders --name billing
Usage
locally eventhub consumer-group create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the event hub |
| --name | string | Name of the consumer group |
| --namespace | string | Name of the Event Hubs namespace |
Delete a Consumer Group from an Event Hub.
Delete a Consumer Group from an Event Hub. Examples: locally eventhub consumer-group delete --namespace ns1 --hub orders --name billing
Usage
locally eventhub consumer-group delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the event hub |
| --name | string | Name of the consumer group |
| --namespace | string | Name of the Event Hubs namespace |
List Consumer Groups for an Event Hub.
List Consumer Groups for an Event Hub. Examples: locally eventhub consumer-group list --namespace ns1 --hub orders
Usage
locally eventhub consumer-group list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the event hub |
| --namespace | string | Name of the Event Hubs namespace |
Show details for a Consumer Group.
Show details for a Consumer Group. Examples: locally eventhub consumer-group show --namespace ns1 --hub orders --name billing
Usage
locally eventhub consumer-group show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the event hub |
| --name | string | Name of the consumer group |
| --namespace | string | Name of the Event Hubs namespace |
Open the Data Plane Emulator UI for an Event Hubs Namespace in your browser.
Open the Data Plane Emulator UI for an Event Hubs Namespace in your browser. Examples: locally eventhub dashboard --namespace ns1
Usage
locally eventhub dashboard [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Event Hubs namespace |
Manage Event Hubs in an Event Hubs Namespace within Locally.
Usage
locally eventhub hub [flags] locally eventhub hub [command]
Subcommands
Create an Event Hub in an Event Hubs Namespace.
Create an Event Hub in an Event Hubs Namespace. Examples: locally eventhub hub create --namespace ns1 --name orders --partition-count 4
Usage
locally eventhub hub create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the event hub |
| --namespace | string | Name of the Event Hubs namespace |
| --partition-count | int | Number of partitions (default 4) |
Delete an Event Hub from an Event Hubs Namespace.
Delete an Event Hub from an Event Hubs Namespace. Examples: locally eventhub hub delete --namespace ns1 --name orders
Usage
locally eventhub hub delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the event hub |
| --namespace | string | Name of the Event Hubs namespace |
List Event Hubs in an Event Hubs Namespace.
List Event Hubs in an Event Hubs Namespace. Examples: locally eventhub hub list --namespace ns1
Usage
locally eventhub hub list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Event Hubs namespace |
Peek at events in an Event Hub partition.
Peek at events in an Event Hub partition. Examples: locally eventhub hub peek --namespace ns1 --name orders --partition 0 --limit 5
Usage
locally eventhub hub peek [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --limit | int | Maximum number of events to peek (default 10) |
| --name | string | Name of the event hub |
| --namespace | string | Name of the Event Hubs namespace |
| --partition | string | Partition ID to peek |
Send an event to an Event Hub.
Send an event to an Event Hub.
Examples:
locally eventhub hub send --namespace ns1 --name orders --body '{"id": 1}' --content-type application/json
locally eventhub hub send --namespace ns1 --name orders --body-file ./event.json --partition-key customer-42 --count 10
Usage
locally eventhub hub send [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --body | string | Inline event body |
| --body-file | string | Path to a file containing the event body |
| --content-type | string | Content-Type of the event body |
| --count | int | Number of copies of the event to send (default 1) |
| --name | string | Name of the event hub |
| --namespace | string | Name of the Event Hubs namespace |
| --partition-key | string | Partition key to route the event by |
| --property | stringArray | Custom event property as key=value (repeatable) |
Show details for an Event Hub in an Event Hubs Namespace.
Show details for an Event Hub in an Event Hubs Namespace. Examples: locally eventhub hub show --namespace ns1 --name orders
Usage
locally eventhub hub show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the event hub |
| --namespace | string | Name of the Event Hubs namespace |
Interact with Function Apps within Locally.
Usage
locally function [flags] locally function [command]
Subcommands
Open a Function App's dashboard in your browser.
Usage
locally function dashboard [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the function app |
Deploy a package to a Function App.
Deploys a zip package to a function app and waits for the deployment to finish. Examples: locally function deploy --name example app.zip
Usage
locally function deploy [zip file] [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --env | stringArray | Environment variables (KEY=VALUE), can be specified multiple times |
| --name | string | Name of the function app |
Invoke a function endpoint.
Invokes an HTTP-triggered function and prints the response. Examples: locally function invoke --name example --endpoint /api/hello
Usage
locally function invoke [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --endpoint | string | API endpoint to invoke (e.g. /api/hello) |
| --name | string | Name of the function app |
Interact with IoT Hubs within Locally.
Usage
locally iothub [flags] locally iothub [command]
Subcommands
Print the primary connection string for an IoT Hub.
Prints the connection string for the Hub's iothubowner policy, for the IoT Hub service SDKs and az iot hub. HostName includes the Hub's port (5662 on the default instance, <base-port> + 662 otherwise). Without it, clients connect to 443 and are refused. Pass it to az iot hub as --login for commands on Devices, Device Twins and direct methods. Managing the Hub itself (az iot hub create, Terraform, locally iothub) goes through ARM and doesn't need it. AMQP (5671) and MQTT (5883) use their own ports, which clients on those transports must set separately. Examples: locally iothub connection-string --hub hub1
Usage
locally iothub connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the IoT Hub |
Open the Data Plane Emulator UI for an IoT Hub in your browser.
Open the Data Plane Emulator UI for an IoT Hub in your browser. Examples: locally iothub dashboard --hub hub1
Usage
locally iothub dashboard [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the IoT Hub |
Manage Devices in an IoT Hub within Locally.
Usage
locally iothub device [flags] locally iothub device [command]
Subcommands
Create a Device in an IoT Hub.
Create a Device in an IoT Hub. Examples: locally iothub device create --hub hub1 --device sensor-01
Usage
locally iothub device create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
Delete a Device from an IoT Hub.
Delete a Device from an IoT Hub. Examples: locally iothub device delete --hub hub1 --device sensor-01
Usage
locally iothub device delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
List Devices in an IoT Hub.
List Devices in an IoT Hub. Examples: locally iothub device list --hub hub1
Usage
locally iothub device list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --hub | string | Name of the IoT Hub |
Peek at device-to-cloud (D2C) telemetry events for a Device.
Peek at device-to-cloud (D2C) telemetry events for a Device. Examples: locally iothub device peek --hub hub1 --device sensor-01 --limit 5
Usage
locally iothub device peek [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
| --limit | int | Maximum number of events to peek (default 10) |
Send a device-to-cloud (D2C) telemetry message for a Device.
Send a device-to-cloud (D2C) telemetry message for a Device.
Examples:
locally iothub device send --hub hub1 --device sensor-01 --body '{"temperature": 21.5}' --content-type application/json
Usage
locally iothub device send [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --body | string | Inline telemetry body |
| --body-file | string | Path to a file containing the telemetry body |
| --content-type | string | Content-Type of the telemetry body |
| --count | int | Number of copies of the telemetry message to send (default 1) |
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
| --property | stringArray | Custom telemetry property as key=value (repeatable) |
Show details for a Device in an IoT Hub.
Show details for a Device in an IoT Hub. Examples: locally iothub device show --hub hub1 --device sensor-01
Usage
locally iothub device show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
Manage Device Twins in an IoT Hub within Locally.
Usage
locally iothub twin [flags] locally iothub twin [command]
Subcommands
Show the Device Twin for a Device in an IoT Hub.
Show the Device Twin for a Device in an IoT Hub. Examples: locally iothub twin show --hub hub1 --device sensor-01
Usage
locally iothub twin show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
Update the desired properties of a Device Twin.
Update the desired properties of a Device Twin.
Examples:
locally iothub twin update --hub hub1 --device sensor-01 --desired '{"interval": 30}'
Usage
locally iothub twin update [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --desired | string | Desired properties JSON string |
| --device | string | Device ID |
| --hub | string | Name of the IoT Hub |
Sign this installation in to a Locally Account.
Connects an installation that was set up without an account to a Locally Account. Signing in lifts the plugin allowance and gives you a longer session. To set up a new installation, use 'locally setup' instead.
Usage
locally login [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --skip-browser | Print the sign-in URL instead of opening a browser. |
Sign out and deregister this installation.
Signs you out of your Locally Account on this machine and removes this installation's certificate. Locally will not run again until you re-run 'locally setup'.
Usage
locally logout [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --force | Skip the confirmation prompt. |
View HTTP request/response logs.
View HTTP request/response logs from all services, with interactive filtering.
Usage
locally logs [flags] locally logs [command]
Flags
| Flag | Type | Description |
|---|---|---|
| --json | Output logs as JSON |
Subcommands
Clear all logs.
Usage
locally logs clear [flags]
Launch the Locally MCP server.
Launches the Locally MCP server. Subcommands register the server into MCP clients.
Usage
locally mcp [flags] locally mcp [command]
Subcommands
Register the Locally MCP server in a client's config.
Registers the Locally MCP server, as "locally", in an MCP client's configuration, pointing at this binary. Supported clients: claude-desktop, claude-code, cursor, opencode, windsurf, copilot-vscode, copilot-cli, codex-cli, gemini-cli. Fails if a "locally" entry already exists, unless you pass --force. Examples: locally mcp install claude-desktop locally mcp install claude-code locally mcp install codex-cli --force
Usage
locally mcp install <client> [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --force | Overwrite an existing locally entry |
List supported MCP clients and whether `locally` is registered.
Lists the supported MCP clients, whether each is installed, and whether the Locally MCP server is registered in it. Examples: locally mcp list
Usage
locally mcp list [flags]
Remove the Locally MCP server from a client's config.
Removes the Locally MCP server from an MCP client's configuration. Fails if there is no "locally" entry, unless you pass --force. Examples: locally mcp uninstall claude-desktop locally mcp uninstall claude-code --force
Usage
locally mcp uninstall <client> [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --force | Succeed even if no locally entry is present |
Interact with MySQL Flexible Servers within Locally.
Usage
locally mysql [flags] locally mysql [command]
Subcommands
Print the connection string for a MySQL Flexible Server.
Print the connection string for a MySQL Flexible Server. Examples: locally mysql connection-string --server my-server
Usage
locally mysql connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| -g, --resource-group | string | Resource group the server is in (disambiguates a name that exists in more than one) |
| --server | string | Name (or full resource ID) of the MySQL flexible server |
Manage Resource Provider plugins.
Usage
locally plugin [flags] locally plugin [command]
Subcommands
Install Resource Provider plugins.
Install one, all, or recommended Resource Provider plugins. Examples: locally plugin install --name Microsoft.KeyVault locally plugin install --recommended locally plugin install --all
Usage
locally plugin install [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --all | Install all available providers | |
| --name | string | Resource Provider namespace (e.g. Microsoft.KeyVault) |
| --recommended | Install all recommended providers |
List all available Resource Provider plugins from the catalog.
Usage
locally plugin list-available [flags]
List installed Resource Provider plugins.
Usage
locally plugin list-installed [flags]
List available Resource Provider plugins that are not installed locally.
Usage
locally plugin list-not-installed [flags]
Show metadata for an installed Resource Provider plugin.
Prints an installed plugin's platform, release version, revision and date, API versions, features and notes. Works while Locally is stopped. Matching is case-insensitive. For a namespace with no plugin installed, says whether it's built in, available in the catalog, or unknown. Examples: locally plugin show Microsoft.KeyVault locally plugin show microsoft.keyvault
Usage
locally plugin show <namespace> [flags]
Report whether this installation supports a provider or resource type.
Reports whether a resource provider namespace (Microsoft.KeyVault) or resource type (Microsoft.KeyVault/vaults) is supported, not implemented yet, or available to install from the catalog. Works while Locally is stopped. Matching is case-insensitive. Examples: locally plugin supports Microsoft.KeyVault/vaults locally plugin supports microsoft.keyvault
Usage
locally plugin supports <namespace|resource type> [flags]
Uninstall a Resource Provider plugin.
Uninstall a Resource Provider plugin. Examples: locally plugin uninstall --name Microsoft.KeyVault
Usage
locally plugin uninstall [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Resource Provider namespace (e.g. Microsoft.KeyVault) |
Update installed Resource Provider plugins.
Check for updates and download new versions of all installed plugins. A running 'locally build' keeps using the plugin it already launched. For the new version to take effect, reload the plugin from the Dashboard's plugins page (Settings > Plugins > Reload), or restart 'locally build'. Examples: locally plugin update locally plugin update --name Microsoft.KeyVault
Usage
locally plugin update [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --all | Update all installed providers (the default when no flag is given) | |
| --name | string | Update only this Resource Provider namespace (e.g. Microsoft.KeyVault) |
Interact with PostgreSQL Flexible Servers within Locally.
Usage
locally postgres [flags] locally postgres [command]
Subcommands
Print the connection string for a PostgreSQL Flexible Server.
Print the connection string for a PostgreSQL Flexible Server. Examples: locally postgres connection-string --server my-server
Usage
locally postgres connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| -g, --resource-group | string | Resource group the server is in (disambiguates a name that exists in more than one) |
| --server | string | Name (or full resource ID) of the PostgreSQL flexible server |
Interact with Redis Caches within Locally.
Usage
locally redis [flags] locally redis [command]
Subcommands
Print the connection string for a Redis Cache.
Print the connection string for a Redis Cache. Examples: locally redis connection-string --name my-cache
Usage
locally redis connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name (or full resource ID) of the Redis cache |
| -g, --resource-group | string | Resource group the cache is in (disambiguates a name that exists in more than one) |
Refresh this installation's Locally licence.
Locally refreshes your licence automatically as needed. Run this to refresh it now, for example before you go offline for an extended period.
Usage
locally refresh [flags]
Refresh Locally's reference-data override files from real Azure via the Azure CLI.
Updates the reference data Locally reads at launch (VM images, VM SKUs, VM extension types, and function and web app stacks) from real Azure, using your signed-in Azure CLI. Refreshes all five datasets unless you name one. Images, VM SKUs and extension types are per-region: pass --location, or choose interactively. Examples: locally refresh-reference-data # all five, pick regions interactively locally refresh-reference-data images -l westeurope,eastus --yes locally refresh-reference-data vmSkus --location westeurope --yes
Usage
locally refresh-reference-data [dataset] [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| -l, --location | strings | Azure region(s) to pull region-scoped data from (repeatable or comma-separated, e.g. -l westeurope,eastus). Prompts interactively if omitted. |
| -y, --yes | Skip the per-dataset write confirmation (required for non-interactive runs) |
List Azure regions known to Locally.
Usage
locally regions [flags] locally regions [command]
Subcommands
List all known Azure regions.
Usage
locally regions list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --json | Output regions as JSON |
Print a random region's identifier, such as london.
Print a random region's identifier, such as london. Examples: locally regions random locally deploy --location $(locally regions random) ./template.json
Usage
locally regions random [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --json | Output the picked region as a JSON object |
Report the active location set for this Locally installation.
Reports which location set this installation uses and how many regions it has. Warns when the set uses a real Azure cloud's region names, because a deployment sent to Azure instead of Locally, or the other way round, will no longer fail on an unknown location.
Usage
locally regions status [flags]
Run a tool against Locally using Automatic Configuration (az, terraform, pulumi, curl, ...).
Runs a command against Locally instead of Azure. The command must support Automatic Configuration: reading its credentials and endpoints from environment variables, as az, Terraform, OpenTofu, Pulumi and the Azure SDKs do. Locally flags (must appear BEFORE the command): --subscription <name|uuid> run against a specific Subscription --tenant <name|uuid> run against a specific Tenant --user <upn|uuid> run as a directory user --service-principal <uuid|name> run as a specific service principal --managed-identity <uuid|name> run as a managed identity --allow-no-subscriptions run in a Tenant that has no Subscriptions --allow-remote-backend run Terraform/OpenTofu without confirming its remote backend Examples: locally run az group list locally run terraform apply locally run tofu apply locally run pulumi up ---- # Target another Subscription locally run --subscription "Second Subscription" az group list ---- # Run as a directory user (delegated token; password never touches the environment) locally run --user [email protected] az account show # Run as a service principal (by appId or display name) locally run --service-principal billing-runner terraform plan # Run as a managed identity (by client id or display name; no secret touches the environment) locally run --managed-identity deploy-mi terraform apply
Usage
locally run [flags]
Manage Locally Runbooks.
List and deploy the Locally Runbooks shared with your team.
Usage
locally runbooks [flags] locally runbooks [command]
Subcommands
List and execute team data scripts.
Usage
locally runbooks datascripts [flags] locally runbooks datascripts [command]
Subcommands
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
| Flag | Type | Description |
|---|---|---|
| --subscription | string | Subscription UUID to execute against (defaults to the primary subscription). |
List all synced data scripts.
Usage
locally runbooks datascripts list [flags]
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]
List and provision team directory objects (users, groups, applications, service principals).
Usage
locally runbooks directory [flags] locally runbooks directory [command]
Subcommands
List all synced directory objects.
Usage
locally runbooks directory list [flags]
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]
List all synced runbooks.
Usage
locally runbooks list [flags]
Interact with Service Bus Namespaces within Locally.
Usage
locally servicebus [flags] locally servicebus [command]
Subcommands
Print a Service Bus Namespace, its queues and its topics as JSON.
Print a Service Bus Namespace, its queues and its topics as JSON. Examples: locally servicebus automation --namespace ns1
Usage
locally servicebus automation [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Service Bus namespace |
Print the primary connection string for a Service Bus Namespace.
Prints the connection string the messaging clients use to send and receive over AMQP.
Pass --management for the string ServiceBusAdministrationClient takes, to create queues, topics, subscriptions and rules from code. It includes the Namespace's port; the messaging string can't, as a port there breaks the Go AMQP client's TLS handshake.
Java's administration client builder drops the port, so in Java use .credential("<namespace>.servicebus.locally:<port>", credential) instead of .connectionString(...).
az servicebus, Terraform and locally servicebus go through ARM and don't need either string.
Examples:
locally servicebus connection-string --namespace ns1
locally servicebus connection-string --namespace ns1 --management
Usage
locally servicebus connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --management | Print the management connection string, for the administration clients | |
| --namespace | string | Name of the Service Bus namespace |
Open the Data Plane Emulator UI for a Service Bus Namespace in your browser.
Open the Data Plane Emulator UI for a Service Bus Namespace in your browser. Examples: locally servicebus dashboard --namespace ns1
Usage
locally servicebus dashboard [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Service Bus namespace |
Manage Queues in a Service Bus Namespace within Locally.
Usage
locally servicebus queue [flags] locally servicebus queue [command]
Subcommands
Create a Queue in a Service Bus Namespace.
Create a Queue in a Service Bus Namespace. Examples: locally servicebus queue create --namespace ns1 --name orders --max-delivery-count 5 --lock-duration 30s
Usage
locally servicebus queue create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dead-letter-on-expiry | Dead-letter messages when they expire | |
| --default-message-ttl | duration | Default message time-to-live (defaults to unlimited, as in Azure) |
| --lock-duration | duration | Message lock duration (default 1m0s) |
| --max-delivery-count | int | Maximum delivery count before dead-lettering (default 10) |
| --max-size-mb | int | Maximum queue size in megabytes (default 1024) |
| --name | string | Name of the queue |
| --namespace | string | Name of the Service Bus namespace |
Delete a Queue from a Service Bus Namespace.
Delete a Queue from a Service Bus Namespace. Examples: locally servicebus queue delete --namespace ns1 --name orders
Usage
locally servicebus queue delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the queue |
| --namespace | string | Name of the Service Bus namespace |
List Queues in a Service Bus Namespace.
List Queues in a Service Bus Namespace. Examples: locally servicebus queue list --namespace ns1
Usage
locally servicebus queue list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Service Bus namespace |
Peek at messages in a Queue without consuming them.
Peek at messages in a Queue without consuming them. Examples: locally servicebus queue peek --namespace ns1 --name orders --limit 5 locally servicebus queue peek --namespace ns1 --name orders --dead-letter
Usage
locally servicebus queue peek [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dead-letter | Peek dead-lettered messages instead of active ones | |
| --limit | int | Maximum number of messages to peek (max 100) (default 10) |
| --name | string | Name of the queue |
| --namespace | string | Name of the Service Bus namespace |
Send a message to a Queue.
Send a message to a Queue.
Examples:
locally servicebus queue send --namespace ns1 --name orders --body '{"id": 1}' --content-type application/json
locally servicebus queue send --namespace ns1 --name orders --body-file ./msg.json --dead-letter --dead-letter-reason Poison
Usage
locally servicebus queue send [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --body | string | Inline message body |
| --body-file | string | Path to a file containing the message body |
| --content-type | string | Content-Type of the message body |
| --count | int | Number of copies of the message to send (default 1) |
| --dead-letter | Seed the message directly into the dead-letter sub-queue | |
| --dead-letter-description | string | Dead-letter description (requires --dead-letter) |
| --dead-letter-reason | string | Dead-letter reason (requires --dead-letter) |
| --name | string | Name of the queue |
| --namespace | string | Name of the Service Bus namespace |
| --property | stringArray | Custom message property as key=value (repeatable) |
| --session-id | string | Session ID for session-enabled entities |
Show details for a Queue in a Service Bus Namespace.
Show details for a Queue in a Service Bus Namespace. Examples: locally servicebus queue show --namespace ns1 --name orders
Usage
locally servicebus queue show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the queue |
| --namespace | string | Name of the Service Bus namespace |
Manage Topics in a Service Bus Namespace within Locally.
Usage
locally servicebus topic [flags] locally servicebus topic [command]
Subcommands
Create a Topic in a Service Bus Namespace.
Create a Topic in a Service Bus Namespace. Examples: locally servicebus topic create --namespace ns1 --name events --max-size-mb 2048
Usage
locally servicebus topic create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --default-message-ttl | duration | Default message time-to-live (defaults to unlimited, as in Azure) |
| --max-size-mb | int | Maximum topic size in megabytes (default 1024) |
| --name | string | Name of the topic |
| --namespace | string | Name of the Service Bus namespace |
Delete a Topic from a Service Bus Namespace.
Delete a Topic from a Service Bus Namespace. Examples: locally servicebus topic delete --namespace ns1 --name events
Usage
locally servicebus topic delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the topic |
| --namespace | string | Name of the Service Bus namespace |
List Topics in a Service Bus Namespace.
List Topics in a Service Bus Namespace. Examples: locally servicebus topic list --namespace ns1
Usage
locally servicebus topic list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --namespace | string | Name of the Service Bus namespace |
Peek at messages in a Topic subscription without consuming them.
Peek at messages in a Topic subscription without consuming them. Examples: locally servicebus topic peek --namespace ns1 --name events --subscription audit --limit 5
Usage
locally servicebus topic peek [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --dead-letter | Peek dead-lettered messages instead of active ones | |
| --limit | int | Maximum number of messages to peek (max 100) (default 10) |
| --name | string | Name of the topic |
| --namespace | string | Name of the Service Bus namespace |
| --subscription | string | Name of the subscription to peek |
Send a message to a Topic.
Send a message to a Topic.
Examples:
locally servicebus topic send --namespace ns1 --name events --body '{"id": 1}' --session-id customer-42
Usage
locally servicebus topic send [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --body | string | Inline message body |
| --body-file | string | Path to a file containing the message body |
| --content-type | string | Content-Type of the message body |
| --count | int | Number of copies of the message to send (default 1) |
| --name | string | Name of the topic |
| --namespace | string | Name of the Service Bus namespace |
| --property | stringArray | Custom message property as key=value (repeatable) |
| --session-id | string | Session ID for session-enabled entities |
Show details for a Topic in a Service Bus Namespace.
Show details for a Topic in a Service Bus Namespace. Examples: locally servicebus topic show --namespace ns1 --name events
Usage
locally servicebus topic show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --name | string | Name of the topic |
| --namespace | string | Name of the Service Bus namespace |
Set up this machine to run Locally.
Runs the first-time setup wizard in your browser. It walks you through everything this machine needs to run Locally: a trusted TLS certificate, *.locally DNS resolution, your analytics preference, signing in to a Locally Account, and installing resource provider plugins. Run it again at any time to revisit any of these steps.
Usage
locally setup [flags]
Interact with Storage Accounts within Locally.
Usage
locally storage [flags] locally storage [command]
Subcommands
Print the primary connection string for a Storage Account.
Print the primary connection string for a Storage Account. Examples: locally storage connection-string --account mystorageaccount
Usage
locally storage connection-string [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
Manage Containers in a Storage Account within Locally.
Usage
locally storage container [flags] locally storage container [command]
Subcommands
Create a Container in a Storage Account.
Create a Container in a Storage Account. Examples: locally storage container create --account mystorageaccount --name uploads
Usage
locally storage container create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the container |
Delete a Container from a Storage Account.
Delete a Container from a Storage Account. Examples: locally storage container delete --account mystorageaccount --name uploads
Usage
locally storage container delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the container |
List Containers in a Storage Account.
List Containers in a Storage Account. Examples: locally storage container list --account mystorageaccount
Usage
locally storage container list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
Show details for a Container in a Storage Account.
Show details for a Container in a Storage Account. Examples: locally storage container show --account mystorageaccount --name uploads
Usage
locally storage container show [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the container |
Open the Data Plane Emulator UI for a Storage Account in your browser.
Open the Data Plane Emulator UI for a Storage Account in your browser. Examples: locally storage dashboard --account mystorageaccount
Usage
locally storage dashboard [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
Manage Queues in a Storage Account within Locally.
Usage
locally storage queue [flags] locally storage queue [command]
Subcommands
Create a Queue in a Storage Account.
Create a Queue in a Storage Account. Examples: locally storage queue create --account mystorageaccount --name jobs
Usage
locally storage queue create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the queue |
Delete a Queue from a Storage Account.
Delete a Queue from a Storage Account. Examples: locally storage queue delete --account mystorageaccount --name jobs
Usage
locally storage queue delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the queue |
List Queues in a Storage Account.
List Queues in a Storage Account. Examples: locally storage queue list --account mystorageaccount
Usage
locally storage queue list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
Manage File Shares in a Storage Account within Locally.
Usage
locally storage share [flags] locally storage share [command]
Subcommands
Create a File Share in a Storage Account.
Create a File Share in a Storage Account. Examples: locally storage share create --account mystorageaccount --name assets
Usage
locally storage share create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the file share |
Delete a File Share from a Storage Account.
Delete a File Share from a Storage Account. Examples: locally storage share delete --account mystorageaccount --name assets
Usage
locally storage share delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the file share |
List File Shares in a Storage Account.
List File Shares in a Storage Account. Examples: locally storage share list --account mystorageaccount
Usage
locally storage share list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
Manage Tables in a Storage Account within Locally.
Usage
locally storage table [flags] locally storage table [command]
Subcommands
Create a Table in a Storage Account.
Create a Table in a Storage Account. Examples: locally storage table create --account mystorageaccount --name orders
Usage
locally storage table create [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the table |
Delete a Table from a Storage Account.
Delete a Table from a Storage Account. Examples: locally storage table delete --account mystorageaccount --name orders
Usage
locally storage table delete [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
| --name | string | Name of the table |
List Tables in a Storage Account.
List Tables in a Storage Account. Examples: locally storage table list --account mystorageaccount
Usage
locally storage table list [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --account | string | Name of the storage account |
Manage Locally subscriptions.
Usage
locally subscriptions [flags] locally subscriptions [command]
Subcommands
Show details for a subscription.
Look up a subscription by UUID, Azure subscription ID, or display name. Matching is case-insensitive.
Usage
locally subscriptions get <uuid | id | display-name> [flags]
List all subscriptions.
Lists every subscription this installation manages, with its display name, UUID, ID, and its resource-group and resource counts.
Usage
locally subscriptions list [flags]
Update this copy of Locally to the latest version.
Downloads, verifies, and installs the latest version of the Locally CLI in place. Package-manager installs (Homebrew, scoop) are directed to the matching upgrade command instead.
Usage
locally update [flags]
Flags
| Flag | Type | Description |
|---|---|---|
| --check | Check for an update and report without installing it. | |
| -y, --yes | Install the update without an interactive confirmation. |
Check that Locally is fully configured and ready to run.
Usage
locally validate [flags]
Print the version of Locally in this binary.
Locally v2026.09 on darwin_arm64 (stable) from c74caef-dirty
Sign in during Public Preview to get the Team plan free, plus an early-adopter discount when we launch. Sign in
Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.
