locally chaos functions

Preview

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

locally chaos functions

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

For more information see Chaos Engineering and Function App Emulator.

locally chaos functions

Simulate Functions (data plane) failure modes.

Simulate Functions (data plane) failure modes.

A fault command sets the fault's rate. With a scope flag (--location / --name /
--path) it adds or edits a rule instead.

These faults reach Function Apps only. Web Apps and Container Apps have their
own: 'locally chaos webapps' and 'locally chaos containerapps'.

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]

Flags

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

Subcommands

locally chaos functions 403

Answer requests with the Functions host's 403 JSON error, as when a role assignment has not replicated yet.

Answer requests with the Functions host's 403 JSON error, as when a role
assignment has not replicated yet. The function never runs.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

Examples:
locally chaos functions 403 --percentage 25
  locally chaos functions 403 --percentage 100 --location london
  locally chaos functions 403 reset --location london
  locally chaos functions 403 --percentage 100 --name my-app
  locally chaos functions 403 --percentage 100 --name my-app --path /api/

Usage

locally chaos functions 403 [flags]
  locally chaos functions 403 [command]

Flags

-h, --help[=true|false]     help for 403
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions 403 reset

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

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions 429

Answer requests with the Functions host's 429 JSON error and a Retry-After header.

Answer requests with the Functions host's 429 JSON error and a Retry-After
header. The function never runs.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

--retry-after sets the Retry-After header the fault answers with, such as 5s.
Without one the service's usual hint is sent.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions 429 --percentage 25
  locally chaos functions 429 --percentage 25 --retry-after 5s
  locally chaos functions 429 --percentage 100 --location london
  locally chaos functions 429 reset --location london
  locally chaos functions 429 --percentage 100 --name my-app
  locally chaos functions 429 --percentage 100 --name my-app --path /api/

Usage

locally chaos functions 429 [flags]
  locally chaos functions 429 [command]

Flags

