StreamingJob Class

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

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.streamanalytics.models._models_py3.TrackedResource

StreamingJob

Constructor

StreamingJob(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, identity: Optional[azure.mgmt.streamanalytics.models._models_py3.Identity] = None, sku: Optional[azure.mgmt.streamanalytics.models._models_py3.StreamingJobSku] = None, job_type: Optional[Union[str, azure.mgmt.streamanalytics.models._stream_analytics_management_client_enums.JobType]] = None, output_start_mode: Optional[Union[str, azure.mgmt.streamanalytics.models._stream_analytics_management_client_enums.OutputStartMode]] = None, output_start_time: Optional[datetime.datetime] = None, events_out_of_order_policy: Optional[Union[str, azure.mgmt.streamanalytics.models._stream_analytics_management_client_enums.EventsOutOfOrderPolicy]] = None, output_error_policy: Optional[Union[str, azure.mgmt.streamanalytics.models._stream_analytics_management_client_enums.OutputErrorPolicy]] = None, events_out_of_order_max_delay_in_seconds: Optional[int] = None, events_late_arrival_max_delay_in_seconds: Optional[int] = None, data_locale: Optional[str] = None, compatibility_level: Optional[Union[str, azure.mgmt.streamanalytics.models._stream_analytics_management_client_enums.CompatibilityLevel]] = None, inputs: Optional[List[azure.mgmt.streamanalytics.models._models_py3.Input]] = None, transformation: Optional[azure.mgmt.streamanalytics.models._models_py3.Transformation] = None, outputs: Optional[List[azure.mgmt.streamanalytics.models._models_py3.Output]] = None, functions: Optional[List[azure.mgmt.streamanalytics.models._models_py3.Function]] = None, job_storage_account: Optional[azure.mgmt.streamanalytics.models._models_py3.JobStorageAccount] = None, externals: Optional[azure.mgmt.streamanalytics.models._models_py3.External] = None, cluster: Optional[azure.mgmt.streamanalytics.models._models_py3.ClusterInfo] = None, **kwargs)

Parameters

tags

dict[str, str]

Required

A set of tags. Resource tags.

location

str

Required

The geo-location where the resource lives.

identity

<xref:stream_analytics_management_client.models.Identity>

Required

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

sku

<xref:stream_analytics_management_client.models.StreamingJobSku>

Required

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

job_type

str or <xref:stream_analytics_management_client.models.JobType>

Required

Describes the type of the job. Valid modes are Cloud and 'Edge'. Possible values include: "Cloud", "Edge".

output_start_mode

str or <xref:stream_analytics_management_client.models.OutputStartMode>

Required

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

output_start_time

datetime

Required

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.

events_out_of_order_policy

str or <xref:stream_analytics_management_client.models.EventsOutOfOrderPolicy>

Required

Indicates the policy to apply to events that arrive out of order in the input event stream. Possible values include: "Adjust", "Drop".

output_error_policy

str or <xref:stream_analytics_management_client.models.OutputErrorPolicy>

Required

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

events_out_of_order_max_delay_in_seconds

int

Required

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

events_late_arrival_max_delay_in_seconds

int

Required

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.

data_locale

str

Required

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.

compatibility_level

str or <xref:stream_analytics_management_client.models.CompatibilityLevel>

Required

Controls certain runtime behaviors of the streaming job. Possible values include: "1.0".

inputs

list[<xref:stream_analytics_management_client.models.Input>]

Required

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.

transformation

<xref:stream_analytics_management_client.models.Transformation>

Required

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.

outputs

list[<xref:stream_analytics_management_client.models.Output>]

Required

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.

functions

list[<xref:stream_analytics_management_client.models.Function>]

Required

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.

job_storage_account

<xref:stream_analytics_management_client.models.JobStorageAccount>

Required

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

externals

<xref:stream_analytics_management_client.models.External>

Required

The storage account where the custom code artifacts are located.

cluster

<xref:stream_analytics_management_client.models.ClusterInfo>

Required

The cluster which streaming jobs will run on.

Variables

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.

type

str

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

job_id

str

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

provisioning_state

str

Describes the provisioning status of the streaming job.

job_state

str

Describes the state of the streaming job.

last_output_event_time

datetime

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.

created_date

datetime

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

etag

str

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.

content_storage_policy

str or <xref:stream_analytics_management_client.models.ContentStoragePolicy>

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