locally chaos keyvault

Preview

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

locally chaos keyvault

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

For more information see Chaos Engineering and Key Vault Emulator.

locally chaos keyvault

Simulate Key Vault (data plane) failure modes.

Simulate Key Vault (data plane) failure modes.

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

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]

Flags

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

Subcommands

locally chaos keyvault 403

Answer requests with 403, as when a role assignment has not replicated yet.

Answer requests with 403, as when a role assignment has not replicated yet. On
the control plane the error code is AuthorizationFailed; on a database the
engine's own equivalent error is sent instead.

Without scope flags this sets the fault's rate on Key Vault (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 keyvault 403 --percentage 25
  locally chaos keyvault 403 --percentage 100 --location london
  locally chaos keyvault 403 reset --location london
  locally chaos keyvault 403 --percentage 100 --name acct1

Usage

locally chaos keyvault 403 [flags]
  locally chaos keyvault 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
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos keyvault 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 keyvault 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
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos keyvault 429

Answer requests with 429 Too Many Requests and a retry hint.

Answer requests with 429 Too Many Requests and a retry hint. On a database the
engine's own throttling error is sent instead.

Without scope flags this sets the fault's rate on Key Vault (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.

--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 keyvault 429 --percentage 25
  locally chaos keyvault 429 --percentage 25 --retry-after 5s
  locally chaos keyvault 429 --percentage 100 --location london
  locally chaos keyvault 429 reset --location london
  locally chaos keyvault 429 --percentage 100 --name acct1

Usage

locally chaos keyvault 429 [flags]
  locally chaos keyvault 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
      --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 keyvault 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 keyvault 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
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos keyvault 500

Answer requests with 500 Internal Server Error.

Answer requests with 500 Internal Server Error. On a database the engine's own
equivalent error is sent instead.

Without scope flags this sets the fault's rate on Key Vault (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 keyvault 500 --percentage 25
  locally chaos keyvault 500 --percentage 100 --location london
  locally chaos keyvault 500 reset --location london
  locally chaos keyvault 500 --percentage 100 --name acct1

Usage

locally chaos keyvault 500 [flags]
  locally chaos keyvault 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
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos keyvault 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 keyvault 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
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos keyvault 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.

Without scope flags this sets the fault's rate on Key Vault (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 keyvault drop-connection --percentage 25
  locally chaos keyvault drop-connection --percentage 100 --location london
  locally chaos keyvault drop-connection reset --location london
  locally chaos keyvault drop-connection --percentage 100 --name acct1

Usage

locally chaos keyvault drop-connection [flags]
  locally chaos keyvault 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
      --percentage int        How often this fault fires, 0-100 (required)
      --subscription string   Subscription UUID (defaults to the configured default)

Subcommands

locally chaos keyvault 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 keyvault 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
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos keyvault incident

Take each resource down for a while, then bring it back.

Take each resource down for a while, then bring it back. Every interval each
resource (or, on the directory and identity surfaces, the tenant) rolls against
the percentage; on a hit every request to it fails for the rolled duration,
answered as an outage would be, then it recovers on its own. Compare outage,
which fails requests for as long as it is armed.

Without scope flags this sets the fault's rate on Key Vault (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 keyvault incident --percentage 25 --seconds 30-120 --interval 10m
  locally chaos keyvault incident --percentage 100 --seconds 30-120 --interval 10m --location london
  locally chaos keyvault incident reset --location london
  locally chaos keyvault incident --percentage 100 --seconds 30-120 --interval 10m --name acct1

Usage

locally chaos keyvault incident [flags]
  locally chaos keyvault incident [command]

Flags

-h, --help[=true|false]     help for incident
      --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 keyvault incident reset

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

Reset the incident 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 incident 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 keyvault latency

Hold requests for a random delay before they are handled.

Hold requests for a random delay before they are handled. The response is
unchanged, just late.

Without scope flags this sets the fault's rate on Key Vault (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. 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 keyvault latency --percentage 25 --seconds 30
  locally chaos keyvault latency --percentage 100 --seconds 30 --location london
  locally chaos keyvault latency reset --location london
  locally chaos keyvault latency --percentage 100 --seconds 30 --name acct1

Usage

locally chaos keyvault latency [flags]
  locally chaos keyvault 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
      --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 keyvault 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 keyvault 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
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos keyvault object-being-deleted

Hold a deleted name for a while.

Hold a deleted name for a while. After a delete, creating or reading that name
answers 409 ObjectIsBeingDeleted until the window closes; after a recover,
ObjectIsBeingRecovered.

Without scope flags this sets the fault's rate on Key Vault (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. 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 keyvault object-being-deleted --percentage 25 --seconds 30
  locally chaos keyvault object-being-deleted --percentage 100 --seconds 30 --location london
  locally chaos keyvault object-being-deleted reset --location london
  locally chaos keyvault object-being-deleted --percentage 100 --seconds 30 --name acct1

Usage

locally chaos keyvault object-being-deleted [flags]
  locally chaos keyvault object-being-deleted [command]

Flags

-h, --help[=true|false]     help for object-being-deleted
      --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
      --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 keyvault object-being-deleted reset

Remove one object-being-deleted rule, or put the whole fault back to zero.

Reset the object-being-deleted 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 object-being-deleted 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 keyvault outage

Fail requests for as long as the rule is armed, like a region or service that is down.

Fail requests for as long as the rule is armed, like a region or service that is
down. Each request rolls against the percentage, so at 100 every request fails
until the fault is turned off. Each service answers in its own terms, usually
503 Service Unavailable, and a protocol with live connections also closes the
ones open when the outage starts. For downtime that ends by itself, see
incident.

Without scope flags this sets the fault's rate on Key Vault (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.

--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 keyvault outage --percentage 25
  locally chaos keyvault outage --percentage 25 --retry-after 5s
  locally chaos keyvault outage --percentage 100 --location london
  locally chaos keyvault outage reset --location london
  locally chaos keyvault outage --percentage 100 --name acct1

Usage

locally chaos keyvault outage [flags]
  locally chaos keyvault 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
      --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 keyvault 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 keyvault 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
      --subscription string   Subscription UUID (defaults to the configured default)

locally chaos keyvault reset

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

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

locally chaos keyvault show

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

-h, --help[=true|false]     help for show
      --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.