Microsoft Azure Chaos API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Chaos API
tags:
- name: Chaos
paths:
  /Tools/Chaos:
    get:
      operationId: microsoftAzureGetchaos
      summary: Microsoft Azure Get The Status Of Chaos
      description: Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-2_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Chaos
      responses:
        '200':
          description: A successful operation will return 200 status code and the status of Chaos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chaos'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /Tools/Chaos/$/Start:
    post:
      operationId: microsoftAzureStartchaos
      summary: Microsoft Azure Starts Chaos In The Cluster
      description: If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.<br>If Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.<br>Refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details.
      tags:
      - Chaos
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ChaosParametersRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /Tools/Chaos/$/Stop:
    post:
      operationId: microsoftAzureStopchaos
      summary: Microsoft Azure Stops Chaos If It Is Running In The Cluster And Put The Chaos Schedule In A Stopped State
      description: Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.<br>Once a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.
      tags:
      - Chaos
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /Tools/Chaos/Events:
    get:
      operationId: microsoftAzureGetchaosevents
      summary: Microsoft Azure Gets The Next Segment Of The Chaos Events Based On The Continuation Token Or The Time Range
      description: To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range<br>through StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.<br>When there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.
      x-ms-examples:
        Get Chaos events given a time range:
          $ref: ./examples/GetChaosEvents.json
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-2_RequiredQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/StartTimeUtcOptionalQueryParam'
      - $ref: '#/components/parameters/EndTimeUtcOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Chaos
      responses:
        '200':
          description: Next segment of Chaos events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChaosEventsSegment'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /Tools/Chaos/Schedule:
    get:
      operationId: microsoftAzureGetchaosschedule
      summary: Microsoft Azure Get The Chaos Schedule Defining When And How To Run Chaos
      description: Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-2_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Chaos
      responses:
        '200':
          description: A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChaosScheduleDescription'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
    post:
      operationId: microsoftAzurePostchaosschedule
      summary: Microsoft Azure Set The Schedule Used By Chaos
      description: Chaos will automatically schedule runs based on the Chaos Schedule.<br>The Chaos Schedule will be updated if the provided version matches the version on the server.<br>When updating the Chaos Schedule, the version on the server is incremented by 1.<br>The version on the server will wrap back to 0 after reaching a large number.<br>If Chaos is running when this call is made, the call will fail.
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-2_RequiredQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      - $ref: '#/components/parameters/ChaosScheduleRequiredBodyParam'
      tags:
      - Chaos
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
components:
  schemas:
    ChaosParametersDictionaryItem:
      description: Defines an item in ChaosParametersDictionary of the Chaos Schedule.
      required:
      - Key
      - Value
      properties:
        Key:
          type: string
          description: The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs.
        Value:
          $ref: '#/components/schemas/ChaosParameters'
          description: Defines all the parameters to configure a Chaos run.
    NodeType:
      type: string
      description: 'The type name of a Service Fabric node.

        Refer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-nodetypes) for more details.'
    ChaosEventWrapper:
      description: Wrapper object for Chaos event.
      properties:
        ChaosEvent:
          $ref: '#/components/schemas/ChaosEvent'
          description: Represents an event generated during a Chaos run.
    ChaosContextMap:
      additionalProperties:
        type: string
      description: Describes a map that contains a collection of ChaosContextMapItem's.
    FabricErrorCodes:
      type: string
      description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
      enum:
      - FABRIC_E_INVALID_PARTITION_KEY
      - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
      - FABRIC_E_INVALID_ADDRESS
      - FABRIC_E_APPLICATION_NOT_UPGRADING
      - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
      - FABRIC_E_FABRIC_NOT_UPGRADING
      - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
      - FABRIC_E_INVALID_CONFIGURATION
      - FABRIC_E_INVALID_NAME_URI
      - FABRIC_E_PATH_TOO_LONG
      - FABRIC_E_KEY_TOO_LARGE
      - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
      - FABRIC_E_INVALID_ATOMIC_GROUP
      - FABRIC_E_VALUE_EMPTY
      - FABRIC_E_NODE_NOT_FOUND
      - FABRIC_E_APPLICATION_TYPE_NOT_FOUND
      - FABRIC_E_APPLICATION_NOT_FOUND
      - FABRIC_E_SERVICE_TYPE_NOT_FOUND
      - FABRIC_E_SERVICE_DOES_NOT_EXIST
      - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
      - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
      - FABRIC_E_PARTITION_NOT_FOUND
      - FABRIC_E_REPLICA_DOES_NOT_EXIST
      - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
      - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
      - FABRIC_E_DIRECTORY_NOT_FOUND
      - FABRIC_E_FABRIC_VERSION_NOT_FOUND
      - FABRIC_E_FILE_NOT_FOUND
      - FABRIC_E_NAME_DOES_NOT_EXIST
      - FABRIC_E_PROPERTY_DOES_NOT_EXIST
      - FABRIC_E_ENUMERATION_COMPLETED
      - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
      - FABRIC_E_KEY_NOT_FOUND
      - FABRIC_E_HEALTH_ENTITY_NOT_FOUND
      - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
      - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
      - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
      - FABRIC_E_SERVICE_ALREADY_EXISTS
      - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_TYPE_IN_USE
      - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
      - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
      - FABRIC_E_FABRIC_VERSION_IN_USE
      - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
      - FABRIC_E_NAME_ALREADY_EXISTS
      - FABRIC_E_NAME_NOT_EMPTY
      - FABRIC_E_PROPERTY_CHECK_FAILED
      - FABRIC_E_SERVICE_METADATA_MISMATCH
      - FABRIC_E_SERVICE_TYPE_MISMATCH
      - FABRIC_E_HEALTH_STALE_REPORT
      - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
      - FABRIC_E_NODE_HAS_NOT_STOPPED_YET
      - FABRIC_E_INSTANCE_ID_MISMATCH
      - FABRIC_E_VALUE_TOO_LARGE
      - FABRIC_E_NO_WRITE_QUORUM
      - FABRIC_E_NOT_PRIMARY
      - FABRIC_E_NOT_READY
      - FABRIC_E_RECONFIGURATION_PENDING
      - FABRIC_E_SERVICE_OFFLINE
      - E_ABORT
      - FABRIC_E_COMMUNICATION_ERROR
      - FABRIC_E_OPERATION_NOT_COMPLETE
      - FABRIC_E_TIMEOUT
      - FABRIC_E_NODE_IS_UP
      - E_FAIL
      - FABRIC_E_BACKUP_IS_ENABLED
      - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
      - FABRIC_E_INVALID_FOR_STATELESS_SERVICES
      - FABRIC_E_BACKUP_NOT_ENABLED
      - FABRIC_E_BACKUP_POLICY_NOT_EXISTING
      - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
      - FABRIC_E_BACKUP_IN_PROGRESS
      - FABRIC_E_RESTORE_IN_PROGRESS
      - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
      - FABRIC_E_INVALID_SERVICE_SCALING_POLICY
      - E_INVALIDARG
      - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
      - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
      - FABRIC_E_VOLUME_ALREADY_EXISTS
      - FABRIC_E_VOLUME_NOT_FOUND
      - SerializationError
      - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
      x-ms-enum:
        name: FabricErrorCodes
        modelAsString: true
        values:
        - value: FABRIC_E_INVALID_PARTITION_KEY
        - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
        - value: FABRIC_E_INVALID_ADDRESS
        - value: FABRIC_E_APPLICATION_NOT_UPGRADING
        - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
        - value: FABRIC_E_FABRIC_NOT_UPGRADING
        - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
        - value: FABRIC_E_INVALID_CONFIGURATION
        - value: FABRIC_E_INVALID_NAME_URI
        - value: FABRIC_E_PATH_TOO_LONG
        - value: FABRIC_E_KEY_TOO_LARGE
        - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
        - value: FABRIC_E_INVALID_ATOMIC_GROUP
        - value: FABRIC_E_VALUE_EMPTY
        - value: FABRIC_E_NODE_NOT_FOUND
        - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
        - value: FABRIC_E_APPLICATION_NOT_FOUND
        - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
        - value: FABRIC_E_SERVICE_DOES_NOT_EXIST
        - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
        - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
        - value: FABRIC_E_PARTITION_NOT_FOUND
        - value: FABRIC_E_REPLICA_DOES_NOT_EXIST
        - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
        - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
        - value: FABRIC_E_DIRECTORY_NOT_FOUND
        - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
        - value: FABRIC_E_FILE_NOT_FOUND
        - value: FABRIC_E_NAME_DOES_NOT_EXIST
        - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
        - value: FABRIC_E_ENUMERATION_COMPLETED
        - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
        - value: FABRIC_E_KEY_NOT_FOUND
        - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
        - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
        - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
        - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
        - value: FABRIC_E_SERVICE_ALREADY_EXISTS
        - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_TYPE_IN_USE
        - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
        - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
        - value: FABRIC_E_FABRIC_VERSION_IN_USE
        - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
        - value: FABRIC_E_NAME_ALREADY_EXISTS
        - value: FABRIC_E_NAME_NOT_EMPTY
        - value: FABRIC_E_PROPERTY_CHECK_FAILED
        - value: FABRIC_E_SERVICE_METADATA_MISMATCH
        - value: FABRIC_E_SERVICE_TYPE_MISMATCH
        - value: FABRIC_E_HEALTH_STALE_REPORT
        - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
        - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
        - value: FABRIC_E_INSTANCE_ID_MISMATCH
        - value: FABRIC_E_VALUE_TOO_LARGE
        - value: FABRIC_E_NO_WRITE_QUORUM
        - value: FABRIC_E_NOT_PRIMARY
        - value: FABRIC_E_NOT_READY
        - value: FABRIC_E_RECONFIGURATION_PENDING
        - value: FABRIC_E_SERVICE_OFFLINE
        - value: E_ABORT
        - value: FABRIC_E_COMMUNICATION_ERROR
        - value: FABRIC_E_OPERATION_NOT_COMPLETE
        - value: FABRIC_E_TIMEOUT
        - value: FABRIC_E_NODE_IS_UP
        - value: E_FAIL
        - value: FABRIC_E_BACKUP_IS_ENABLED
        - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
        - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
        - value: FABRIC_E_BACKUP_NOT_ENABLED
        - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
        - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
        - value: FABRIC_E_BACKUP_IN_PROGRESS
        - value: FABRIC_E_RESTORE_IN_PROGRESS
        - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
        - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
        - value: E_INVALIDARG
        - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
        - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
        - value: FABRIC_E_VOLUME_ALREADY_EXISTS
        - value: FABRIC_E_VOLUME_NOT_FOUND
        - value: SerializationError
        - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
    ChaosParameters:
      description: Defines all the parameters to configure a Chaos run.
      properties:
        TimeToRunInSeconds:
          type: string
          description: Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).
          default: '4294967295'
        MaxClusterStabilizationTimeoutInSeconds:
          type: integer
          format: int64
          description: 'The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.

            During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.'
          default: 60
          minimum: 0
          maximum: 4294967295
        MaxConcurrentFaults:
          type: integer
          format: int64
          description: 'MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.

            Chaos executes in iterations and two consecutive iterations are separated by a validation phase.

            The higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs.

            The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.'
          default: 1
          minimum: 0
          maximum: 4294967295
        EnableMoveReplicaFaults:
          type: boolean
          description: Enables or disables the move primary and move secondary faults.
          default: true
        WaitTimeBetweenFaultsInSeconds:
          type: integer
          format: int64
          description: 'Wait time (in seconds) between consecutive faults within a single iteration.

            The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.

            The recommendation is to start with a value between 1 and 5 and exercise caution while moving up.'
          default: 20
          minimum: 0
          maximum: 4294967295
        WaitTimeBetweenIterationsInSeconds:
          type: integer
          format: int64
          description: 'Time-separation (in seconds) between two consecutive iterations of Chaos.

            The larger the value, the lower the fault injection rate.'
          default: 30
          minimum: 0
          maximum: 4294967295
        ClusterHealthPolicy:
          $ref: '#/components/schemas/ClusterHealthPolicy'
          description: Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check.
        Context:
          $ref: '#/components/schemas/ChaosContext'
          description: 'Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about

            the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.

            This map is set by the starter of the Chaos run to optionally store the context about the specific run.'
        ChaosTargetFilter:
          $ref: '#/components/schemas/ChaosTargetFilter'
          description: 'List of cluster entities to target for Chaos faults.

            This filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.

            If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification.'
    ClusterHealthPolicy:
      description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
      properties:
        ConsiderWarningAsError:
          type: boolean
          description: Indicates whether warnings are treated with the same severity as errors.
          default: false
        MaxPercentUnhealthyNodes:
          type: integer
          description: 'The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.


            The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.

            If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.

            The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.

            The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.


            In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.'
          default: 0
        MaxPercentUnhealthyApplications:
          type: integer
          description: 'The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.


            The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.

            If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.

            This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.

            The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.'
          default: 0
        ApplicationTypeHealthPolicyMap:
          $ref: '#/components/schemas/ApplicationTypeHealthPolicyMap'
          description: 'Defines a map with max percentage unhealthy applications for specific application types.

            Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.


            The application type health policy map can be used during cluster health evaluation to describe special application types.

            The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.

            The applications of application types specified in the map are not counted against the global pool of applications.

            For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type

            and assign it a value of 0% (that is, do not tolerate any failures).

            All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.

            The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.'
        NodeTypeHealthPolicyMap:
          $ref: '#/components/schemas/NodeTypeHealthPolicyMap'
          description: "Defines a map with max percentage unhealthy nodes for specific node types.\nEach entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type.\n\nThe node type health policy map can be used during cluster health evaluation to describe special node types. \nThey are evaluated against the percentages associated with their node type name in the map. \nSetting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. \nThe node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation.\n\nFor example, given a cluster with many nodes of different types, with important work hosted on node type \"SpecialNodeType\" that should not tolerate any nodes down. \nYou can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type \"SpecialNodeType\", set the MaxPercentUnhealthyNodes to 0 by \nsetting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. \nThis way, as long as no nodes of type \"SpecialNodeType\" are in Error state, \neven if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. \nA Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. \nBut even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. \n\nConversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, \nwith one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case."
    NodeTypeHealthPolicyMap:
      type: array
      items:
        $ref: '#/components/schemas/NodeTypeHealthPolicyMapItem'
      description: "Defines a map with max percentage unhealthy nodes for specific node types.\nEach entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type.\n\nThe node type health policy map can be used during cluster health evaluation to describe special node types. \nThey are evaluated against the percentages associated with their node type name in the map. \nSetting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. \nThe node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation.\n\nFor example, given a cluster with many nodes of different types, with important work hosted on node type \"SpecialNodeType\" that should not tolerate any nodes down. \nYou can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type \"SpecialNodeType\", set the MaxPercentUnhealthyNodes to 0 by \nsetting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. \nThis way, as long as no nodes of type \"SpecialNodeType\" are in Error state, \neven if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. \nA Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. \nBut even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. \n\nConversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, \nwith one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case."
    Chaos:
      description: Contains a description of Chaos.
      properties:
        ChaosParameters:
          $ref: '#/components/schemas/ChaosParameters'
          description: If Chaos is running

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-chaos-api-openapi.yml