@azure/arm-chaos package

Interfaces

Action

Model that represents an Action resource.

ActionDependency

Model that represents an action dependency.

ActionProperties

Model that represents the properties of an Action resource.

ActionStatus

Model that represents the an action and its status.

ActionSupportedTargetType

Model that represents a target type supported by an action.

ActionVersion

Model that represents an Action Version resource.

ActionVersionsGetOptionalParams

Optional parameters.

ActionVersionsListOptionalParams

Optional parameters.

ActionVersionsOperations

Interface representing a ActionVersions operations.

ActionsGetOptionalParams

Optional parameters.

ActionsListOptionalParams

Optional parameters.

ActionsOperations

Interface representing a Actions operations.

BranchStatus

Model that represents the a list of actions and action statuses.

CapabilitiesCreateOrUpdateOptionalParams

Optional parameters.

CapabilitiesDeleteOptionalParams

Optional parameters.

CapabilitiesGetOptionalParams

Optional parameters.

CapabilitiesListOptionalParams

Optional parameters.

CapabilitiesOperations

Interface representing a Capabilities operations.

Capability

Model that represents a Capability resource.

CapabilityProperties

Model that represents the Capability properties model.

CapabilityType

Model that represents a Capability Type resource.

CapabilityTypeProperties

Model that represents the Capability Type properties model.

CapabilityTypePropertiesRuntimeProperties

Runtime properties of this Capability Type.

CapabilityTypesGetOptionalParams

Optional parameters.

CapabilityTypesListOptionalParams

Optional parameters.

CapabilityTypesOperations

Interface representing a CapabilityTypes operations.

ChaosExperimentAction

Model that represents the base action model. 9 total per experiment.

ChaosExperimentBranch

Model that represents a branch in the step. 9 total per experiment.

ChaosExperimentStep

Model that represents a step in the Experiment resource.

ChaosManagementClientOptionalParams

Optional parameters for the client.

ChaosTargetFilter

Model that represents available filter types that can be applied to a targets list.

ChaosTargetListSelector

Model that represents a list selector.

ChaosTargetQuerySelector

Model that represents a query selector.

ChaosTargetSelector

Model that represents a selector in the Experiment resource.

ChaosTargetSimpleFilter

Model that represents a simple target filter.

ChaosTargetSimpleFilterParameters

Model that represents the Simple filter parameters.

ConfigurationExclusions

Model that represents exclusion criteria for protecting resources from fault injection. Uses union (OR) logic - a resource is excluded if it matches ANY criteria.

ConfigurationFilters

Model that represents filter criteria for constraining which discovered resources participate in fault injection.

Uses intersection (AND) logic — a resource is included only if it matches all criteria.

ContinuousAction

Model that represents a continuous action.

CustomerDataStorageProperties

Model that represents the Customer Managed Storage for an Experiment.

DelayAction

Model that represents a delay action.

DiscoveredResource

Model that represents a discovered resource.

DiscoveredResourceProperties

Model that represents the properties of a discovered resource.

DiscoveredResourcesGetOptionalParams

Optional parameters.

DiscoveredResourcesListByWorkspaceOptionalParams

Optional parameters.

DiscoveredResourcesOperations

Interface representing a DiscoveredResources operations.

DiscreteAction

Model that represents a discrete action.

EntraIdentity

Model that represents the Azure Entra identity.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Experiment

Model that represents a Experiment resource.

ExperimentExecution

Model that represents the execution of a Experiment.

ExperimentExecutionActionTargetDetailsError

Model that represents the Experiment action target details error model.

ExperimentExecutionActionTargetDetailsProperties

Model that represents the Experiment action target details properties model.

ExperimentExecutionDetails

Model that represents the execution details of an Experiment.

ExperimentExecutionDetailsProperties

Model that represents the extended properties of an experiment execution.

ExperimentExecutionDetailsPropertiesRunInformation

The information of the experiment run.

ExperimentExecutionProperties

Model that represents the execution properties of an Experiment.

