Share via

StreamingJob interface

  • Reference
Package:
@azure/arm-streamanalytics

A streaming job object, containing all information associated with the named streaming job.

Extends
TrackedResource

Properties

cluster

The cluster which streaming jobs will run on.
compatibilityLevel

Controls certain runtime behaviors of the streaming job.
contentStoragePolicy

Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .
createdDate

Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. NOTE: This property will not be serialized. It can only be populated by the server.
dataLocale

The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.
etag

The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. NOTE: This property will not be serialized. It can only be populated by the server.
eventsLateArrivalMaxDelayInSeconds

The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.
eventsOutOfOrderMaxDelayInSeconds

The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.
eventsOutOfOrderPolicy

Indicates the policy to apply to events that arrive out of order in the input event stream.
functions

A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.
identity

Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
inputs

A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.
jobId

A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. NOTE: This property will not be serialized. It can only be populated by the server.
jobState

Describes the state of the streaming job. NOTE: This property will not be serialized. It can only be populated by the server.
jobStorageAccount

The properties that are associated with an Azure Storage account with MSI
jobType

Describes the type of the job. Valid modes are Cloud and 'Edge'.
lastOutputEventTime

Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. NOTE: This property will not be serialized. It can only be populated by the server.
outputErrorPolicy

Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).
outputs

A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.
outputStartMode

This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
outputStartTime

Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.
provisioningState

Describes the provisioning status of the streaming job. NOTE: This property will not be serialized. It can only be populated by the server.
sku

Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
transformation

Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.

Inherited Properties

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

cluster

The cluster which streaming jobs will run on.

cluster?: ClusterInfo

Property Value

ClusterInfo

compatibilityLevel

Controls certain runtime behaviors of the streaming job.

compatibilityLevel?: string

Property Value

string

contentStoragePolicy

Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .

contentStoragePolicy?: string

Property Value

string

createdDate

Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdDate?: Date

Property Value

Date

dataLocale

The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.

dataLocale?: string

Property Value

string

etag

The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

eventsLateArrivalMaxDelayInSeconds

The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.

eventsLateArrivalMaxDelayInSeconds?: number

Property Value

number

eventsOutOfOrderMaxDelayInSeconds

The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

eventsOutOfOrderMaxDelayInSeconds?: number

Property Value

number

eventsOutOfOrderPolicy

Indicates the policy to apply to events that arrive out of order in the input event stream.

eventsOutOfOrderPolicy?: string

Property Value

string

functions

A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.

functions?: FunctionModel[]

Property Value

FunctionModel[]

identity

Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.

identity?: Identity

Property Value

Identity

inputs

A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.

inputs?: Input[]

Property Value

Input[]

jobId

A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job. NOTE: This property will not be serialized. It can only be populated by the server.

jobId?: string

Property Value

string

jobState

Describes the state of the streaming job. NOTE: This property will not be serialized. It can only be populated by the server.

jobState?: string

Property Value

string

jobStorageAccount

The properties that are associated with an Azure Storage account with MSI

jobStorageAccount?: JobStorageAccount

Property Value

JobStorageAccount

jobType

Describes the type of the job. Valid modes are Cloud and 'Edge'.

jobType?: string

Property Value

string

lastOutputEventTime

Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set. NOTE: This property will not be serialized. It can only be populated by the server.

lastOutputEventTime?: Date

Property Value

Date

outputErrorPolicy

Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).

outputErrorPolicy?: string

Property Value

string

outputs

A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.

outputs?: Output[]

Property Value

Output[]

outputStartMode

This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.

outputStartMode?: string

Property Value

string

outputStartTime

Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.

outputStartTime?: Date

Property Value

Date

provisioningState

Describes the provisioning status of the streaming job. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sku

Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.

sku?: Sku

Property Value

Sku

transformation

Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.

transformation?: Transformation

Property Value

Transformation

Inherited Property Details

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location?: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type