Share via


@azure/arm-storageactions package

Classes

StorageActionsManagementClient

Interfaces

ElseCondition

The else block of storage task operation

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.

IfCondition

The if block of storage task operation

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.

OperationsListOptionalParams

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
StorageActionsManagementClientOptionalParams

Optional parameters for the client.

StorageTask

Represents Storage Task.

StorageTaskAction

The storage task action represents conditional statements and operations to be performed on target objects.

StorageTaskAssignment

Storage Task Assignment associated with this Storage Task.

StorageTaskAssignmentListOptionalParams

Optional parameters.

StorageTaskAssignmentOperations

Interface representing a StorageTaskAssignment operations.

StorageTaskOperation

Represents an operation to be performed on the object

StorageTaskPreviewAction

Storage Task Preview Action.

StorageTaskPreviewActionCondition

Represents the storage task conditions to be tested for a match with container and blob properties.

StorageTaskPreviewActionIfCondition

Represents storage task preview action condition.

StorageTaskPreviewActionProperties

Storage task preview action properties.

StorageTaskPreviewBlobProperties

Storage task preview container properties

StorageTaskPreviewContainerProperties

Storage task preview container properties

StorageTaskPreviewKeyValueProperties

Storage task preview object key value pair properties.

StorageTaskProperties

Properties of the storage task.

StorageTaskReportInstance

Storage Tasks run report instance

StorageTaskReportProperties

Storage task execution report for a run instance.

StorageTaskUpdateParameters

Parameters of the storage task update request

StorageTaskUpdateProperties

Properties of the storage task.

StorageTasksCreateOptionalParams

Optional parameters.

StorageTasksDeleteOptionalParams

Optional parameters.

StorageTasksGetOptionalParams

Optional parameters.

StorageTasksListByResourceGroupOptionalParams

Optional parameters.

StorageTasksListBySubscriptionOptionalParams

Optional parameters.

StorageTasksOperations

Interface representing a StorageTasks operations.

StorageTasksPreviewActionsOptionalParams

Optional parameters.

StorageTasksReportListOptionalParams

Optional parameters.

StorageTasksReportOperations

Interface representing a StorageTasksReport operations.

StorageTasksUpdateOptionalParams

Optional parameters.

SystemData

Metadata pertaining to creation and last modification of the resource.

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.

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.

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.

MatchedBlockName

Represents the condition block name that matched blob properties.
KnownMatchedBlockName can be used interchangeably with MatchedBlockName, this enum contains the known values that the service supports.

Known values supported by the service

If
Else
None

OnFailure

Action to be taken when the operation fails for a object.
KnownOnFailure can be used interchangeably with OnFailure, this enum contains the known values that the service supports.

Known values supported by the service

break

OnSuccess

Action to be taken when the operation is successful for a object.
KnownOnSuccess can be used interchangeably with OnSuccess, this enum contains the known values that the service supports.

Known values supported by the service

continue

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

Represents the provisioning state of the storage task.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

ValidateSubscriptionQuotaBegin
ValidateSubscriptionQuotaEnd
Accepted
Creating
Succeeded
Deleting
Canceled
Failed

RunResult

Represents the overall result of the execution for the run instance
KnownRunResult can be used interchangeably with RunResult, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed

RunStatusEnum

Represents the status of the execution.
KnownRunStatusEnum can be used interchangeably with RunStatusEnum, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Finished

StorageTaskOperationName

The operation to be performed on the object.
KnownStorageTaskOperationName can be used interchangeably with StorageTaskOperationName, this enum contains the known values that the service supports.

Known values supported by the service

SetBlobTier
SetBlobTags
SetBlobImmutabilityPolicy
SetBlobLegalHold
SetBlobExpiry
DeleteBlob
UndeleteBlob

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.

KnownManagedServiceIdentityType

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

KnownMatchedBlockName

Represents the condition block name that matched blob properties.

KnownOnFailure

Action to be taken when the operation fails for a object.

KnownOnSuccess

Action to be taken when the operation is successful for a object.

KnownOrigin

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

KnownProvisioningState

Represents the provisioning state of the storage task.

KnownRunResult

Represents the overall result of the execution for the run instance

KnownRunStatusEnum

Represents the status of the execution.

KnownStorageTaskOperationName

The operation to be performed on the object.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(StorageActionsManagementClient, 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>(StorageActionsManagementClient, 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: StorageActionsManagementClient, 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>