ExperimentProperties

Model that represents the Experiment properties model.

ExperimentUpdate

Describes an experiment update.

ExperimentsCancelOptionalParams

Optional parameters.

ExperimentsCreateOrUpdateOptionalParams

Optional parameters.

ExperimentsDeleteOptionalParams

Optional parameters.

ExperimentsExecutionDetailsOptionalParams

Optional parameters.

ExperimentsGetExecutionOptionalParams

Optional parameters.

ExperimentsGetOptionalParams

Optional parameters.

ExperimentsListAllExecutionsOptionalParams

Optional parameters.

ExperimentsListAllOptionalParams

Optional parameters.

ExperimentsListOptionalParams

Optional parameters.

ExperimentsOperations

Interface representing a Experiments operations.

ExperimentsStartOptionalParams

Optional parameters.

ExperimentsUpdateOptionalParams

Optional parameters.

ExternalResource

Model that represents an external resource reference.

FixResourcePermissionsRequest

Request body for fixing resource permissions.

KeyValuePair

A key-value pair used to describe parameters for actions or configurations.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for an operation.

OperationError

Represents a system or infrastructure error encountered during an async operation.

OperationStatusResult

The current status of an async operation.

OperationStatusesGetOptionalParams

Optional parameters.

OperationStatusesOperations

Interface representing a OperationStatuses operations.

OperationsListAllOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PermissionError

Model that represents the permission error.

PermissionsFix

Model that represents the fix resource permissions result.

PermissionsFixProperties

Model that represents the properties of the permission fix operation.

PermissionsFixSummary

Summary of the permission fix operation.

PhysicalToLogicalZoneMapping

Maps a physical zone to the resolved logical zone for a given subscription.

PrivateAccess

PrivateAccesses tracked resource.

PrivateAccessPatch

Describes a private access update.

PrivateAccessProperties

The properties of a private access resource

PrivateAccessesCreateOrUpdateOptionalParams

Optional parameters.

PrivateAccessesDeleteAPrivateEndpointConnectionOptionalParams

Optional parameters.

PrivateAccessesDeleteOptionalParams

Optional parameters.

PrivateAccessesGetAPrivateEndpointConnectionOptionalParams

Optional parameters.

PrivateAccessesGetOptionalParams

Optional parameters.

PrivateAccessesGetPrivateLinkResourcesOptionalParams

Optional parameters.

PrivateAccessesListAllOptionalParams

Optional parameters.

PrivateAccessesListOptionalParams

Optional parameters.

PrivateAccessesListPrivateEndpointConnectionsOptionalParams

Optional parameters.

PrivateAccessesOperations

Interface representing a PrivateAccesses operations.

PrivateAccessesUpdateOptionalParams

Optional parameters.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The private endpoint connection resource.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateLinkResource

A private link resource.

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Recommendation

Model that represents a scenario recommendation.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceStateError

Model that represents the resource state error.

RestorePollerOptions
RoleAssignmentError

Error details for a failed role assignment.

RoleAssignmentResult

Result of a single role assignment operation.

RunAfter

Model that represents action dependencies.

Scenario

Model that represents the scenario.

ScenarioAction

Model that represents a scenario action.

ScenarioConfiguration

Model that represents the scenario.

ScenarioConfigurationProperties

Model that represents the properties of the scenario configuration.

ScenarioConfigurationsCreateOrUpdateOptionalParams

Optional parameters.

ScenarioConfigurationsDeleteOptionalParams

Optional parameters.

ScenarioConfigurationsExecuteOptionalParams

Optional parameters.

ScenarioConfigurationsFixResourcePermissionsOptionalParams

Optional parameters.

ScenarioConfigurationsGetOptionalParams

Optional parameters.

ScenarioConfigurationsListAllOptionalParams

Optional parameters.

ScenarioConfigurationsOperations

Interface representing a ScenarioConfigurations operations.

ScenarioConfigurationsValidateOptionalParams

Optional parameters.

ScenarioErrors

