jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	azure_extras.health_deidentification.jobs

Fields

The following fields are returned by SELECT queries:

get_job

Name	Datatype	Description
name	string	The name of a job. Required.
createdAt	string (date-time)	Date and time when the job was created. Required.
customizations	object	Customization parameters to override default service behaviors.
error	object	Error when job fails in it's entirety.
lastUpdatedAt	string (date-time)	Date and time when the job was completed. If the job is canceled, this is the time when the job was canceled. If the job failed, this is the time when the job failed. Required.
operation	string	Operation to perform on the input documents. Known values are: "Redact", "Surrogate", "Tag", and "SurrogateOnly". (Redact, Surrogate, Tag, SurrogateOnly)
sourceLocation	object	Storage location to perform the operation on. Required.
startedAt	string (date-time)	Date and time when the job was started.
status	string	Current status of a job. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", and "Canceled". (NotStarted, Running, Succeeded, Failed, Canceled)
summary	object	Summary of a job. Exists only when the job is completed.
targetLocation	object	Target location to store output of operation. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job	select	name, endpoint		Get a de-identification job. Resource read operation template.
delete_job	delete	name, endpoint		Delete a de-identification job. Removes the record of the job from the service. Does not delete any documents.

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: )
name	string	The name of a job. Required.

SELECT examples

get_job

Get a de-identification job. Resource read operation template.

SELECT
name,
createdAt,
customizations,
error,
lastUpdatedAt,
operation,
sourceLocation,
startedAt,
status,
summary,
targetLocation
FROM azure_extras.health_deidentification.jobs
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete_job

Delete a de-identification job. Removes the record of the job from the service. Does not delete any documents.

DELETE FROM azure_extras.health_deidentification.jobs
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
;