Delete
Deletes a Cosmos item and returns its respective Cosmos item response.

Deletes a Cosmos item and returns its respective Cosmos item response.

yaml
type: "io.kestra.plugin.azure.storage.cosmosdb.Delete"

Examples

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

Properties

containerId*string

container ID

databaseId*string

databaseId

item*object

item

tenantId*string

Tenant ID

clientIdstring

Client ID

Client ID of the Azure service principal. If you don't have a service principal, refer to create a service principal with Azure CLI.

clientSecretstring

Client Secret

Service principal client secret. The tenantId, clientId and clientSecret of the service principal are required for this credential to acquire an access token.

connectionStringstring

connectionString

consistencyLevelstring

DefaultSession

Possible Values

STRONGBOUNDED_STALENESSSESSIONEVENTUALCONSISTENT_PREFIX

consistencyLevel

Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.

contentResponseOnWriteEnabledbooleanstring

Defaulttrue

contentResponseOnWriteEnabled

Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem. If set to false (which is by default), service doesn't return payload in the response. It reduces networking and CPU load by not sending the payload back over the network and serializing it on the client.

endpointstring

endpoint

pemCertificatestring

PEM Certificate

text

Your stored PEM certificate.
The tenantId, clientId and clientCertificate of the service principal are required for this credential to acquire an access token.

Outputs

activityIdstring

currentResourceQuotaUsagestring

diagnostics

Definitions

com.azure.cosmos.CosmosDiagnostics

feedResponseDiagnostics

com.azure.cosmos.implementation.FeedResponseDiagnostics

clientSideRequestStatisticsarray

com.azure.cosmos.implementation.ClientSideRequestStatistics

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

com.azure.cosmos.implementation.query.QueryInfo-QueryPlanDiagnosticsContext

endTimeUTCstring

Formatdate-time

requestTimeline

startTimeUTCstring

Formatdate-time

queryMetricsMapobject

com.azure.cosmos.implementation.QueryMetrics

clientSideMetrics

documentLoadTimestring

Formatduration

documentWriteTimestring

Formatduration

indexHitDocumentCountinteger

indexLookupTimestring

Formatduration

indexUtilizationInfo

outputDocumentCountinteger

outputDocumentSizeinteger

queryPreparationTimes

retrievedDocumentCountinteger

retrievedDocumentSizeinteger

runtimeExecutionTimes

totalQueryExecutionTimestring

Formatduration

samplingRateSnapshotnumber

durationstring

Formatduration

eTagstring

itemobject

maxResourceQuotastring

requestChargenumber

responseHeadersobject

SubTypestring

sessionTokenstring

statusCodeinteger

Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

CoreStorageScript

SurrealDB

Tasks that run SurrealQL queries against SurrealDB.

Database

Typesense

Tasks that load data into and query Typesense collections.

Database

DeleteDeletes a Cosmos item and returns its respective Cosmos item response.

More Plugins in this Category

Core Plugins and tasks

SurrealDB

Typesense

Delete
Deletes a Cosmos item and returns its respective Cosmos item response.