Azure Batch

Azure Batch
Certified
Run transactional batch creates

Executes a single-partition transactional batch of item creates; all operations share one partition key value and succeed or fail together.

yaml
type: io.kestra.plugin.azure.storage.cosmosdb.Batch

Examples

yaml
id: azure_cosmos_container_batch_create_item
namespace: company.team

tasks:
  - id: batch_create
    type: io.kestra.plugin.azure.storage.cosmosdb.Batch
    endpoint: "https://yourcosmosaccount.documents.azure.com"
    databaseId: your_data_base_id
    containerId: your_container_id
    partitionKeyValue: europe
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    items:
        - id: item_one
          region: europe
          key: value
        - id: item_two
          region: europe
          key: value

Properties

containerId *string

Container ID

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

databaseId *string

Database ID

Target database name inside the account; required.

items *array

SubTypeobject

Documents to create

List of JSON documents; each must include the partition key field matching partitionKeyValue.

partitionKeyValue *string

Partition key value for batch

Value common to every item (e.g. "US" for a /country key); batch cannot span partitions.

tenantId *string

Azure AD tenant ID (GUID)

clientId string

Client ID of the Azure AD application

Application (client) ID used for service principal authentication.

clientSecret string

Client secret for the Azure AD application

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

connectionString string

Cosmos connection string

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

consistencyLevel string

DefaultSession

Possible Values

STRONGBOUNDED_STALENESSSESSIONEVENTUALCONSISTENT_PREFIX

Choose request consistency

Consistency level sent to Cosmos; defaults to SESSION.

contentResponseOnWriteEnabled booleanstring

Defaulttrue

Return payload on writes

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

endpoint string

Cosmos account endpoint

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

pemCertificate string

PEM-encoded certificate content for client authentication

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

pluginDefaultsRef string

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

Outputs

activityId string

Activity id

diagnostics

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

duration string

Formatduration

Duration

errorMessage string

Error message

requestCharge number

Request charge

responseHeaders object

SubTypestring

Response headers

responseLength integer

Response length

results array

Results

Definitions

com.azure.cosmos.models.CosmosBatchOperationResult

effectiveItemSerializer

com.azure.cosmos.CosmosItemSerializer

canSerializeboolean

shouldWrapSerializationExceptionsboolean

requestChargenumber

statusCodeinteger

subStatusCodeinteger

retryAfterDuration string

Formatduration

Retry after duration

sessionToken string

Session token

statusCode integer

Status code

subStatusCode integer

Sub status code

successStatusCode boolean

Success status code

Liquibase

Tasks that run Liquibase change management commands.

Data

OPA (Open Policy Agent)

Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

Azure BatchCertifiedRun transactional batch creates

More Plugins in this Category

Liquibase

OPA (Open Policy Agent)

Azure Batch
Certified
Run transactional batch creates