StreamingJob Class

Definition

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

[Microsoft.Rest.Serialization.JsonTransformation]
public class StreamingJob : Microsoft.Azure.Management.StreamAnalytics.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type StreamingJob = class
    inherit TrackedResource
Public Class StreamingJob
Inherits TrackedResource
Inheritance
Attributes

Constructors

StreamingJob()

Initializes a new instance of the StreamingJob class.

StreamingJob(String, String, String, IDictionary<String,String>, String, Sku, String, String, String, String, String, Nullable<DateTime>, Nullable<DateTime>, String, String, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<DateTime>, IList<Input>, Transformation, IList<Output>, IList<Function>, String, JobStorageAccount, String, ClusterInfo, Identity)

Initializes a new instance of the StreamingJob class.

Properties

Cluster

Gets or sets the cluster which streaming jobs will run on.

CompatibilityLevel

Gets or sets controls certain runtime behaviors of the streaming job. Possible values include: '1.0', '1.2'

ContentStoragePolicy

Gets or sets valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. Possible values include: 'SystemAccount', 'JobStorageAccount'

CreatedDate

Gets value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created.

DataLocale

Gets or sets 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

Gets 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.

EventsLateArrivalMaxDelayInSeconds

Gets or sets 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

Gets or sets the maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

EventsOutOfOrderPolicy

Gets or sets indicates the policy to apply to events that arrive out of order in the input event stream. Possible values include: 'Adjust', 'Drop'

Functions

Gets or sets 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.

Id

Gets fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Inherited from Resource)
Identity

Gets or sets describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.

Inputs

Gets or sets 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

Gets a GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job.

JobState

Gets describes the state of the streaming job.

JobStorageAccount

Gets or sets the properties that are associated with an Azure Storage account with MSI

JobType

Gets or sets describes the type of the job. Valid modes are Cloud and 'Edge'. Possible values include: 'Cloud', 'Edge'

LastOutputEventTime

Gets 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.

Location

Gets or sets the geo-location where the resource lives

(Inherited from TrackedResource)
Name

Gets the name of the resource

(Inherited from Resource)
OutputErrorPolicy

Gets or sets 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). Possible values include: 'Stop', 'Drop'

Outputs

Gets or sets 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

Gets or sets 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. Possible values include: 'JobStartTime', 'CustomTime', 'LastOutputEventTime'

OutputStartTime

Gets or sets 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

Gets describes the provisioning status of the streaming job.

Sku

Gets or sets describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.

Tags

Gets or sets resource tags.

(Inherited from TrackedResource)
Transformation

Gets or sets 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.

Type

Gets the type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

(Inherited from Resource)

Applies to