foundry_batch_wait: Wait for a Microsoft Foundry batch to finish
In foundryR: Data Frame Workflows for 'Microsoft Foundry'

foundry_batch_wait

R Documentation

Wait for a Microsoft Foundry batch to finish

Description

Poll a batch until it reaches a terminal state.

Usage

foundry_batch_wait(
  batch_id,
  interval = 60,
  timeout = Inf,
  api_key = NULL,
  token = NULL,
  endpoint_url = NULL,
  api_version = NULL
)

Arguments

`batch_id`	Character. Batch ID to poll.
`interval`	Numeric. Seconds between polling attempts.
`timeout`	Numeric. Maximum seconds to wait. Use `Inf` to wait indefinitely.
`api_key`	Character. Optional API key override.
`token`	Character. Optional bearer token override.
`endpoint_url`	Character. Optional Foundry endpoint override.
`api_version`	Character. Optional API version query value.

Value

The final one-row batch tibble.

Examples

## Not run: 
# Requires a configured Azure endpoint and credentials,
# plus an existing batch ID. Polling may run for longer than five seconds.
foundry_batch_wait("batch_abc123", interval = 60)

## End(Not run)

foundryR documentation built on Sept. 25, 2026, 1:10 a.m.