Model that represents the scenario run errors.

ScenarioEvaluationResultItem

Model that represents a single scenario evaluation result.

ScenarioParameter

Model that represents a single scenario parameter definition.

ScenarioProperties

Model that represents the properties of the scenario.

ScenarioRun

Model that represents the scenario run.

ScenarioRunProperties

Model that represents the properties of the scenario run.

ScenarioRunResource

Model that represents the scenario run resource.

ScenarioRunSummaryAction

Model that represents the scenario run action.

ScenarioRunsCancelOptionalParams

Optional parameters.

ScenarioRunsGetOptionalParams

Optional parameters.

ScenarioRunsListAllOptionalParams

Optional parameters.

ScenarioRunsOperations

Interface representing a ScenarioRuns operations.

ScenariosCreateOrUpdateOptionalParams

Optional parameters.

ScenariosDeleteOptionalParams

Optional parameters.

ScenariosGetOptionalParams

Optional parameters.

ScenariosListAllOptionalParams

Optional parameters.

ScenariosOperations

Interface representing a Scenarios operations.

StepStatus

Model that represents the a list of branches and branch statuses.

SystemData

Metadata pertaining to creation and last modification of the resource.

Target

Model that represents a Target resource.

TargetReference

Model that represents a reference to a Target in the selector.

TargetType

Model that represents a Target Type resource.

TargetTypeProperties

Model that represents the base Target Type properties model.

TargetTypesGetOptionalParams

Optional parameters.

TargetTypesListOptionalParams

Optional parameters.

TargetTypesOperations

Interface representing a TargetTypes operations.

TargetsCreateOrUpdateOptionalParams

Optional parameters.

TargetsDeleteOptionalParams

Optional parameters.

TargetsGetOptionalParams

Optional parameters.

TargetsListOptionalParams

Optional parameters.

TargetsOperations

Interface representing a Targets operations.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UserAssignedIdentity

User assigned identity properties

Validation

Concrete proxy resource types can be created by aliasing this type using a specific property type.

ValidationProperties

Model that represents the properties of the scenario validation.

Workspace

Model that represents a Workspace resource.

WorkspaceEvaluation

Model that represents the latest workspace evaluation result.

WorkspaceEvaluationProperties

Model that represents the properties of the workspace evaluation.

WorkspaceProperties

Model that represents the Workspace properties model.

WorkspaceUpdate

Describes a workspace update.

WorkspacesCreateOrUpdateOptionalParams

Optional parameters.

WorkspacesDeleteOptionalParams

Optional parameters.

WorkspacesGetOptionalParams

Optional parameters.

WorkspacesListAllOptionalParams

Optional parameters.

WorkspacesListOptionalParams

Optional parameters.

WorkspacesOperations

Interface representing a Workspaces operations.

WorkspacesRefreshRecommendationsOptionalParams

Optional parameters.

WorkspacesUpdateOptionalParams

Optional parameters.

ZoneResolutionInfo

Information about how physical zones were resolved to logical zones for each subscription during scenario execution.

ZoneResolutionMapping

Maps a single subscription to its physical-to-logical zone resolutions.

Type Aliases

ActionDependencyType

Enum for action dependency type.
KnownActionDependencyType can be used interchangeably with ActionDependencyType, this enum contains the known values that the service supports.

Known values supported by the service

Action: Action dependency type.

ActionKind

Union of action types.
KnownActionKind can be used interchangeably with ActionKind, this enum contains the known values that the service supports.

Known values supported by the service

Discrete: Discrete action type.
Continuous: Continuous action type.
Cancelable: Cancelable action type.

ActionLifecycle

Enum for action lifecycle states.
KnownActionLifecycle can be used interchangeably with ActionLifecycle, this enum contains the known values that the service supports.

Known values supported by the service

AnyTerminal: Trigger when action reaches any terminal state.
Start: Trigger when action starts.
Running: Trigger when action is running.
Success: Trigger on success.
Failure: Trigger on failure.
Skipped: Trigger when action is skipped.

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ChaosExperimentActionUnion

