WorkloadFailure interface

Structured detail from a Fabric workload failure envelope.

Carried as fields rather than folded into message so callers can branch on the failure shape instead of matching substrings. Every field is optional, because the envelope is the service's shape and a missing field must not turn into a wrong claim.

Properties

errorCode

e.g. WorkloadException.

functionName

The user data function the call targeted.

invocationId

The invocation id.

All zeros is the default of a synthesized failure envelope, not a signal about the call: it carries no guarantee about whether the request was dispatched, whether the function ran, what caused the failure, or whether it is transient. Do not use it as a retry or idempotency discriminator.

status

Envelope status, e.g. Failed.

subErrorCode

e.g. Unauthorized.

Property Details

errorCode

e.g. WorkloadException.

errorCode?: string

Property Value

string

functionName

The user data function the call targeted.

functionName?: string

Property Value

string

invocationId

The invocation id.

All zeros is the default of a synthesized failure envelope, not a signal about the call: it carries no guarantee about whether the request was dispatched, whether the function ran, what caused the failure, or whether it is transient. Do not use it as a retry or idempotency discriminator.

invocationId?: string

Property Value

string

status

Envelope status, e.g. Failed.

status?: string

Property Value

string

subErrorCode

e.g. Unauthorized.

subErrorCode?: string

Property Value

string