operations

Creates, updates, deletes, gets or lists an operations resource.

Overview

Name	operations
Type	Resource
Id	azure.ai_document_intelligence.operations

Fields

The following fields are returned by SELECT queries:

get_operation

Name	Datatype	Description
apiVersion	string	API version used to create this operation.
createdDateTime	string (date-time)	Date and time (UTC) when the operation was created. Required.
error	object	Encountered error.
kind	string	Type of operation. Required. Known values are: "documentModelBuild", "documentModelCompose", "documentModelCopyTo", "documentClassifierCopyTo", and "documentClassifierBuild".
lastUpdatedDateTime	string (date-time)	Date and time (UTC) when the status was last updated. Required.
operationId	string	Operation ID. Required.
percentCompleted	integer	Operation progress (0-100).
resourceLocation	string	URL of the resource targeted by this operation. Required.
status	string	Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped". (notStarted, running, failed, succeeded, canceled, skipped)
tags	object	List of key-value tag attributes associated with the document model.

list_operations

Name	Datatype	Description
apiVersion	string	API version used to create this operation.
createdDateTime	string (date-time)	Date and time (UTC) when the operation was created. Required.
error	object	Encountered error.
kind	string	Type of operation. Required. Known values are: "documentModelBuild", "documentModelCompose", "documentModelCopyTo", "documentClassifierCopyTo", and "documentClassifierBuild".
lastUpdatedDateTime	string (date-time)	Date and time (UTC) when the status was last updated. Required.
operationId	string	Operation ID. Required.
percentCompleted	integer	Operation progress (0-100).
resourceLocation	string	URL of the resource targeted by this operation. Required.
status	string	Operation status. notStarted, running, completed, or failed. Required. Known values are: "notStarted", "running", "failed", "succeeded", "canceled", and "skipped". (notStarted, running, failed, succeeded, canceled, skipped)
tags	object	List of key-value tag attributes associated with the document model.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_operation	select	operation_id, endpoint		Gets operation info.
list_operations	select	endpoint		Lists all operations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
operation_id	string	Operation ID. Required.

SELECT examples

get_operation

Gets operation info.

SELECT
apiVersion,
createdDateTime,
error,
kind,
lastUpdatedDateTime,
operationId,
percentCompleted,
resourceLocation,
status,
tags
FROM azure.ai_document_intelligence.operations
WHERE operation_id = '{{ operation_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_operations

Lists all operations.

SELECT
apiVersion,
createdDateTime,
error,
kind,
lastUpdatedDateTime,
operationId,
percentCompleted,
resourceLocation,
status,
tags
FROM azure.ai_document_intelligence.operations
WHERE endpoint = '{{ endpoint }}' -- required
;