Alias for ChaosExperimentActionUnion

ChaosTargetFilterUnion

Alias for ChaosTargetFilterUnion

ChaosTargetSelectorUnion

Alias for ChaosTargetSelectorUnion

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

ExperimentActionType

Enum union of Chaos experiment action types.
KnownExperimentActionType can be used interchangeably with ExperimentActionType, this enum contains the known values that the service supports.

Known values supported by the service

delay
discrete
continuous

FilterType

Enum that discriminates between filter types. Currently only Simple type is supported.
KnownFilterType can be used interchangeably with FilterType, this enum contains the known values that the service supports.

Known values supported by the service

Simple: Simple filter type.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

ParameterType

Enum for parameter types.
KnownParameterType can be used interchangeably with ParameterType, this enum contains the known values that the service supports.

Known values supported by the service

string: String parameter type.
number: Number parameter type.
boolean: Boolean parameter type.
object: Object parameter type.
array: Array parameter type.

PermissionsFixState

Enum of the permission fix state.
KnownPermissionsFixState can be used interchangeably with PermissionsFixState, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: The permission fix has not started.
InProgress: The permission fix is in progress.
Succeeded: All role assignments succeeded.
Failed: All role assignments failed.
PartiallySucceeded: Some role assignments succeeded and some failed.
WhatIfCompleted: What-if analysis completed (no changes made).

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Pending status.
Approved: Approved status.
Rejected: Rejected status.

ProvisioningState

Current provisioning state for a given Azure Chaos resource.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Creating: Initial creation in progress.
Updating: Update in progress.
Deleting: Deletion in progress.
Running: Action is running.

PublicNetworkAccessOption

Public Network Access Control for PrivateAccess resource.
KnownPublicNetworkAccessOption can be used interchangeably with PublicNetworkAccessOption, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enabled access.
Disabled: Disabled access.

RecommendationStatus

Enum of the scenario validation state.
KnownRecommendationStatus can be used interchangeably with RecommendationStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotEvaluated: The scenario recommendation status has not been evaluated.
Recommended: The scenario recommendation status is recommended.
NotApplicable: The scenario recommendation status is not applicable.
Evaluating: The scenario recommendation status is currently being evaluated.
EvaluationFailed: The scenario recommendation evaluation has failed.
EvaluationCancelled: The scenario recommendation evaluation was cancelled.

RoleAssignmentStatus

Enum of the role assignment status.
KnownRoleAssignmentStatus can be used interchangeably with RoleAssignmentStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The role assignment succeeded.
Failed: The role assignment failed.
Skipped: The role assignment was skipped (already exists).
Pending: The role assignment is pending (what-if mode).

RunAfterBehavior

Enum for run after behavior.
KnownRunAfterBehavior can be used interchangeably with RunAfterBehavior, this enum contains the known values that the service supports.

Known values supported by the service

Any: Always continues after all dependencies (like a finally block).
All: All dependencies must be satisfied to continue.
AtLeastOne: At least one dependency must be satisfied to continue.

ScenarioRunState

Enum of the scenario run state.
KnownScenarioRunState can be used interchangeably with ScenarioRunState, this enum contains the known values that the service supports.

Known values supported by the service

Queued: The scenario run has been queued and is waiting to start.
Resolving: The scenario run is in the process of being resolved.
Generating: The scenario run is in the process of being generated.
Validating: The scenario run is in the process of being validated.
ValidationSucceeded: The scenario run validation has completed successfully.
Starting: The scenario run is in the process of being started.
Preparing: The scenario run is in the process of being prepared.
Running: The scenario run is in the process of running.
CleaningUp: The scenario run is in the process of being cleaned up.
Canceling: The scenario run is in the process of being canceled.
Canceled: The scenario run has been canceled.
Succeeded: The scenario run has completed successfully.
Failed: The scenario run has failed.

ScenarioSummaryState

