Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. videoanalyzer
  5. getPipelineJob
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.videoanalyzer.getPipelineJob

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

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.

Uses Azure REST API version 2021-11-01-preview.

Using getPipelineJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPipelineJob(args: GetPipelineJobArgs, opts?: InvokeOptions): Promise<GetPipelineJobResult>
function getPipelineJobOutput(args: GetPipelineJobOutputArgs, opts?: InvokeOptions): Output<GetPipelineJobResult>
Copy
def get_pipeline_job(account_name: Optional[str] = None,
                     pipeline_job_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPipelineJobResult
def get_pipeline_job_output(account_name: Optional[pulumi.Input[str]] = None,
                     pipeline_job_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPipelineJobResult]
Copy
func LookupPipelineJob(ctx *Context, args *LookupPipelineJobArgs, opts ...InvokeOption) (*LookupPipelineJobResult, error)
func LookupPipelineJobOutput(ctx *Context, args *LookupPipelineJobOutputArgs, opts ...InvokeOption) LookupPipelineJobResultOutput
Copy

> Note: This function is named LookupPipelineJob in the Go SDK.

public static class GetPipelineJob 
{
    public static Task<GetPipelineJobResult> InvokeAsync(GetPipelineJobArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineJobResult> Invoke(GetPipelineJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineJobResult> getPipelineJob(GetPipelineJobArgs args, InvokeOptions options)
public static Output<GetPipelineJobResult> getPipelineJob(GetPipelineJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:videoanalyzer:getPipelineJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The Azure Video Analyzer account name.
PipelineJobName
This property is required.
Changes to this property will trigger replacement.
string
The pipeline job name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The Azure Video Analyzer account name.
PipelineJobName
This property is required.
Changes to this property will trigger replacement.
string
The pipeline job name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The Azure Video Analyzer account name.
pipelineJobName
This property is required.
Changes to this property will trigger replacement.
String
The pipeline job name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The Azure Video Analyzer account name.
pipelineJobName
This property is required.
Changes to this property will trigger replacement.
string
The pipeline job name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The Azure Video Analyzer account name.
pipeline_job_name
This property is required.
Changes to this property will trigger replacement.
str
The pipeline job name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The Azure Video Analyzer account name.
pipelineJobName
This property is required.
Changes to this property will trigger replacement.
String
The pipeline job name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getPipelineJob Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
TopologyName string
Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
An optional description for the pipeline.
Parameters List<Pulumi.AzureNative.VideoAnalyzer.Outputs.ParameterDefinitionResponse>
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.
AzureApiVersion string
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
TopologyName string
Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string
An optional description for the pipeline.
Parameters []ParameterDefinitionResponse
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.
azureApiVersion String
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
topologyName String
Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String
An optional description for the pipeline.
parameters List<ParameterDefinitionResponse>
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.
azureApiVersion string
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
topologyName string
Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string
An optional description for the pipeline.
parameters ParameterDefinitionResponse[]
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.
azure_api_version str
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
topology_name str
Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str
An optional description for the pipeline.
parameters Sequence[ParameterDefinitionResponse]
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.
azureApiVersion String
The Azure API version of the resource.
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
topologyName String
Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.

Supporting Types

ParameterDefinitionResponse

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

PipelineJobErrorResponse

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

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.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native