@azure/arm-durabletask package

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.
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.

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.
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.

DetectorRenderingType

The rendering type for a detector dataset.
KnownDetectorRenderingType can be used interchangeably with DetectorRenderingType, this enum contains the known values that the service supports.

Known values supported by the service

1: A table rendering.
2: A time series graph rendering.
3: A time series per-instance graph rendering.
4: A pie chart rendering.
5: A data summary rendering.
6: An email snippet rendering.
7: An insight rendering.
8: A dynamic insight rendering.
9: A Markdown rendering.

DetectorStatusId

The status of a detector result.
KnownDetectorStatusId can be used interchangeably with DetectorStatusId, this enum contains the known values that the service supports.

Known values supported by the service

0: A critical issue was detected.
1: A warning was detected.
2: An informational result was returned.
3: The detector completed without detecting an issue.
4: The detector did not run or returned no insights.

DetectorType

The kind of diagnostic response.
KnownDetectorType can be used interchangeably with DetectorType, this enum contains the known values that the service supports.

Known values supported by the service

Detector: A diagnostic detector.
Analysis: A diagnostic analysis.
CategoryOverview: A diagnostic category overview.

FailoverState

The current state of the failover operation
KnownFailoverState can be used interchangeably with FailoverState, this enum contains the known values that the service supports.

Known values supported by the service

None: No failover operation is active
InProgress: The failover operation is in progress
Succeeded: The failover operation completed successfully
Failed: The failover operation failed

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.

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.

PrivateEndpointConnectionProvisioningState

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Connection has been provisioned
Creating: Connection is being created
Deleting: Connection is being deleted
Failed: Connection provisioning has failed

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

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

PublicNetworkAccess

State of the public network access.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: The public network access is enabled
Disabled: The public network access is disabled

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

ReplicationRole

The replication role of the scheduler
KnownReplicationRole can be used interchangeably with ReplicationRole, this enum contains the known values that the service supports.

Known values supported by the service

Primary: The parent scheduler is the primary in the failover configuration
Secondary: The parent scheduler is the secondary in the failover configuration

SchedulerSkuName

The name of the Stock Keeping Unit (SKU) of a Durable Task Scheduler
KnownSchedulerSkuName can be used interchangeably with SchedulerSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Dedicated: Dedicated SKU
Consumption: Consumption SKU

TransparentDataEncryptionKeySource

The key source for the transparent data encryption
KnownTransparentDataEncryptionKeySource can be used interchangeably with TransparentDataEncryptionKeySource, this enum contains the known values that the service supports.

Known values supported by the service

MicrosoftManaged: The key source is Microsoft-managed
CustomerManaged: The key source is customer-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

isRestError(unknown)

Typeguard for 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.

Variables

RestError

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

serializedState

string

sourceOperation

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

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type