Share via


@azure/arm-chaos package

Classes

ChaosManagementClient

Interfaces

ActionStatus

Model that represents the an action and its status.

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.

ContinuousAction

Model that represents a continuous action.

DelayAction

Model that represents a delay action.

DiscreteAction

Model that represents a discrete action.

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.

KeyValuePair

A map to describe the settings of an action.

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 and 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.

ProxyResource

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

Resource

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

RestorePollerOptions
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

Type Aliases

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.

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.
<xref: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.

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.

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.

Enums

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"

KnownProvisioningState

Current provisioning state for a given Azure Chaos resource.

KnownSelectorType

Enum of the selector type.

KnownTargetReferenceType

Enum of the Target reference type.

KnownVersions

The available API versions.

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>