1. Packages
  2. Azure Native
  3. API Docs
  4. videoanalyzer
  5. PipelineJob
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.videoanalyzer.PipelineJob

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

    Pipeline job represents a unique instance of a batch topology, used for offline processing of selected portions of archived content. Azure REST API version: 2021-11-01-preview. Prior API version in Azure Native 1.x: 2021-11-01-preview.

    Example Usage

    Create or update a pipeline job

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var pipelineJob = new AzureNative.VideoAnalyzer.PipelineJob("pipelineJob", new()
        {
            AccountName = "testaccount2",
            Description = "Pipeline Job 1 Dsecription",
            Parameters = new[]
            {
                new AzureNative.VideoAnalyzer.Inputs.ParameterDefinitionArgs
                {
                    Name = "timesequences",
                    Value = "[[\"2020-10-05T03:30:00Z\", \"2020-10-05T04:30:00Z\"]]",
                },
                new AzureNative.VideoAnalyzer.Inputs.ParameterDefinitionArgs
                {
                    Name = "videoSourceName",
                    Value = "camera001",
                },
            },
            PipelineJobName = "pipelineJob1",
            ResourceGroupName = "testrg",
            TopologyName = "pipelinetopology1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/videoanalyzer/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := videoanalyzer.NewPipelineJob(ctx, "pipelineJob", &videoanalyzer.PipelineJobArgs{
    			AccountName: pulumi.String("testaccount2"),
    			Description: pulumi.String("Pipeline Job 1 Dsecription"),
    			Parameters: []videoanalyzer.ParameterDefinitionArgs{
    				{
    					Name:  pulumi.String("timesequences"),
    					Value: pulumi.String("[[\"2020-10-05T03:30:00Z\", \"2020-10-05T04:30:00Z\"]]"),
    				},
    				{
    					Name:  pulumi.String("videoSourceName"),
    					Value: pulumi.String("camera001"),
    				},
    			},
    			PipelineJobName:   pulumi.String("pipelineJob1"),
    			ResourceGroupName: pulumi.String("testrg"),
    			TopologyName:      pulumi.String("pipelinetopology1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.videoanalyzer.PipelineJob;
    import com.pulumi.azurenative.videoanalyzer.PipelineJobArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var pipelineJob = new PipelineJob("pipelineJob", PipelineJobArgs.builder()        
                .accountName("testaccount2")
                .description("Pipeline Job 1 Dsecription")
                .parameters(            
                    Map.ofEntries(
                        Map.entry("name", "timesequences"),
                        Map.entry("value", "[[\"2020-10-05T03:30:00Z\", \"2020-10-05T04:30:00Z\"]]")
                    ),
                    Map.ofEntries(
                        Map.entry("name", "videoSourceName"),
                        Map.entry("value", "camera001")
                    ))
                .pipelineJobName("pipelineJob1")
                .resourceGroupName("testrg")
                .topologyName("pipelinetopology1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    pipeline_job = azure_native.videoanalyzer.PipelineJob("pipelineJob",
        account_name="testaccount2",
        description="Pipeline Job 1 Dsecription",
        parameters=[
            azure_native.videoanalyzer.ParameterDefinitionArgs(
                name="timesequences",
                value="[[\"2020-10-05T03:30:00Z\", \"2020-10-05T04:30:00Z\"]]",
            ),
            azure_native.videoanalyzer.ParameterDefinitionArgs(
                name="videoSourceName",
                value="camera001",
            ),
        ],
        pipeline_job_name="pipelineJob1",
        resource_group_name="testrg",
        topology_name="pipelinetopology1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const pipelineJob = new azure_native.videoanalyzer.PipelineJob("pipelineJob", {
        accountName: "testaccount2",
        description: "Pipeline Job 1 Dsecription",
        parameters: [
            {
                name: "timesequences",
                value: "[[\"2020-10-05T03:30:00Z\", \"2020-10-05T04:30:00Z\"]]",
            },
            {
                name: "videoSourceName",
                value: "camera001",
            },
        ],
        pipelineJobName: "pipelineJob1",
        resourceGroupName: "testrg",
        topologyName: "pipelinetopology1",
    });
    
    resources:
      pipelineJob:
        type: azure-native:videoanalyzer:PipelineJob
        properties:
          accountName: testaccount2
          description: Pipeline Job 1 Dsecription
          parameters:
            - name: timesequences
              value: '[["2020-10-05T03:30:00Z", "2020-10-05T04:30:00Z"]]'
            - name: videoSourceName
              value: camera001
          pipelineJobName: pipelineJob1
          resourceGroupName: testrg
          topologyName: pipelinetopology1
    

    Create PipelineJob Resource

    new PipelineJob(name: string, args: PipelineJobArgs, opts?: CustomResourceOptions);
    @overload
    def PipelineJob(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_name: Optional[str] = None,
                    description: Optional[str] = None,
                    parameters: Optional[Sequence[ParameterDefinitionArgs]] = None,
                    pipeline_job_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    topology_name: Optional[str] = None)
    @overload
    def PipelineJob(resource_name: str,
                    args: PipelineJobArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewPipelineJob(ctx *Context, name string, args PipelineJobArgs, opts ...ResourceOption) (*PipelineJob, error)
    public PipelineJob(string name, PipelineJobArgs args, CustomResourceOptions? opts = null)
    public PipelineJob(String name, PipelineJobArgs args)
    public PipelineJob(String name, PipelineJobArgs args, CustomResourceOptions options)
    
    type: azure-native:videoanalyzer:PipelineJob
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args PipelineJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineJobArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipelineJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineJobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PipelineJob Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PipelineJob resource accepts the following input properties:

    AccountName string
    The Azure Video Analyzer account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TopologyName string
    Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
    Description string
    An optional description for the pipeline.
    Parameters List<Pulumi.AzureNative.VideoAnalyzer.Inputs.ParameterDefinition>
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    PipelineJobName string
    The pipeline job name.
    AccountName string
    The Azure Video Analyzer account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TopologyName string
    Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
    Description string
    An optional description for the pipeline.
    Parameters []ParameterDefinitionArgs
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    PipelineJobName string
    The pipeline job name.
    accountName String
    The Azure Video Analyzer account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    topologyName String
    Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
    description String
    An optional description for the pipeline.
    parameters List<ParameterDefinition>
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    pipelineJobName String
    The pipeline job name.
    accountName string
    The Azure Video Analyzer account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    topologyName string
    Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
    description string
    An optional description for the pipeline.
    parameters ParameterDefinition[]
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    pipelineJobName string
    The pipeline job name.
    account_name str
    The Azure Video Analyzer account name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    topology_name str
    Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
    description str
    An optional description for the pipeline.
    parameters Sequence[ParameterDefinitionArgs]
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    pipeline_job_name str
    The pipeline job name.
    accountName String
    The Azure Video Analyzer account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    topologyName String
    Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
    description String
    An optional description for the pipeline.
    parameters List<Property Map>
    List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
    pipelineJobName String
    The pipeline job name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PipelineJob resource produces the following output properties:

    Error Pulumi.AzureNative.VideoAnalyzer.Outputs.PipelineJobErrorResponse
    Details about the error, in case the pipeline job fails.
    Expiration string
    The date-time by when this pipeline job will be automatically deleted from your account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    State string
    Current state of the pipeline (read-only).
    SystemData Pulumi.AzureNative.VideoAnalyzer.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Error PipelineJobErrorResponse
    Details about the error, in case the pipeline job fails.
    Expiration string
    The date-time by when this pipeline job will be automatically deleted from your account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    State string
    Current state of the pipeline (read-only).
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    error PipelineJobErrorResponse
    Details about the error, in case the pipeline job fails.
    expiration String
    The date-time by when this pipeline job will be automatically deleted from your account.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    state String
    Current state of the pipeline (read-only).
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    error PipelineJobErrorResponse
    Details about the error, in case the pipeline job fails.
    expiration string
    The date-time by when this pipeline job will be automatically deleted from your account.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    state string
    Current state of the pipeline (read-only).
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    error PipelineJobErrorResponse
    Details about the error, in case the pipeline job fails.
    expiration str
    The date-time by when this pipeline job will be automatically deleted from your account.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    state str
    Current state of the pipeline (read-only).
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    error Property Map
    Details about the error, in case the pipeline job fails.
    expiration String
    The date-time by when this pipeline job will be automatically deleted from your account.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    state String
    Current state of the pipeline (read-only).
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    ParameterDefinition, ParameterDefinitionArgs

    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.
    name string
    Name of the parameter declared in the pipeline topology.
    value string
    Parameter value to be applied on this specific pipeline.
    name str
    Name of the parameter declared in the pipeline topology.
    value str
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.

    ParameterDefinitionResponse, ParameterDefinitionResponseArgs

    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    Name string
    Name of the parameter declared in the pipeline topology.
    Value string
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.
    name string
    Name of the parameter declared in the pipeline topology.
    value string
    Parameter value to be applied on this specific pipeline.
    name str
    Name of the parameter declared in the pipeline topology.
    value str
    Parameter value to be applied on this specific pipeline.
    name String
    Name of the parameter declared in the pipeline topology.
    value String
    Parameter value to be applied on this specific pipeline.

    PipelineJobErrorResponse, PipelineJobErrorResponseArgs

    Code string
    The error code.
    Message string
    The error message.
    Code string
    The error code.
    Message string
    The error message.
    code String
    The error code.
    message String
    The error message.
    code string
    The error code.
    message string
    The error message.
    code str
    The error code.
    message str
    The error message.
    code String
    The error code.
    message String
    The error message.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:videoanalyzer:PipelineJob pipelineJob1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi