pipeline_jobs

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

Overview

Name	pipeline_jobs
Type	Resource
Id	azure_extras.video_analyzer.pipeline_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string
error	object	Details about the error, in case the pipeline job fails.
expiration	string (date-time)	The date-time by when this pipeline job will be automatically deleted from your account.
parameters	array
state	string	Current state of the pipeline (read-only). Possible values include: "Processing", "Canceled", "Completed", "Failed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topologyName	string
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
@nextLink	string
value	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_name, resource_group_name, pipeline_job_name, subscription_id		Gets a specific pipeline job by name. 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	account_name, resource_group_name, subscription_id	$filter, $top	Retrieves a list of pipeline jobs. Retrieves a list of all live pipelines that have been created, along with their JSON representations.
create_or_update	insert	account_name, resource_group_name, pipeline_job_name, subscription_id		Creates or updates a pipeline job. Creates a new pipeline job or updates an existing one, with the given name.
update	update	account_name, resource_group_name, pipeline_job_name, subscription_id		Updates an existing pipeline job. Updates an existing pipeline job with the given name. Properties that can be updated include: description.
create_or_update	replace	account_name, resource_group_name, pipeline_job_name, subscription_id		Creates or updates a pipeline job. Creates a new pipeline job or updates an existing one, with the given name.
delete	delete	account_name, resource_group_name, pipeline_job_name, subscription_id		Deletes a pipeline job. Deletes a pipeline job with the given name.
cancel	exec	account_name, resource_group_name, pipeline_job_name, subscription_id		Cancels a pipeline job. 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
account_name	string	The Azure Video Analyzer account name.
pipeline_job_name	string	The pipeline job name.
resource_group_name	string	The name of the resource group. The name is case insensitive.
subscription_id	string
$filter	string	Restricts the set of items returned.
$top	integer	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

Gets a specific pipeline job by name. 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
id,
name,
description,
error,
expiration,
parameters,
state,
systemData,
topologyName,
type
FROM azure_extras.video_analyzer.pipeline_jobs
WHERE account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND pipeline_job_name = '{{ pipeline_job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
@nextLink,
value
FROM azure_extras.video_analyzer.pipeline_jobs
WHERE account_name = '{{ account_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.video_analyzer.pipeline_jobs (
properties,
account_name,
resource_group_name,
pipeline_job_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ account_name }}',
'{{ resource_group_name }}',
'{{ pipeline_job_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_jobs
props:
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the pipeline_jobs resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the pipeline_jobs resource.
  - name: pipeline_job_name
    value: "{{ pipeline_job_name }}"
    description: Required parameter for the pipeline_jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the pipeline_jobs resource.
  - name: properties
    value:
      topologyName: "{{ topologyName }}"
      description: "{{ description }}"
      parameters:
        - name: "{{ name }}"
          value: "{{ value }}"

UPDATE examples

update

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

UPDATE azure_extras.video_analyzer.pipeline_jobs
SET 
properties = '{{ properties }}'
WHERE 
account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND pipeline_job_name = '{{ pipeline_job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.video_analyzer.pipeline_jobs
SET 
properties = '{{ properties }}'
WHERE 
account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND pipeline_job_name = '{{ pipeline_job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a pipeline job. Deletes a pipeline job with the given name.

DELETE FROM azure_extras.video_analyzer.pipeline_jobs
WHERE account_name = '{{ account_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND pipeline_job_name = '{{ pipeline_job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

cancel

Cancels a pipeline job. Cancels a pipeline job with the given name.

EXEC azure_extras.video_analyzer.pipeline_jobs.cancel 
@account_name='{{ account_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@pipeline_job_name='{{ pipeline_job_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;