@azure/arm-durabletask package
Classes
| DurableTaskClient |
Interfaces
| Detector |
A diagnostic detector resource belonging to the scheduler. |
| DetectorDataset |
A dataset produced by a detector. |
| DetectorMetadata |
Metadata that identifies and describes a detector. |
| DetectorProperties |
The diagnostic response returned for a detector. |
| DetectorRenderingProperties |
The rendering information for a detector dataset. |
| DetectorStatus |
The overall result of a detector. |
| DetectorTable |
A table included in a detector dataset. |
| DetectorTableColumn |
A column definition in a detector table. |
| DetectorsGetOptionalParams |
Optional parameters. |
| DetectorsListBySchedulerOptionalParams |
Optional parameters. |
| DetectorsOperations |
Interface representing a Detectors operations. |
| 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. |
| FailoverInstance |
A failover instance belonging to the scheduler |
| FailoverInstanceProperties |
The failover instance settings for the resource |
| FailoverInstancesCreateOrReplaceOptionalParams |
Optional parameters. |
| FailoverInstancesDeleteOptionalParams |
Optional parameters. |
| FailoverInstancesFailoverOptionalParams |
Optional parameters. |
| FailoverInstancesForceFailoverAllowDataLossOptionalParams |
Optional parameters. |
| FailoverInstancesGetOptionalParams |
Optional parameters. |
| FailoverInstancesListBySchedulerOptionalParams |
Optional parameters. |
| FailoverInstancesOperations |
Interface representing a FailoverInstances operations. |
| 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 an operation. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| OptionalPropertiesUpdateableProperties |
The template for adding optional properties. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PrivateEndpoint |
The private endpoint resource. |
| PrivateEndpointConnection |
A private endpoint connection resource |
| PrivateEndpointConnectionProperties |
Properties of the private endpoint connection. |
| PrivateEndpointConnectionUpdate |
PATCH model for private endpoint connections |
| PrivateLinkResourceProperties |
Properties of a private link resource. |
| PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
| 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 |
| SchedulerPrivateLinkResource |
A private link 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. |
| SchedulersCreateOrUpdatePrivateEndpointConnectionOptionalParams |
Optional parameters. |
| SchedulersDeleteOptionalParams |
Optional parameters. |
| SchedulersDeletePrivateEndpointConnectionOptionalParams |
Optional parameters. |
| SchedulersGetOptionalParams |
Optional parameters. |
| SchedulersGetPrivateEndpointConnectionOptionalParams |
Optional parameters. |
| SchedulersGetPrivateLinkOptionalParams |
Optional parameters. |
| SchedulersListByResourceGroupOptionalParams |
Optional parameters. |
| SchedulersListBySubscriptionOptionalParams |
Optional parameters. |
| SchedulersListPrivateEndpointConnectionsOptionalParams |
Optional parameters. |
| SchedulersListPrivateLinksOptionalParams |
Optional parameters. |
| SchedulersOperations |
Interface representing a Schedulers operations. |
| SchedulersRestartOptionalParams |
Optional parameters. |
| SchedulersUpdateOptionalParams |
Optional parameters. |
| SchedulersUpdatePrivateEndpointConnectionOptionalParams |
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. |
| TaskQueue |
A Task Queue resource belonging to a Task Hub |
| TaskQueueProperties |
The properties of a Task Queue |
| TaskQueueThroughput |
The throughput configuration of a Task Queue |
| TaskQueueUpdate |
The update request model for a Task Queue |
| TaskQueuesCreateOrUpdateOptionalParams |
Optional parameters. |
| TaskQueuesDeleteOptionalParams |
Optional parameters. |
| TaskQueuesGetOptionalParams |
Optional parameters. |
| TaskQueuesListByTaskHubOptionalParams |
Optional parameters. |
| TaskQueuesOperations |
Interface representing a TaskQueues operations. |
| TaskQueuesUpdateOptionalParams |
Optional parameters. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| TransparentDataEncryption |
A transparent data encryption resource belonging to the scheduler |
| TransparentDataEncryptionProperties |
The transparent data encryption settings for the resource |
| TransparentDataEncryptionsCreateOrReplaceOptionalParams |
Optional parameters. |
| TransparentDataEncryptionsDeleteOptionalParams |
Optional parameters. |
| TransparentDataEncryptionsGetOptionalParams |
Optional parameters. |
| TransparentDataEncryptionsListBySchedulerOptionalParams |
Optional parameters. |
| TransparentDataEncryptionsOperations |
Interface representing a TransparentDataEncryptions operations. |
| UserAssignedIdentity |
User assigned identity properties |
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. |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| 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. |
| DetectorRenderingType |
The rendering type for a detector dataset. Known values supported by the service1: A table rendering. |
| DetectorStatusId |
The status of a detector result. Known values supported by the service0: A critical issue was detected. |
| DetectorType |
The kind of diagnostic response. Known values supported by the serviceDetector: A diagnostic detector. |
| FailoverState |
The current state of the failover operation Known values supported by the serviceNone: No failover operation is active |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No 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" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded: Connection has been provisioned |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending: Connection waiting for approval or rejection |
| ProvisioningState |
The status of the current operation Known values supported by the serviceSucceeded: Resource has been created. |
| PublicNetworkAccess |
State of the public network access. Known values supported by the serviceEnabled: The public network access is enabled |
| 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 |
| ReplicationRole |
The replication role of the scheduler Known values supported by the servicePrimary: The parent scheduler is the primary in the failover configuration |
| SchedulerSkuName |
The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler Known values supported by the serviceDedicated: Dedicated SKU |
| TransparentDataEncryptionKeySource |
The key source for the transparent data encryption Known values supported by the serviceMicrosoftManaged: The key source is Microsoft-managed |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| 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. |
| KnownDetectorRenderingType |
The rendering type for a detector dataset. |
| KnownDetectorStatusId |
The status of a detector result. |
| KnownDetectorType |
The kind of diagnostic response. |
| KnownFailoverState |
The current state of the failover operation |
| 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" |
| KnownPrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| KnownPrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| KnownProvisioningState |
The status of the current operation |
| KnownPublicNetworkAccess |
State of the public network access. |
| KnownPurgeableOrchestrationState |
Purgeable orchestration state to be used in retention policies |
| KnownRedundancyState |
The state of the resource redundancy |
| KnownReplicationRole |
The replication role of the scheduler |
| KnownSchedulerSkuName |
The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler |
| KnownTransparentDataEncryptionKeySource |
The key source for the transparent data encryption |
| KnownVersions |
API Versions |
Functions
| is |
Typeguard for RestError |
| 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. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e is RestError
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e is RestError
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>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor