# UpdateCheckpoint Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Unknown Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | EventHubName : `String` |

The name of the Azure Event Hub.


Default: -
Example: myeventhub

| | ConsumerGroup : `String` |

The consumer group whose checkpoint should be updated.


Default: -
Example: $Default

| | PartitionIds : `String[]` |

List of partition IDs to update.


Default: -
Example: \[ "0", "1", "2" ]

| | RollbackEvents : `Int32` |

Number of events to roll back the checkpoint by (can be 0).


Default: -
Example: 5

| | {% endtab %} | | {% tab title="Parameter: Connection" %} | Name | Description | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | StorageAccountName : `String` |

Name of the Azure Storage Account.


Default: -
Example: mystorageaccount

| | ContainerName : `String` |

Name of the blob container used for checkpoints.


Default: -
Example: checkpoint-container

| | EventHubNamespace : `String` |

Namespace of the Event Hub.


Default: -
Example: myeventhubnamespace

| | AuthMethod : `AuthMethod` |

Authentication method to use.

Possible values:

Authentication method to use.

Authentication method to use.

Authentication method to use.


Default: -
Example: ConnectionString

| | 🗝ConnectionString : `String` |

Full connection string to the Azure Storage account.

Used if AuthMethod is ConnectionString.


Default: -
Example: DefaultEndpointsProtocol=https;AccountName=mystorage;AccountKey=KEY;EndpointSuffix=core.windows.net

| | 🗝SasToken : `String` |

SAS token for accessing the blob storage.

Used if AuthMethod is SasToken.


Default: -
Example: ?sv=2020-08-04ss=bsrt=scosp=rw

| | OAuth : `OAuthConfig` |

OAuth configuration: includes tenant ID, client ID, client secret, etc.

Used if AuthMethod is OAuth.


Default: -
Example: { "TenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "ClientId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy" }

| | {% endtab %} | | {% tab title="Parameter: Options" %} | Name | Description | | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | FailIfPartitionMissing : `Boolean` |

Controls behavior when a specified partition checkpoint does not exist.

If true, the operation fails when a partition is missing.

If false, the partition is skipped and recorded as an error, and processing continues.

When partitions are skipped, the operation is considered unsuccessful; it either

throws or returns a failure result depending on ThrowErrorOnFailure.

This operation is not transactional; updates applied before a failure are not reverted.


Default: False
Example: false

| | ThrowErrorOnFailure : `Boolean` |

True: Throw an exception.

False: Error will be added to the Result.Error.AdditionalInfo list instead of stopping the Task.


Default: True
Example: true

| | ErrorMessageOnFailure : `String` |

Message what will be used when error occurs.


Default: -
Example: Task failed during execution

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates whether update checkpoint operration was successfull.
Example: true

| | UpdatedPartitions : `String[]` |

List of partitions that were successfully updated.
Example: \[ "0", "1" ]

| | SkippedPartitions : `String[]` |

List of partitions skipped due to missing checkpoints or errors.
Example: \[ "2" ]

| | RollbackApplied : `Boolean` |

Indicates if rollback was applied.
Example: true

| | Errors : `Error[]` |

List of error messages, if any, per partition.
Example: \[ { "PartitionId": "2", "Error": "Checkpoint not found." } ]

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[1.3.0] - 2026-01-22 #### Changed * Set FailIfPartitionMissing default to false and clarified its documentation, including how skipped partitions are treated and how it interacts with ThrowErrorOnFailure ### \[1.2.0] - 2026-01-16 #### Changed * Update Azure packages to latest versions. * Azure.Storage.Blobs to 12.27.0 ### \[1.1.0] - 2025-11-20 #### Changed * Fixed checkpoint implementation to use Azure Event Hubs metadata format and removed unsupported timestamp adjustment feature. ### \[1.0.0] - 2025-07-23 #### Changed * Initial implementation {% endtab %} {% endtabs %}