@azure/arm-durabletask package
Classes
| DurableTaskClient |
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. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| 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. |
| 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. |
| ProvisioningState |
The status of the current operation Known values supported by the serviceSucceeded: Resource has been created. |
| PurgeableOrchestrationState |
Purgeable orchestration state to be used in retention policies Known values supported by the serviceCompleted: The orchestration is completed |
| RedundancyState |
The state of the resource redundancy Known values supported by the serviceNone: The resource is not 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
| 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>(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 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>