probeMachine

describe_machines

Describe Azure virtual machines

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosazure.machine.probes
Namedescribe_machines
ReturnNone

Usage

JSON

{
  "name": "describe-machines",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosazure.machine.probes",
    "func": "describe_machines"
  }
}

YAML

name: describe-machines
provider:
  func: describe_machines
  module: chaosazure.machine.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
filterstringnullNoFilterTarget filter selector

If the filter is omitted all machines in the subscription will be selected as potential chaos candidates.

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

Signature

def describe_machines(filter: str = None,
                      configuration: Dict[str, Dict[str, str]] = None,
                      secrets: Dict[str, Dict[str, str]] = None):
    pass