@azure/arm-chaos 1.0.0-beta.1

package/review/arm-chaos.api.md

@@ -0,0 +1,682 @@
+## API Report File for "@azure/arm-chaos"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public
+export interface Action {
+    name: string;
+    type: "delay" | "discrete" | "continuous";
+}
+
+// @public
+export interface ActionStatus {
+    readonly actionId?: string;
+    readonly actionName?: string;
+    readonly endTime?: Date;
+    readonly startTime?: Date;
+    readonly status?: string;
+    readonly targets?: ExperimentExecutionActionTargetDetailsProperties[];
+}
+
+// @public
+export type ActionType = string;
+
+// @public (undocumented)
+export type ActionUnion = Action | DelayAction | DiscreteAction | ContinuousAction;
+
+// @public
+export interface Branch {
+    actions: ActionUnion[];
+    name: string;
+}
+
+// @public
+export interface BranchStatus {
+    readonly actions?: ActionStatus[];
+    readonly branchId?: string;
+    readonly branchName?: string;
+    readonly status?: string;
+}
+
+// @public
+export interface Capabilities {
+    createOrUpdate(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, capabilityName: string, capability: Capability, options?: CapabilitiesCreateOrUpdateOptionalParams): Promise<CapabilitiesCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, capabilityName: string, options?: CapabilitiesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, capabilityName: string, options?: CapabilitiesGetOptionalParams): Promise<CapabilitiesGetResponse>;
+    list(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, options?: CapabilitiesListOptionalParams): PagedAsyncIterableIterator<Capability>;
+}
+
+// @public
+export interface CapabilitiesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CapabilitiesCreateOrUpdateResponse = Capability;
+
+// @public
+export interface CapabilitiesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface CapabilitiesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CapabilitiesGetResponse = Capability;
+
+// @public
+export interface CapabilitiesListNextOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type CapabilitiesListNextResponse = CapabilityListResult;
+
+// @public
+export interface CapabilitiesListOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type CapabilitiesListResponse = CapabilityListResult;
+
+// @public
+export interface Capability extends Resource {
+    readonly description?: string;
+    readonly parametersSchema?: string;
+    readonly publisher?: string;
+    readonly systemData?: SystemData;
+    readonly targetType?: string;
+    readonly urn?: string;
+}
+
+// @public
+export interface CapabilityListResult {
+    readonly nextLink?: string;
+    readonly value?: Capability[];
+}
+
+// @public
+export interface CapabilityType extends Resource {
+    readonly description?: string;
+    readonly displayName?: string;
+    readonly kind?: string;
+    location?: string;
+    readonly parametersSchema?: string;
+    readonly publisher?: string;
+    runtimeProperties?: CapabilityTypePropertiesRuntimeProperties;
+    readonly systemData?: SystemData;
+    readonly targetType?: string;
+    readonly urn?: string;
+}
+
+// @public
+export interface CapabilityTypeListResult {
+    readonly nextLink?: string;
+    readonly value?: CapabilityType[];
+}
+
+// @public
+export interface CapabilityTypePropertiesRuntimeProperties {
+    readonly kind?: string;
+}
+
+// @public
+export interface CapabilityTypes {
+    get(locationName: string, targetTypeName: string, capabilityTypeName: string, options?: CapabilityTypesGetOptionalParams): Promise<CapabilityTypesGetResponse>;
+    list(locationName: string, targetTypeName: string, options?: CapabilityTypesListOptionalParams): PagedAsyncIterableIterator<CapabilityType>;
+}
+
+// @public
+export interface CapabilityTypesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type CapabilityTypesGetResponse = CapabilityType;
+
+// @public
+export interface CapabilityTypesListNextOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type CapabilityTypesListNextResponse = CapabilityTypeListResult;
+
+// @public
+export interface CapabilityTypesListOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type CapabilityTypesListResponse = CapabilityTypeListResult;
+
+// @public (undocumented)
+export class ChaosManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ChaosManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    capabilities: Capabilities;
+    // (undocumented)
+    capabilityTypes: CapabilityTypes;
+    // (undocumented)
+    experiments: Experiments;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    targets: Targets;
+    // (undocumented)
+    targetTypes: TargetTypes;
+}
+
+// @public
+export interface ChaosManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ContinuousAction extends Action {
+    duration: string;
+    parameters: KeyValuePair[];
+    selectorId: string;
+    type: "continuous";
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DelayAction extends Action {
+    duration: string;
+    type: "delay";
+}
+
+// @public
+export interface DiscreteAction extends Action {
+    parameters: KeyValuePair[];
+    selectorId: string;
+    type: "discrete";
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface Experiment extends TrackedResource {
+    identity?: ResourceIdentity;
+    selectors: Selector[];
+    startOnCreation?: boolean;
+    steps: Step[];
+    readonly systemData?: SystemData;
+}
+
+// @public
+export interface ExperimentCancelOperationResult {
+    readonly name?: string;
+    readonly statusUrl?: string;
+}
+
+// @public
+export interface ExperimentExecutionActionTargetDetailsError {
+    readonly code?: string;
+    readonly message?: string;
+}
+
+// @public
+export interface ExperimentExecutionActionTargetDetailsProperties {
+    readonly error?: ExperimentExecutionActionTargetDetailsError;
+    readonly status?: string;
+    readonly target?: string;
+    readonly targetCompletedTime?: Date;
+    readonly targetFailedTime?: Date;
+}
+
+// @public
+export interface ExperimentExecutionDetails {
+    readonly createdDateTime?: Date;
+    readonly experimentId?: string;
+    readonly failureReason?: string;
+    readonly id?: string;
+    readonly lastActionDateTime?: Date;
+    readonly name?: string;
+    readonly runInformation?: ExperimentExecutionDetailsPropertiesRunInformation;
+    readonly startDateTime?: Date;
+    readonly status?: string;
+    readonly stopDateTime?: Date;
+    readonly type?: string;
+}
+
+// @public
+export interface ExperimentExecutionDetailsListResult {
+    readonly nextLink?: string;
+    readonly value?: ExperimentExecutionDetails[];
+}
+
+// @public
+export interface ExperimentExecutionDetailsPropertiesRunInformation {
+    readonly steps?: StepStatus[];
+}
+
+// @public
+export interface ExperimentListResult {
+    readonly nextLink?: string;
+    readonly value?: Experiment[];
+}
+
+// @public
+export interface Experiments {
+    cancel(resourceGroupName: string, experimentName: string, options?: ExperimentsCancelOptionalParams): Promise<ExperimentsCancelResponse>;
+    createOrUpdate(resourceGroupName: string, experimentName: string, experiment: Experiment, options?: ExperimentsCreateOrUpdateOptionalParams): Promise<ExperimentsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, experimentName: string, options?: ExperimentsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, experimentName: string, options?: ExperimentsGetOptionalParams): Promise<ExperimentsGetResponse>;
+    getExecutionDetails(resourceGroupName: string, experimentName: string, executionDetailsId: string, options?: ExperimentsGetExecutionDetailsOptionalParams): Promise<ExperimentsGetExecutionDetailsResponse>;
+    getStatus(resourceGroupName: string, experimentName: string, statusId: string, options?: ExperimentsGetStatusOptionalParams): Promise<ExperimentsGetStatusResponse>;
+    list(resourceGroupName: string, options?: ExperimentsListOptionalParams): PagedAsyncIterableIterator<Experiment>;
+    listAll(options?: ExperimentsListAllOptionalParams): PagedAsyncIterableIterator<Experiment>;
+    listAllStatuses(resourceGroupName: string, experimentName: string, options?: ExperimentsListAllStatusesOptionalParams): PagedAsyncIterableIterator<ExperimentStatus>;
+    listExecutionDetails(resourceGroupName: string, experimentName: string, options?: ExperimentsListExecutionDetailsOptionalParams): PagedAsyncIterableIterator<ExperimentExecutionDetails>;
+    start(resourceGroupName: string, experimentName: string, options?: ExperimentsStartOptionalParams): Promise<ExperimentsStartResponse>;
+}
+
+// @public
+export interface ExperimentsCancelOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsCancelResponse = ExperimentCancelOperationResult;
+
+// @public
+export interface ExperimentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsCreateOrUpdateResponse = Experiment;
+
+// @public
+export interface ExperimentsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ExperimentsGetExecutionDetailsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsGetExecutionDetailsResponse = ExperimentExecutionDetails;
+
+// @public
+export interface ExperimentsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsGetResponse = Experiment;
+
+// @public
+export interface ExperimentsGetStatusOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsGetStatusResponse = ExperimentStatus;
+
+// @public
+export interface ExperimentsListAllNextOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+    running?: boolean;
+}
+
+// @public
+export type ExperimentsListAllNextResponse = ExperimentListResult;
+
+// @public
+export interface ExperimentsListAllOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+    running?: boolean;
+}
+
+// @public
+export type ExperimentsListAllResponse = ExperimentListResult;
+
+// @public
+export interface ExperimentsListAllStatusesNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsListAllStatusesNextResponse = ExperimentStatusListResult;
+
+// @public
+export interface ExperimentsListAllStatusesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsListAllStatusesResponse = ExperimentStatusListResult;
+
+// @public
+export interface ExperimentsListExecutionDetailsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsListExecutionDetailsNextResponse = ExperimentExecutionDetailsListResult;
+
+// @public
+export interface ExperimentsListExecutionDetailsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsListExecutionDetailsResponse = ExperimentExecutionDetailsListResult;
+
+// @public
+export interface ExperimentsListNextOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+    running?: boolean;
+}
+
+// @public
+export type ExperimentsListNextResponse = ExperimentListResult;
+
+// @public
+export interface ExperimentsListOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+    running?: boolean;
+}
+
+// @public
+export type ExperimentsListResponse = ExperimentListResult;
+
+// @public
+export interface ExperimentsStartOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ExperimentsStartResponse = ExperimentStartOperationResult;
+
+// @public
+export interface ExperimentStartOperationResult {
+    readonly name?: string;
+    readonly statusUrl?: string;
+}
+
+// @public
+export interface ExperimentStatus {
+    readonly createdDateUtc?: Date;
+    readonly endDateUtc?: Date;
+    readonly id?: string;
+    readonly name?: string;
+    readonly status?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ExperimentStatusListResult {
+    readonly nextLink?: string;
+    readonly value?: ExperimentStatus[];
+}
+
+// @public
+export interface KeyValuePair {
+    key: string;
+    value: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    listAll(options?: OperationsListAllOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListAllNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListAllNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListAllOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListAllResponse = OperationListResult;
+
+// @public
+export type Origin = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ResourceIdentityType;
+}
+
+// @public
+export type ResourceIdentityType = "None" | "SystemAssigned";
+
+// @public
+export interface Selector {
+    id: string;
+    targets: TargetReference[];
+    type: SelectorType;
+}
+
+// @public
+export type SelectorType = "Percent" | "Random" | "Tag" | "List";
+
+// @public
+export interface Step {
+    branches: Branch[];
+    name: string;
+}
+
+// @public
+export interface StepStatus {
+    readonly branches?: BranchStatus[];
+    readonly status?: string;
+    readonly stepId?: string;
+    readonly stepName?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface Target extends Resource {
+    location?: string;
+    properties: {
+        [propertyName: string]: any;
+    };
+    readonly systemData?: SystemData;
+}
+
+// @public
+export interface TargetListResult {
+    readonly nextLink?: string;
+    readonly value?: Target[];
+}
+
+// @public
+export interface TargetReference {
+    id: string;
+    type: "ChaosTarget";
+}
+
+// @public
+export interface Targets {
+    createOrUpdate(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, target: Target, options?: TargetsCreateOrUpdateOptionalParams): Promise<TargetsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, options?: TargetsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, targetName: string, options?: TargetsGetOptionalParams): Promise<TargetsGetResponse>;
+    list(resourceGroupName: string, parentProviderNamespace: string, parentResourceType: string, parentResourceName: string, options?: TargetsListOptionalParams): PagedAsyncIterableIterator<Target>;
+}
+
+// @public
+export interface TargetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TargetsCreateOrUpdateResponse = Target;
+
+// @public
+export interface TargetsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface TargetsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TargetsGetResponse = Target;
+
+// @public
+export interface TargetsListNextOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type TargetsListNextResponse = TargetListResult;
+
+// @public
+export interface TargetsListOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type TargetsListResponse = TargetListResult;
+
+// @public
+export interface TargetType extends Resource {
+    readonly description?: string;
+    readonly displayName?: string;
+    location?: string;
+    readonly propertiesSchema?: string;
+    readonly resourceTypes?: string[];
+    readonly systemData?: SystemData;
+}
+
+// @public
+export interface TargetTypeListResult {
+    readonly nextLink?: string;
+    readonly value?: TargetType[];
+}
+
+// @public
+export interface TargetTypes {
+    get(locationName: string, targetTypeName: string, options?: TargetTypesGetOptionalParams): Promise<TargetTypesGetResponse>;
+    list(locationName: string, options?: TargetTypesListOptionalParams): PagedAsyncIterableIterator<TargetType>;
+}
+
+// @public
+export interface TargetTypesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TargetTypesGetResponse = TargetType;
+
+// @public
+export interface TargetTypesListNextOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type TargetTypesListNextResponse = TargetTypeListResult;
+
+// @public
+export interface TargetTypesListOptionalParams extends coreClient.OperationOptions {
+    continuationToken?: string;
+}
+
+// @public
+export type TargetTypesListResponse = TargetTypeListResult;
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// (No @packageDocumentation comment for this package)
+
+```