Enum of the scenario run summary action state.
KnownScenarioSummaryState can be used interchangeably with ScenarioSummaryState, this enum contains the known values that the service supports.

Known values supported by the service

Pending: The action is pending and has not started.
Starting: The action is in the process of starting.
Running: The action is in the process of running.
Stopping: The action is in the process of stopping.
Succeeded: The action has completed successfully.
Canceling: The action is in the process of being canceled.
Canceled: The action has been canceled.
FailingOnError: The action is failing due to an error.
Failed: The action has failed.
Skipped: The action was skipped.

ScenarioValidationState

Enum of the scenario validation state.
KnownScenarioValidationState can be used interchangeably with ScenarioValidationState, this enum contains the known values that the service supports.

Known values supported by the service

Resolving: The scenario validation is in a resolving state.
Generating: The scenario validation is in a generating state.
Validating: The scenario validation is in a validating state.
Accepted: The scenario validation has been accepted.
NotStarted: The scenario validation has not yet started.
RequiresAttention: The scenario validation reflects a state that requires attention. This is a terminal failure state indicating validation issues were found.
NoResolvedResources: The scenario validation found no valid resources to perform fault behaviors against. This is a terminal failure state.
Succeeded: The scenario validation completed successfully and the scenario is ready to execute.

SelectorType

Enum of the selector type.
KnownSelectorType can be used interchangeably with SelectorType, this enum contains the known values that the service supports.

Known values supported by the service

List: List selector type.
Query: Query selector type.

TargetReferenceType

Enum of the Target reference type.
KnownTargetReferenceType can be used interchangeably with TargetReferenceType, this enum contains the known values that the service supports.

Known values supported by the service

ChaosTarget: Chaos target reference type.

WorkspaceEvaluationStatus

Enum of the workspace evaluation status.
KnownWorkspaceEvaluationStatus can be used interchangeably with WorkspaceEvaluationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: The evaluation is pending and has not started.
Queued: The evaluation has been accepted and is queued for execution.
InProgress: The evaluation is in progress.
Succeeded: The evaluation completed successfully.
PartiallySucceeded: The evaluation partially succeeded — some scenarios succeeded while others failed.
Failed: The evaluation failed.
Canceled: The evaluation was canceled.

ZoneResolutionMode

The zone resolution mode for a scenario run.
KnownZoneResolutionMode can be used interchangeably with ZoneResolutionMode, this enum contains the known values that the service supports.

Known values supported by the service

logical: Logical zone mode — customer specified logical zone identifiers directly.
physical: Physical zone mode — system resolved physical zones to per-subscription logical zones at execution time.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionDependencyType

Enum for action dependency type.

KnownActionKind

Union of action types.

KnownActionLifecycle

Enum for action lifecycle states.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownCreatedByType

The kind of entity that created the resource.

KnownExperimentActionType

Enum union of Chaos experiment action types.

KnownFilterType

Enum that discriminates between filter types. Currently only Simple type is supported.

KnownManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownParameterType

Enum for parameter types.

KnownPermissionsFixState

Enum of the permission fix state.

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownProvisioningState

Current provisioning state for a given Azure Chaos resource.

KnownPublicNetworkAccessOption

Public Network Access Control for PrivateAccess resource.

KnownRecommendationStatus

Enum of the scenario validation state.

KnownRoleAssignmentStatus

Enum of the role assignment status.

KnownRunAfterBehavior

Enum for run after behavior.

KnownScenarioRunState

Enum of the scenario run state.

KnownScenarioSummaryState

Enum of the scenario run summary action state.

KnownScenarioValidationState

Enum of the scenario validation state.

KnownSelectorType

Enum of the selector type.

KnownTargetReferenceType

Enum of the Target reference type.

KnownVersions

The available API versions.

KnownWorkspaceEvaluationStatus

Enum of the workspace evaluation status.

KnownZoneResolutionMode

The zone resolution mode for a scenario run.

Functions

restorePoller<TResponse, TResult>(ChaosManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(ChaosManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ChaosManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>