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

vw_pipeline_jobs

Name	Datatype	Description
description	text	field from the properties object
accountName	text	field from the properties object
error	text	field from the properties object
expiration	text	field from the properties object
parameters	text	field from the properties object
pipelineJobName	text	field from the properties object
resourceGroupName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
topology_name	text	field from the properties object

pipeline_jobs

Name	Datatype	Description
properties	object	Pipeline job properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, pipelineJobName, resourceGroupName, subscriptionId	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	accountName, resourceGroupName, subscriptionId	Retrieves a list of all live pipelines that have been created, along with their JSON representations.
create_or_update	INSERT	accountName, pipelineJobName, resourceGroupName, subscriptionId	Creates a new pipeline job or updates an existing one, with the given name.
delete	DELETE	accountName, pipelineJobName, resourceGroupName, subscriptionId	Deletes a pipeline job with the given name.
update	UPDATE	accountName, pipelineJobName, resourceGroupName, subscriptionId	Updates an existing pipeline job with the given name. Properties that can be updated include: description.
cancel	EXEC	accountName, pipelineJobName, resourceGroupName, subscriptionId	Cancels a pipeline job with the given name.

SELECT examples

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

vw_pipeline_jobs

SELECT
description,
accountName,
error,
expiration,
parameters,
pipelineJobName,
resourceGroupName,
state,
subscriptionId,
topology_name
FROM azure.video_analyzer.vw_pipeline_jobs
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

pipeline_jobs

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

INSERT example

Use the following StackQL query and manifest file to create a new pipeline_jobs resource.

All Properties

/*+ create */
INSERT INTO azure.video_analyzer.pipeline_jobs (
accountName,
pipelineJobName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ accountName }}',
'{{ pipelineJobName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: topologyName
          value: string
        - name: description
          value: string
        - name: state
          value: string
        - name: expiration
          value: string
        - name: error
          value:
            - name: code
              value: string
            - name: message
              value: string
        - name: parameters
          value:
            - - name: name
                value: string
              - name: value
                value: string

UPDATE example

Updates a pipeline_jobs resource.

/*+ update */
UPDATE azure.video_analyzer.pipeline_jobs
SET 
properties = '{{ properties }}'
WHERE 
accountName = '{{ accountName }}'
AND pipelineJobName = '{{ pipelineJobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified pipeline_jobs resource.

/*+ delete */
DELETE FROM azure.video_analyzer.pipeline_jobs
WHERE accountName = '{{ accountName }}'
AND pipelineJobName = '{{ pipelineJobName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';