Azure
action VMSS

# stop_vmss

Stop a virtual machine scale set instance at random

Run it now
View details

Type | action
Module | chaosazure.vmss.actions
Name | stop_vmss
Return | None

Usage

JSON

    {
      "name": "stop-vmss",
      "type": "action",
      "provider": {
        "type": "python",
        "module": "chaosazure.vmss.actions",
        "func": "stop_vmss"
      }
    }

YAML

    name: stop-vmss
    provider:
      func: stop_vmss
      module: chaosazure.vmss.actions
      type: python
    type: action

Arguments

Name | Type | Default | Required | Title | Description
--- | --- | --- | --- | --- | ---
filter | string | null | No | Filter | Target filter selector
instance_criteria | object | null | No | Criteria | Instance criteria to apply further filtering

filter (str): Filter the virtual machine scale set. If the filter is omitted all virtual machine scale sets in the subscription will be selected as potential chaos candidates.

Filtering example: `'where resourceGroup=="myresourcegroup" and name="myresourcename"'`

instance_criteria (Iterable[Mapping[str, any]]): Allows specification of criteria for selection of a given virtual machine scale set instance. If the instance_criteria is omitted, an instance will be chosen at random. All of the criteria within each item of the Iterable must match, i.e. AND logic is applied. The first item with all matching criterion will be used to select the instance.

Criteria example:

    [
      {"name": "myVMSSInstance1"},
      {
        "name": "myVMSSInstance2",
        "instanceId": "2"
      }
      {"instanceId": "3"},
    ]

If the instances include two items. One with `name = myVMSSInstance4` and `instanceId = 2`. The other with `name = myVMSSInstance2` and `instanceId = 3`. The criteria `{"instanceId": "3"}` will be the first match since both the name and the instanceId did not match on the first criteria.

## Related starters

- Azure
  action VMSS

  ## `deallocate_vmss`

  Deallocate a virtual machine scale set instance at random
- Azure
  action VMSS

  ## `delete_vmss`

  Delete a virtual machine scale set instance at random
- Azure
  action VMSS

  ## `restart_vmss`

  Restart a virtual machine scale set instance at random