@azure/arm-durabletask package

Reference

Classes

Interfaces

DurableTaskClientOptionalParams	Optional parameters for the client.
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.
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
RetentionPoliciesCreateOrReplaceOptionalParams	Optional parameters.
RetentionPoliciesDeleteOptionalParams	Optional parameters.
RetentionPoliciesGetOptionalParams	Optional parameters.
RetentionPoliciesListBySchedulerOptionalParams	Optional parameters.
RetentionPoliciesOperations	Interface representing a RetentionPolicies operations.
RetentionPoliciesUpdateOptionalParams	Optional parameters.
RetentionPolicy	A retention policy resource belonging to the scheduler
RetentionPolicyDetails	The properties of a retention policy
RetentionPolicyProperties	The retention policy settings for the resource
Scheduler	A Durable Task Scheduler resource
SchedulerProperties	Details of the Scheduler
SchedulerPropertiesUpdate	The Scheduler resource properties to be updated
SchedulerSku	The SKU (Stock Keeping Unit) assigned to this durable task scheduler
SchedulerSkuUpdate	The SKU (Stock Keeping Unit) properties to be updated
SchedulerUpdate	The update request model for the Scheduler resource
SchedulersCreateOrUpdateOptionalParams	Optional parameters.
SchedulersDeleteOptionalParams	Optional parameters.
SchedulersGetOptionalParams	Optional parameters.
SchedulersListByResourceGroupOptionalParams	Optional parameters.
SchedulersListBySubscriptionOptionalParams	Optional parameters.
SchedulersOperations	Interface representing a Schedulers operations.
SchedulersUpdateOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
TaskHub	A Task Hub resource belonging to the scheduler
TaskHubProperties	The properties of Task Hub
TaskHubsCreateOrUpdateOptionalParams	Optional parameters.
TaskHubsDeleteOptionalParams	Optional parameters.
TaskHubsGetOptionalParams	Optional parameters.
TaskHubsListBySchedulerOptionalParams	Optional parameters.
TaskHubsOperations	Interface representing a TaskHubs operations.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

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.
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	The status of the current operation 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. Provisioning: The resource is being provisioned Updating: The resource is updating Deleting: The resource is being deleted Accepted: The resource create request has been accepted
PurgeableOrchestrationState	Purgeable orchestration state to be used in retention policies KnownPurgeableOrchestrationState can be used interchangeably with PurgeableOrchestrationState, this enum contains the known values that the service supports. Known values supported by the service Completed: The orchestration is completed Failed: The orchestration is failed Terminated: The orchestration is terminated Canceled: The orchestration is canceled
RedundancyState	The state of the resource redundancy KnownRedundancyState can be used interchangeably with RedundancyState, this enum contains the known values that the service supports. Known values supported by the service None: The resource is not redundant Zone: The resource is zone redundant

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.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	The status of the current operation
KnownPurgeableOrchestrationState	Purgeable orchestration state to be used in retention policies
KnownRedundancyState	The state of the resource redundancy
KnownVersions	API Versions

Functions

restorePoller<TResponse, TResult>(DurableTaskClient, 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>(DurableTaskClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

Parameters

client: DurableTaskClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Share via

@azure/arm-durabletask package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns