Azure Cancel

Azure Cancel
Certified
Cancel a pg_durable durable function instance

Cancels a running instance via SELECT df.cancel(id, reason).

yaml
type: io.kestra.plugin.azure.horizondb.durable.Cancel

Examples

yaml
id: horizondb_durable_cancel
namespace: company.team

inputs:
  - id: host
    type: STRING
  - id: instance_id
    type: STRING

tasks:
  - id: cancel
    type: io.kestra.plugin.azure.horizondb.durable.Cancel
    host: "{{ inputs.host }}"
    port: 5432
    database: mydb
    username: "{{ secret('HORIZONDB_USERNAME') }}"
    password: "{{ secret('HORIZONDB_PASSWORD') }}"
    instanceId: "{{ inputs.instance_id }}"
    reason: "Cancelled from a Kestra flow"

Properties

database *string

Database name

host *string

HorizonDB server host

Hostname of the Azure HorizonDB server, without protocol or port (e.g. myserver.postgres.horizondb.azure.com).

instanceId *string

Durable instance id

Identifier of the instance to cancel.

clientId string

Azure client id

Used with tenantId/clientSecret for service principal authentication when useEntraId is true. Ignored otherwise.

clientSecret string

Azure client secret

Used with tenantId/clientId for service principal authentication when useEntraId is true. Ignored otherwise.

password string

Password

Required unless useEntraId is true.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

port integerstring

Default5432

HorizonDB server port

Defaults to the standard PostgreSQL port.

reason string

DefaultCancelled via Kestra

Cancellation reason

Free-text reason recorded against the instance. df.cancel() requires this argument.

ssl booleanstring

Defaulttrue

Require TLS

When true (the default), the connection is rejected unless it is encrypted (sslmode=require). Set to false only for local development against a non-TLS instance.

tenantId string

Azure tenant id

Used with clientId/clientSecret for service principal authentication when useEntraId is true. Ignored otherwise.

useEntraId booleanstring

Defaultfalse

Authenticate with Azure Entra ID

When true, authenticates using Azure Entra ID (via the Azure Identity Extensions JDBC plugin) instead of a static password. With no further properties set, this falls back to whatever DefaultAzureCredential resolves on the worker (managed identity, environment variables, Azure CLI login, etc.); set tenantId/clientId/clientSecret below to authenticate as a specific service principal instead.

username string

Username

Required unless useEntraId is true and the Entra ID token carries the identity.

Outputs

cancelled boolean

Whether the cancel request was sent

True once df.cancel() executes without error; pg_durable does not document a specific return value to confirm the instance actually stopped, so check GetStatus separately if you need to verify the outcome.

instanceId string

Durable instance id

Liquibase

Tasks that run Liquibase change management commands.

Data

PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

Azure CancelCertifiedCancel a pg_durable durable function instance

More Plugins in this Category

Liquibase

PostgreSQL

Azure Cancel
Certified
Cancel a pg_durable durable function instance