Azure ListInstances

Azure ListInstances

Certified

List pg_durable instances

Queries df.list_instances(status, limit), with an optional status filter and row limit, and returns matching instances according to fetchType (FETCH or STORE).

yaml
type: io.kestra.plugin.azure.horizondb.durable.ListInstances
yaml
id: horizondb_durable_list_instances
namespace: company.team

inputs:
  - id: host
    type: STRING

tasks:
  - id: list_running
    type: io.kestra.plugin.azure.horizondb.durable.ListInstances
    host: "{{ inputs.host }}"
    port: 5432
    database: mydb
    username: "{{ secret('HORIZONDB_USERNAME') }}"
    password: "{{ secret('HORIZONDB_PASSWORD') }}"
    statusFilter: Running
    fetchType: FETCH
Properties

Database name

HorizonDB server host

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

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Azure client id

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

Azure client secret

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

Default10000

JDBC fetch size

Number of rows fetched per database round trip; only used for STORE mode.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Result fetching mode

STORE streams matching instances to internal storage (ION). Any other value (including the FETCH default) returns them as an in-memory list; FETCH_ONE and NONE are not treated specially by this task.

Default1000

Row limit

Maximum number of instances to return, passed as df.list_instances()'s own limit argument. Defaults to 1000 so this can't silently load an unbounded number of instances into memory (or into a STORE'd file); raise it explicitly if you need more in one call.

Password

Required unless useEntraId is true.

Default5432

HorizonDB server port

Defaults to the standard PostgreSQL port.

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.

Status filter

Optional status to filter instances by (e.g. Running, Completed, Failed, Cancelled). Passed as df.list_instances()'s own status argument. When empty, all instances (up to limit) are returned.

Azure tenant id

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

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

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

SubTypeobject

Matching instances

Only populated when fetchType is FETCH.

Number of matching instances

Formaturi

URI of stored results in internal storage

Only populated when fetchType is STORE; stored using ION format.