Azure Delete

Azure Delete

Certified

Delete one Cosmos document

Deletes a document using its id and partition key values; returns status, ETag, diagnostics, and RU charge.

yaml
type: io.kestra.plugin.azure.storage.cosmosdb.Delete
yaml
id: azure_cosmos_container_delete_item
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.azure.storage.cosmosdb.Delete
    endpoint: "https://yourcosmosaccount.documents.azure.com"
    databaseId: your_data_base_id
    containerId: your_container_id
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    item:
      id: item_id
      region: europe
Properties

Container ID

Container (collection) name within the database; must already exist.

Database ID

Target database name inside the account; required.

Document identifier to delete

JSON containing id and partition key fields identifying the document.

Azure AD tenant ID (GUID)

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.

Cosmos connection string

Full connection string from Azure portal; overrides endpoint and Azure AD credentials when set.

DefaultSession
Possible Values
STRONGBOUNDED_STALENESSSESSIONEVENTUALCONSISTENT_PREFIX

Choose request consistency

Consistency level sent to Cosmos; defaults to SESSION.

Defaulttrue

Return payload on writes

When true (default), write responses include the document body; set false to reduce payload size.

Cosmos account endpoint

Base account URL (e.g. https://.documents.azure.com). Required when connectionString is absent.

PEM-encoded certificate content for client authentication

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

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

Activity id

Current resource quota usage

Diagnostics

Definitions
feedResponseDiagnostics
clientSideRequestStatisticsarray
activityIdstring
addressResolutionStatisticsobject
contactedReplicasarray
SubTypestring
diagnosticsClientConfig
failedReplicasarray
SubTypestring
gatewayStatisticsListarray
locationEndpointsContactedarray
SubTypestring
metadataDiagnosticsContext
regionsContactedarray
SubTypestring
requestEndTimeUTCstring
Formatdate-time
requestPayloadSizeInBytesinteger
requestStartTimeUTCstring
Formatdate-time
responseStatisticsListarray
retryContext
samplingRateSnapshotnumber
serializationDiagnosticsContext
supplementalResponseStatisticsListarray
diagnosticsContext
endTimeUTCstring
Formatdate-time
requestTimeline
startTimeUTCstring
Formatdate-time
queryMetricsMapobject
clientSideMetrics
documentLoadTimestring
Formatduration
documentWriteTimestring
Formatduration
indexHitDocumentCountinteger
indexLookupTimestring
Formatduration
indexUtilizationInfo
outputDocumentCountinteger
outputDocumentSizeinteger
queryPreparationTimes
retrievedDocumentCountinteger
retrievedDocumentSizeinteger
runtimeExecutionTimes
totalQueryExecutionTimestring
Formatduration
samplingRateSnapshotnumber
Formatduration

Duration

E tag

Item

Max resource quota

Request charge

SubTypestring

Response headers

Session token

Status code