pipeline_jobs

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

Overview

Name	pipeline_jobs
Type	Resource
Id	azure.video_analyzer.pipeline_jobs

Fields

The following fields are returned by SELECT queries:

get

Pipeline job was retrieved successfully.

Name	Datatype	Description
properties	object	The resource properties.

list

List of pipeline jobs that were successfully retrieved.

Name	Datatype	Description
properties	object	The resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, pipelineJobName		Retrieves a specific pipeline job by name. If a pipeline job with that name has been previously created, the call will return the JSON representation of that instance.
list	select	subscriptionId, resourceGroupName, accountName	$filter, $top	Retrieves a list of all live pipelines that have been created, along with their JSON representations.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, pipelineJobName		Creates a new pipeline job or updates an existing one, with the given name.
update	update	subscriptionId, resourceGroupName, accountName, pipelineJobName		Updates an existing pipeline job with the given name. Properties that can be updated include: description.
delete	delete	subscriptionId, resourceGroupName, accountName, pipelineJobName		Deletes a pipeline job with the given name.
cancel	exec	subscriptionId, resourceGroupName, accountName, pipelineJobName		Cancels a pipeline job with the given name.

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
accountName	string	The Azure Video Analyzer account name.
pipelineJobName	string	The pipeline job name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	Restricts the set of items returned.
$top	integer (int32)	Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

SELECT examples

get

Retrieves a specific pipeline job by name. If a pipeline job with that name has been previously created, the call will return the JSON representation of that instance.

SELECT
properties
FROM azure.video_analyzer.pipeline_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND pipelineJobName = '{{ pipelineJobName }}' -- required
;

list

Retrieves a list of all live pipelines that have been created, along with their JSON representations.

SELECT
properties
FROM azure.video_analyzer.pipeline_jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates a new pipeline job or updates an existing one, with the given name.

INSERT INTO azure.video_analyzer.pipeline_jobs (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
pipelineJobName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ pipelineJobName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the pipeline_jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the pipeline_jobs resource.
    - name: accountName
      value: string
      description: Required parameter for the pipeline_jobs resource.
    - name: pipelineJobName
      value: string
      description: Required parameter for the pipeline_jobs resource.
    - name: properties
      value: object
      description: |
        The resource properties.

UPDATE examples

update

Updates an existing pipeline job with the given name. Properties that can be updated include: description.

UPDATE azure.video_analyzer.pipeline_jobs
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND pipelineJobName = '{{ pipelineJobName }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a pipeline job with the given name.

DELETE FROM azure.video_analyzer.pipeline_jobs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND pipelineJobName = '{{ pipelineJobName }}' --required
;

Lifecycle Methods

cancel

Cancels a pipeline job with the given name.

EXEC azure.video_analyzer.pipeline_jobs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@pipelineJobName='{{ pipelineJobName }}' --required
;