@azure/arm-chaos package
Classes
| ChaosManagementClient |
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. Known values supported by the serviceAction: Action dependency type. |
| ActionKind |
Union of action types. Known values supported by the serviceDiscrete: Discrete action type. |
| ActionLifecycle |
Enum for action lifecycle states. Known values supported by the serviceAnyTerminal: Trigger when action reaches any terminal state. |
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: 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. Known values supported by the serviceUser: The entity was created by a user. |
| ExperimentActionType |
Enum union of Chaos experiment action types. Known values supported by the servicedelay |
| FilterType |
Enum that discriminates between filter types. Currently only Known values supported by the serviceSimple: Simple filter type. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No 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" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| ParameterType |
Enum for parameter types. Known values supported by the servicestring: String parameter type. |
| PermissionsFixState |
Enum of the permission fix state. Known values supported by the serviceNotStarted: The permission fix has not started. |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending: Pending status. |
| ProvisioningState |
Current provisioning state for a given Azure Chaos resource. Known values supported by the serviceSucceeded: Resource has been created. |
| PublicNetworkAccessOption |
Public Network Access Control for PrivateAccess resource. Known values supported by the serviceEnabled: Enabled access. |
| RecommendationStatus |
Enum of the scenario validation state. Known values supported by the serviceNotEvaluated: The scenario recommendation status has not been evaluated. |
| RoleAssignmentStatus |
Enum of the role assignment status. Known values supported by the serviceSucceeded: The role assignment succeeded. |
| RunAfterBehavior |
Enum for run after behavior. Known values supported by the serviceAny: Always continues after all dependencies (like a finally block). |
| ScenarioRunState |
Enum of the scenario run state. Known values supported by the serviceQueued: The scenario run has been queued and is waiting to start. |
| ScenarioSummaryState |
Enum of the scenario run summary action state. Known values supported by the servicePending: The action is pending and has not started. |
| ScenarioValidationState |
Enum of the scenario validation state. Known values supported by the serviceResolving: The scenario validation is in a resolving state. |
| SelectorType |
Enum of the selector type. Known values supported by the serviceList: List selector type. |
| TargetReferenceType |
Enum of the Target reference type. Known values supported by the serviceChaosTarget: Chaos target reference type. |
| WorkspaceEvaluationStatus |
Enum of the workspace evaluation status. Known values supported by the servicePending: The evaluation is pending and has not started. |
| ZoneResolutionMode |
The zone resolution mode for a scenario run. Known values supported by the servicelogical: Logical zone mode — customer specified logical zone identifiers directly. |
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 |
| 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
| restore |
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
- client
- ChaosManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>