Package version:

Interface StreamingJob

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

interface StreamingJob {
    cluster?: ClusterInfo;
    compatibilityLevel?: string;
    contentStoragePolicy?: string;
    createdDate?: Date;
    dataLocale?: string;
    etag?: string;
    eventsLateArrivalMaxDelayInSeconds?: number;
    eventsOutOfOrderMaxDelayInSeconds?: number;
    eventsOutOfOrderPolicy?: string;
    externals?: External;
    functions?: FunctionModel[];
    id?: string;
    identity?: Identity;
    inputs?: Input[];
    jobId?: string;
    jobState?: string;
    jobStorageAccount?: JobStorageAccount;
    jobType?: string;
    lastOutputEventTime?: Date;
    location?: string;
    name?: string;
    outputErrorPolicy?: string;
    outputStartMode?: string;
    outputStartTime?: Date;
    outputs?: Output[];
    provisioningState?: string;
    sku?: Sku;
    skuPropertiesSku?: Sku;
    tags?: {
        [propertyName: string]: string;
    };
    transformation?: Transformation;
    type?: string;
}

Hierarchy (view full)

Properties

cluster? compatibilityLevel? contentStoragePolicy? createdDate? dataLocale? etag? eventsLateArrivalMaxDelayInSeconds? eventsOutOfOrderMaxDelayInSeconds? eventsOutOfOrderPolicy? externals? functions? id? identity? inputs? jobId? jobState? jobStorageAccount? jobType? lastOutputEventTime? location? name? outputErrorPolicy? outputStartMode? outputStartTime? outputs? provisioningState? sku? skuPropertiesSku? tags? transformation? type?

Properties

Optional cluster

cluster?: ClusterInfo

The cluster which streaming jobs will run on.

Optional compatibilityLevel

compatibilityLevel?: string

Controls certain runtime behaviors of the streaming job.

Optional contentStoragePolicy

contentStoragePolicy?: string

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

Optional Readonly createdDate

createdDate?: Date

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.

Optional dataLocale

dataLocale?: string

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.

Optional Readonly etag

etag?: string

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.

Optional eventsLateArrivalMaxDelayInSeconds

eventsLateArrivalMaxDelayInSeconds?: number

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.

Optional eventsOutOfOrderMaxDelayInSeconds

eventsOutOfOrderMaxDelayInSeconds?: number

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

Optional eventsOutOfOrderPolicy

eventsOutOfOrderPolicy?: string

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

Optional externals

externals?: External

The storage account where the custom code artifacts are located.

Optional functions

functions?: FunctionModel[]

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.

Optional Readonly id

id?: string

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.

Optional identity

identity?: Identity

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

Optional inputs

inputs?: Input[]

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.

Optional Readonly jobId

jobId?: string

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.

Optional Readonly jobState

jobState?: string

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

Optional jobStorageAccount

jobStorageAccount?: JobStorageAccount

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

Optional jobType

jobType?: string

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

Optional Readonly lastOutputEventTime

lastOutputEventTime?: Date

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.

Optional location

location?: string

The geo-location where the resource lives

Optional Readonly name

name?: string

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

Optional outputErrorPolicy

outputErrorPolicy?: string

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

Optional outputStartMode

outputStartMode?: string

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.

Optional outputStartTime

outputStartTime?: Date

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.

Optional outputs

outputs?: Output[]

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.

Optional Readonly provisioningState

provisioningState?: string

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

Optional sku

sku?: Sku

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

Optional skuPropertiesSku

skuPropertiesSku?: Sku

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

Optional tags

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

Resource tags.

Type declaration

  • [propertyName: string]: string

Optional transformation

transformation?: 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.

Optional Readonly type

type?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc