Azure CancelJob

Azure CancelJob

Certified

Cancel an Azure Machine Learning job

Requests cancellation of a running job. Cancellation is asynchronous in Azure ML: the job can sit in CANCEL_REQUESTED for minutes, so by default this task polls until the job actually reaches a terminal state before returning. Cancelling an already-terminal job is treated as a no-op, not a failure.

yaml
type: io.kestra.plugin.azure.ml.CancelJob
yaml
id: azure_ml_cancel_job
namespace: company.team

inputs:
  - id: job_name
    type: STRING

tasks:
  - id: cancel_job
    type: io.kestra.plugin.azure.ml.CancelJob
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    subscriptionId: "{{ secret('AZURE_SUBSCRIPTION_ID') }}"
    resourceGroupName: ml-rg
    workspaceName: ml-workspace
    jobName: "{{ inputs.job_name }}"
Properties

Job name

Name of the Azure Machine Learning job to cancel

Resource group name

Resource group containing the Machine Learning workspace

Subscription ID

Azure subscription GUID that owns the Machine Learning workspace

Azure AD tenant ID (GUID)

Workspace name

Name of the Azure Machine Learning workspace

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
Default{ "maxDuration": "PT1H", "interval": "PT10S" }

Polling frequency

Interval and max duration used when wait=true

Definitions
intervalstring
DefaultPT10S

Polling interval

Delay between status checks; defaults to PT10S. Azure ML jobs run for minutes to hours, so a tighter interval only adds needless ARM API calls

maxDurationstring
DefaultPT1H

Max wait duration

Stop polling and fail after this duration; defaults to PT1H

Client ID of the Azure AD application

Application (client) ID used for service principal authentication.

Client secret for the Azure AD application

Secret value associated with the client ID; store in a Kestra secret.

PEM-encoded certificate content for client authentication

PEM text for certificate-based auth; alternative to clientSecret.

Defaulttrue

Wait for the job to reach a terminal state

If true (default), polls until the job is actually cancelled instead of returning as soon as cancellation is requested

Job name

Possible Values
NOT_STARTEDSTARTINGPROVISIONINGPREPARINGQUEUEDRUNNINGFINALIZINGCANCEL_REQUESTEDCOMPLETEDFAILEDCANCELEDNOT_RESPONDINGPAUSEDUNKNOWN

Job status

Job status after the cancellation request