-h, --help[=true|false]     help for 429
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --retry-after string    Retry-After this fault answers with, e.g. 5s or 500ms (the service's usual hint when omitted)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions 429 reset

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

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions 500

Answer requests with the Functions host's 500 JSON error.

Answer requests with the Functions host's 500 JSON error. The function never
runs.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

Examples:
locally chaos functions 500 --percentage 25
  locally chaos functions 500 --percentage 100 --location london
  locally chaos functions 500 reset --location london
  locally chaos functions 500 --percentage 100 --name my-app
  locally chaos functions 500 --percentage 100 --name my-app --path /api/

Usage

locally chaos functions 500 [flags]
  locally chaos functions 500 [command]

Flags

-h, --help[=true|false]     help for 500
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions 500 reset

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

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions 502

Answer requests with 502 Bad Gateway from the service's front end, as when it cannot reach the app behind it.

Answer requests with 502 Bad Gateway from the service's front end, as when it
cannot reach the app behind it. The app never sees the request.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

Examples:
locally chaos functions 502 --percentage 25
  locally chaos functions 502 --percentage 100 --location london
  locally chaos functions 502 reset --location london
  locally chaos functions 502 --percentage 100 --name my-app
  locally chaos functions 502 --percentage 100 --name my-app --path /api/

Usage

locally chaos functions 502 [flags]
  locally chaos functions 502 [command]

Flags

-h, --help[=true|false]     help for 502
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions 502 reset

Remove one 502 rule, or put the whole fault back to zero.

Reset the 502 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 502 reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions 504

Answer requests with 504 Gateway Timeout from the service's front end, as when the app behind it takes too long.

Answer requests with 504 Gateway Timeout from the service's front end, as when
the app behind it takes too long. The app never sees the request.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

Examples:
locally chaos functions 504 --percentage 25
  locally chaos functions 504 --percentage 100 --location london
  locally chaos functions 504 reset --location london
  locally chaos functions 504 --percentage 100 --name my-app
  locally chaos functions 504 --percentage 100 --name my-app --path /api/

Usage

locally chaos functions 504 [flags]
  locally chaos functions 504 [command]

Flags

-h, --help[=true|false]     help for 504
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions 504 reset

Remove one 504 rule, or put the whole fault back to zero.

Reset the 504 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 504 reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions cold-start

Make the app start from cold.

Make the app start from cold. Whenever it starts or restarts, requests get the
platform's warm-up 503 until the rolled window closes.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--seconds and --millis set the duration. A bare number is in the flag's unit;
one with its own suffix, such as 250ms or 1.5s, means what it says. One value N
picks 0 to N each time; MIN-MAX, such as 30-120, picks within that range. A
duration is required whenever the fault fires.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions cold-start --percentage 25 --seconds 30-120
  locally chaos functions cold-start --percentage 100 --seconds 30-120 --location london
  locally chaos functions cold-start reset --location london
  locally chaos functions cold-start --percentage 100 --seconds 30-120 --name acct1

Usage

locally chaos functions cold-start [flags]
  locally chaos functions cold-start [command]

Flags

-h, --help[=true|false]     help for cold-start
      --location string       Scope this rule to one location, e.g. london
      --millis string         Duration in milliseconds, e.g. 250; N for 0 to N, or MIN-MAX for a range
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --seconds string        Duration in seconds, e.g. 30 or 1.5; N for 0 to N, or MIN-MAX for a range
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions cold-start reset

Remove one cold-start rule, or put the whole fault back to zero.

Reset the cold-start 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 cold-start reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions delivery-delay

Hold messages, events or triggers for the rolled duration before delivering them.

Hold messages, events or triggers for the rolled duration before delivering
them.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--seconds and --millis set the duration. A bare number is in the flag's unit;
one with its own suffix, such as 250ms or 1.5s, means what it says. One value N
picks 0 to N each time; MIN-MAX, such as 30-120, picks within that range. A
duration is required whenever the fault fires.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions delivery-delay --percentage 25 --seconds 30-120
  locally chaos functions delivery-delay --percentage 100 --seconds 30-120 --location london
  locally chaos functions delivery-delay reset --location london
  locally chaos functions delivery-delay --percentage 100 --seconds 30-120 --name acct1

Usage

locally chaos functions delivery-delay [flags]
  locally chaos functions delivery-delay [command]

Flags

-h, --help[=true|false]     help for delivery-delay
      --location string       Scope this rule to one location, e.g. london
      --millis string         Duration in milliseconds, e.g. 250; N for 0 to N, or MIN-MAX for a range
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --seconds string        Duration in seconds, e.g. 30 or 1.5; N for 0 to N, or MIN-MAX for a range
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions delivery-delay reset

Remove one delivery-delay rule, or put the whole fault back to zero.

Reset the delivery-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 functions delivery-delay reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions delivery-drop

Deliver nothing for some messages, events or triggers.

Deliver nothing for some messages, events or triggers. Event Grid push treats it
as an endpoint failure and retries until the event is dead-lettered.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

Examples:
locally chaos functions delivery-drop --percentage 25
  locally chaos functions delivery-drop --percentage 100 --location london
  locally chaos functions delivery-drop reset --location london
  locally chaos functions delivery-drop --percentage 100 --name acct1

Usage

locally chaos functions delivery-drop [flags]
  locally chaos functions delivery-drop [command]

Flags

-h, --help[=true|false]     help for delivery-drop
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions delivery-drop reset

Remove one delivery-drop rule, or put the whole fault back to zero.

Reset the delivery-drop 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 delivery-drop reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions drop-connection

Close the connection without answering.

Close the connection without answering. The client sees the connection reset,
with no status code or error body; over HTTP/2, where one request cannot cut a
shared connection, it gets the front end's 503 instead.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

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
  locally chaos functions drop-connection --percentage 100 --name my-app
  locally chaos functions drop-connection --percentage 100 --name my-app --path /api/

Usage

locally chaos functions drop-connection [flags]
  locally chaos functions drop-connection [command]

Flags

-h, --help[=true|false]     help for drop-connection
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions drop-connection reset

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

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions duplicate-delivery

Deliver some messages, events or triggers twice.

Deliver some messages, events or triggers twice.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

Examples:
locally chaos functions duplicate-delivery --percentage 25
  locally chaos functions duplicate-delivery --percentage 100 --location london
  locally chaos functions duplicate-delivery reset --location london
  locally chaos functions duplicate-delivery --percentage 100 --name acct1

Usage

locally chaos functions duplicate-delivery [flags]
  locally chaos functions duplicate-delivery [command]

Flags

-h, --help[=true|false]     help for duplicate-delivery
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions duplicate-delivery reset

Remove one duplicate-delivery rule, or put the whole fault back to zero.

Reset the duplicate-delivery 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 duplicate-delivery reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions exit

Kill the app on a schedule, as a crash would.

Kill the app on a schedule, as a crash would. Every interval each app is rolled
for; on a hit its containers (a Function App's worker process) are killed, and
the platform starts it again.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--interval is how often the fault starts, such as 10m. It is required whenever
the fault fires: nothing else sets it off.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions exit --percentage 25 --interval 10m
  locally chaos functions exit --percentage 100 --interval 10m --location london
  locally chaos functions exit reset --location london
  locally chaos functions exit --percentage 100 --interval 10m --name acct1

Usage

locally chaos functions exit [flags]
  locally chaos functions exit [command]

Flags

-h, --help[=true|false]     help for exit
      --interval string       How often this fault rolls for each resource, e.g. 10m; the first roll lands at a random point within the first interval (required when it fires)
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions exit reset

Remove one exit rule, or put the whole fault back to zero.

Reset the exit 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 exit reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions freeze

Pause the app on a schedule.

Pause the app on a schedule. Every interval each app is rolled for; on a hit its
containers (a Function App's worker process) are paused for the rolled duration,
then resume where they were. Nothing is closed: requests and WebSockets to it
just go quiet until it resumes.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--seconds and --millis set the duration. A bare number is in the flag's unit;
one with its own suffix, such as 250ms or 1.5s, means what it says. One value N
picks 0 to N each time; MIN-MAX, such as 30-120, picks within that range. A
duration is required whenever the fault fires.

--interval is how often the fault starts, such as 10m. It is required whenever
the fault fires: nothing else sets it off.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions freeze --percentage 25 --seconds 30-120 --interval 10m
  locally chaos functions freeze --percentage 100 --seconds 30-120 --interval 10m --location london
  locally chaos functions freeze reset --location london
  locally chaos functions freeze --percentage 100 --seconds 30-120 --interval 10m --name acct1

Usage

locally chaos functions freeze [flags]
  locally chaos functions freeze [command]

Flags

-h, --help[=true|false]     help for freeze
      --interval string       How often this fault rolls for each resource, e.g. 10m; the first roll lands at a random point within the first interval (required when it fires)
      --location string       Scope this rule to one location, e.g. london
      --millis string         Duration in milliseconds, e.g. 250; N for 0 to N, or MIN-MAX for a range
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --seconds string        Duration in seconds, e.g. 30 or 1.5; N for 0 to N, or MIN-MAX for a range
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions freeze reset

Remove one freeze rule, or put the whole fault back to zero.

Reset the freeze 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 freeze reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions latency

Hold requests for a random delay before the function runs.

Hold requests for a random delay before the function runs. The response is
unchanged, just late.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

--seconds and --millis set the duration. A bare number is in the flag's unit;
one with its own suffix, such as 250ms or 1.5s, means what it says. The value is
a maximum: each firing picks 0 to N. A duration is required whenever the fault
fires.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

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
  locally chaos functions latency --percentage 100 --seconds 30 --name my-app
  locally chaos functions latency --percentage 100 --seconds 30 --name my-app --path /api/

Usage

locally chaos functions latency [flags]
  locally chaos functions latency [command]

Flags

-h, --help[=true|false]     help for latency
      --location string       Scope this rule to one location, e.g. london
      --millis string         Duration in milliseconds, e.g. 250; the maximum: each firing picks 0 to N
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --seconds string        Duration in seconds, e.g. 30 or 1.5; the maximum: each firing picks 0 to N
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions latency reset

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

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions outage

Fail requests outright with the Functions host's 503 "Function host is not running.".

Fail requests outright with the Functions host's 503 "Function host is not
running.". The app never sees them.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

--retry-after sets the Retry-After header the fault answers with, such as 5s.
Without one the service's usual hint is sent.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions outage --percentage 25
  locally chaos functions outage --percentage 25 --retry-after 5s
  locally chaos functions outage --percentage 100 --location london
  locally chaos functions outage reset --location london
  locally chaos functions outage --percentage 100 --name my-app
  locally chaos functions outage --percentage 100 --name my-app --path /api/

Usage

locally chaos functions outage [flags]
  locally chaos functions outage [command]

Flags

-h, --help[=true|false]     help for outage
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --retry-after string    Retry-After this fault answers with, e.g. 5s or 500ms (the service's usual hint when omitted)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions outage reset

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

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions partial-response

Send the status, headers and part of the body, then cut the connection.

Send the status, headers and part of the body, then cut the connection. The
client sees a response that ends early.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

Examples:
locally chaos functions partial-response --percentage 25
  locally chaos functions partial-response --percentage 100 --location london
  locally chaos functions partial-response reset --location london
  locally chaos functions partial-response --percentage 100 --name my-app
  locally chaos functions partial-response --percentage 100 --name my-app --path /api/

Usage

locally chaos functions partial-response [flags]
  locally chaos functions partial-response [command]

Flags

-h, --help[=true|false]     help for partial-response
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions partial-response reset

Remove one partial-response rule, or put the whole fault back to zero.

Reset the partial-response 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 partial-response reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions reset

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

-h, --help[=true|false]     help for reset
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions restart

Restart the app on a schedule.

Restart the app on a schedule. Every interval each app is rolled for; on a hit
it restarts the way its Restart action does, dropping its connections.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--interval is how often the fault starts, such as 10m. It is required whenever
the fault fires: nothing else sets it off.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions restart --percentage 25 --interval 10m
  locally chaos functions restart --percentage 100 --interval 10m --location london
  locally chaos functions restart reset --location london
  locally chaos functions restart --percentage 100 --interval 10m --name acct1

Usage

locally chaos functions restart [flags]
  locally chaos functions restart [command]

Flags

-h, --help[=true|false]     help for restart
      --interval string       How often this fault rolls for each resource, e.g. 10m; the first roll lands at a random point within the first interval (required when it fires)
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions restart reset

Remove one restart rule, or put the whole fault back to zero.

Reset the restart 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 restart reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions show

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

-h, --help[=true|false]     help for show
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos functions slow-body

Slow the response body down.

Slow the response body down. The status and headers arrive as usual, then the
body is written with a pause before every write.

Without scope flags this sets the fault's rate on Functions (data plane). With
--location / --name / --path 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.

--name acct1 matches that resource in any resource group; --name rg1/acct1
matches only rg1's.

--path narrows it to requests whose path starts with the value, such as /api/;
it is a plain, case-sensitive prefix, so /api also matches /apis. They combine
with --name and --location on one rule, and a rule naming an app outranks one
naming only traffic or a path - so to spare one app's path, put both on the same
rule.

--seconds and --millis set the duration. A bare number is in the flag's unit;
one with its own suffix, such as 250ms or 1.5s, means what it says. One value N
picks 0 to N each time; MIN-MAX, such as 30-120, picks within that range. A
duration is required whenever the fault fires.

A value flag left out keeps what the row already has; a new rule starts with
none. 'reset' clears a row.

Examples:
locally chaos functions slow-body --percentage 25 --millis 100-800
  locally chaos functions slow-body --percentage 100 --millis 100-800 --location london
  locally chaos functions slow-body reset --location london
  locally chaos functions slow-body --percentage 100 --millis 100-800 --name my-app
  locally chaos functions slow-body --percentage 100 --millis 100-800 --name my-app --path /api/

Usage

locally chaos functions slow-body [flags]
  locally chaos functions slow-body [command]

Flags

-h, --help[=true|false]     help for slow-body
      --location string       Scope this rule to one location, e.g. london
      --millis string         Duration in milliseconds, e.g. 250; N for 0 to N, or MIN-MAX for a range
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --percentage int        How often this fault fires, 0-100 (required)
      --seconds string        Duration in seconds, e.g. 30 or 1.5; N for 0 to N, or MIN-MAX for a range
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos functions slow-body reset

Remove one slow-body rule, or put the whole fault back to zero.

Reset the slow-body 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 slow-body reset [flags]

Flags

-h, --help[=true|false]     help for reset
      --location string       Scope this rule to one location, e.g. london
      --name string           Scope this rule to one resource by name, e.g. acct1, or rg1/acct1 for one resource group's
      --path string           Scope this rule to requests whose path starts with this, e.g. /api/
      --subscription string   Subscription UUID (defaults to the configured default)
Preview

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

A local cloud for you and your AI agents.

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