{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/microsoft-azure-stream-analytics/json-schema/microsoft-azure-stream-analytics-streaming-job-list-result-schema.json", "title": "StreamingJobListResult", "description": "Object containing a list of streaming jobs.", "x-generated": "2026-11-05", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/microsoft-azure-stream-analytics-streamingjobs-api-openapi.yml#/components/schemas/StreamingJobListResult", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/$defs/StreamingJob" }, "readOnly": true, "description": "A list of streaming jobs. Populated by a 'List' operation." }, "nextLink": { "type": "string", "readOnly": true, "description": "The link (url) to the next page of results." } }, "$defs": { "ClusterInfo": { "type": "object", "description": "The properties associated with a Stream Analytics cluster.", "properties": { "id": { "description": "The resource id of cluster.", "type": "string" } } }, "CompatibilityLevel": { "type": "string", "description": "Controls certain runtime behaviors of the streaming job.", "enum": [ "1.0", "1.2" ], "x-ms-enum": { "name": "CompatibilityLevel", "modelAsString": true } }, "EventsOutOfOrderPolicy": { "type": "string", "description": "Indicates the policy to apply to events that arrive out of order in the input event stream.", "enum": [ "Adjust", "Drop" ], "x-ms-enum": { "name": "EventsOutOfOrderPolicy", "modelAsString": true } }, "Identity": { "type": "object", "description": "Describes how identity is verified", "properties": { "tenantId": { "type": "string", "description": "The identity tenantId", "readOnly": true }, "principalId": { "type": "string", "description": "The identity principal ID", "readOnly": true }, "type": { "type": "string", "description": "The identity type" } } }, "JobStorageAccount": { "type": "object", "description": "The properties that are associated with an Azure Storage account with MSI", "allOf": [ { "type": "object", "description": "The properties that are associated with an Azure Storage account", "properties": { "accountName": { "type": "string", "description": "The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests." }, "accountKey": { "type": "string", "description": "The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests." } } } ], "properties": { "authenticationMode": { "type": "string", "description": "Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'.", "enum": [ "Msi", "UserToken", "ConnectionString" ], "x-ms-enum": { "name": "AuthenticationMode", "modelAsString": true }, "default": "ConnectionString" } } }, "OutputErrorPolicy": { "type": "string", "description": "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).", "enum": [ "Stop", "Drop" ], "x-ms-enum": { "name": "OutputErrorPolicy", "modelAsString": true } }, "OutputStartMode": { "type": "string", "description": "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.", "enum": [ "JobStartTime", "CustomTime", "LastOutputEventTime" ], "x-ms-enum": { "name": "OutputStartMode", "modelAsString": true } }, "Sku": { "type": "object", "description": "The properties that are associated with a SKU.", "properties": { "name": { "type": "string", "description": "The name of the SKU. Required on PUT (CreateOrReplace) requests.", "enum": [ "Standard" ], "x-ms-enum": { "name": "SkuName", "modelAsString": true } } } }, "StreamingJob": { "type": "object", "description": "A streaming job object, containing all information associated with the named streaming job.", "allOf": [ { "type": "object", "description": "The resource model definition for a ARM tracked top level resource", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "create", "update" ], "description": "Resource tags." }, "location": { "type": "string", "x-ms-mutability": [ "read", "create" ], "description": "The geo-location where the resource lives" } }, "allOf": [ { "type": "object", "description": "The base resource definition", "properties": { "id": { "readOnly": true, "type": "string", "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" }, "name": { "readOnly": true, "type": "string", "description": "The name of the resource" }, "type": { "readOnly": true, "type": "string", "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." } }, "x-ms-azure-resource": true } ] } ], "properties": { "properties": { "$ref": "#/$defs/StreamingJobProperties" }, "identity": { "$ref": "#/$defs/Identity" } } }, "StreamingJobProperties": { "type": "object", "description": "The properties that are associated with a streaming job.", "properties": { "sku": { "$ref": "#/$defs/Sku" }, "jobId": { "readOnly": true, "type": "string", "description": "A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job." }, "provisioningState": { "readOnly": true, "type": "string", "description": "Describes the provisioning status of the streaming job." }, "jobState": { "readOnly": true, "type": "string", "description": "Describes the state of the streaming job." }, "jobType": { "type": "string", "description": "Describes the type of the job. Valid modes are `Cloud` and 'Edge'.", "enum": [ "Cloud", "Edge" ], "x-ms-enum": { "name": "JobType", "modelAsString": true } }, "outputStartMode": { "$ref": "#/$defs/OutputStartMode" }, "outputStartTime": { "type": "string", "format": "date-time", "description": "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." }, "lastOutputEventTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "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." }, "eventsOutOfOrderPolicy": { "$ref": "#/$defs/EventsOutOfOrderPolicy" }, "outputErrorPolicy": { "$ref": "#/$defs/OutputErrorPolicy" }, "eventsOutOfOrderMaxDelayInSeconds": { "type": "integer", "format": "int32", "description": "The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order." }, "eventsLateArrivalMaxDelayInSeconds": { "type": "integer", "format": "int32", "description": "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." }, "dataLocale": { "type": "string", "description": "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." }, "compatibilityLevel": { "$ref": "#/$defs/CompatibilityLevel" }, "createdDate": { "readOnly": true, "type": "string", "format": "date-time", "description": "Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created." }, "inputs": { "type": "array", "items": { "type": "object", "description": "An input object, containing all information associated with the named input. All inputs are contained under a streaming job.", "allOf": [ { "type": "object", "description": "The base sub-resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" } }, "x-ms-azure-resource": true } ], "properties": { "properties": { "type": "object", "description": "The properties that are associated with an input.", "properties": { "type": { "type": "string", "description": "Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests." }, "serialization": { "type": "object", "description": "Describes how data from an input is serialized or how data is serialized when written to an output.", "properties": { "type": { "type": "string", "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", "enum": [ "Csv", "Avro", "Json", "Parquet" ], "x-ms-enum": { "name": "EventSerializationType", "modelAsString": true } } }, "required": [ "type" ] }, "diagnostics": { "type": "object", "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.", "properties": { "conditions": { "readOnly": true, "type": "array", "items": { "type": "object", "description": "Condition applicable to the resource, or to the job overall, that warrant customer attention.", "properties": { "since": { "readOnly": true, "type": "string", "description": "The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time." }, "code": { "readOnly": true, "type": "string", "description": "The opaque diagnostic code." }, "message": { "readOnly": true, "type": "string", "description": "The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request." } } }, "x-ms-identifiers": [], "description": "A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention." } } }, "etag": { "readOnly": true, "type": "string", "description": "The current entity tag for the input. 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." }, "compression": { "type": "object", "description": "Describes how input data is compressed", "properties": { "type": { "type": "string", "description": "Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.", "enum": [ "None", "GZip", "Deflate" ], "x-ms-enum": { "name": "CompressionType", "modelAsString": true }, "default": "None" } }, "required": [ "type" ] }, "partitionKey": { "type": "string", "description": "partitionKey Describes a key in the input data which is used for partitioning the input data" } }, "required": [ "type" ] } } }, "description": "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": { "type": "object", "description": "A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.", "allOf": [ { "type": "object", "description": "The base sub-resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" } }, "x-ms-azure-resource": true } ], "properties": { "properties": { "type": "object", "description": "The properties that are associated with a transformation.", "properties": { "streamingUnits": { "type": "integer", "format": "int32", "description": "Specifies the number of streaming units that the streaming job uses.", "default": 3 }, "validStreamingUnits": { "type": "array", "items": { "type": "integer", "format": "int32", "description": "Specifies the number of streaming units that the streaming job can use." }, "description": "Specifies the valid streaming units a streaming job can scale to." }, "query": { "type": "string", "description": "Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests." }, "etag": { "readOnly": true, "type": "string", "description": "The current entity tag for the transformation. 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." } } } } }, "outputs": { "type": "array", "items": { "type": "object", "description": "An output object, containing all information associated with the named output. All outputs are contained under a streaming job.", "allOf": [ { "type": "object", "description": "The base sub-resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" } }, "x-ms-azure-resource": true } ], "properties": { "properties": { "type": "object", "description": "The properties that are associated with an output.", "properties": { "datasource": { "type": "object", "description": "Describes the data source that output will be written to.", "properties": { "type": { "type": "string", "description": "Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests." } }, "required": [ "type" ] }, "timeWindow": { "type": "string", "description": "The time frame for filtering Stream Analytics job outputs." }, "sizeWindow": { "type": "integer", "format": "int32", "description": "The size window to constrain a Stream Analytics output to." }, "serialization": { "type": "object", "description": "Describes how data from an input is serialized or how data is serialized when written to an output.", "properties": { "type": { "type": "string", "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", "enum": [ "Csv", "Avro", "Json", "Parquet" ], "x-ms-enum": { "name": "EventSerializationType", "modelAsString": true } } }, "required": [ "type" ] }, "diagnostics": { "type": "object", "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.", "properties": { "conditions": { "readOnly": true, "type": "array", "items": { "type": "object", "description": "Condition applicable to the resource, or to the job overall, that warrant customer attention.", "properties": { "since": { "readOnly": true, "type": "string", "description": "The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time." }, "code": { "readOnly": true, "type": "string", "description": "The opaque diagnostic code." }, "message": { "readOnly": true, "type": "string", "description": "The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request." } } }, "x-ms-identifiers": [], "description": "A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention." } } }, "etag": { "readOnly": true, "type": "string", "description": "The current entity tag for the output. 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." } } } } }, "description": "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": { "type": "array", "items": { "type": "object", "description": "A function object, containing all information associated with the named function. All functions are contained under a streaming job.", "allOf": [ { "type": "object", "description": "The base sub-resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" } }, "x-ms-azure-resource": true } ], "properties": { "properties": { "type": "object", "description": "The properties that are associated with a function.", "properties": { "type": { "type": "string", "description": "Indicates the type of function." }, "etag": { "readOnly": true, "type": "string", "description": "The current entity tag for the function. 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." }, "properties": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "type": "object", "description": "Describes one input parameter of a function.", "properties": { "dataType": { "type": "string", "description": "The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx" }, "isConfigurationParameter": { "type": "boolean", "description": "A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false." } } } }, "output": { "type": "object", "description": "Describes the output of a function.", "properties": { "dataType": { "type": "string", "description": "The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx" } } }, "binding": { "type": "object", "description": "The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.", "properties": { "type": { "type": "string", "description": "Indicates the function binding type." } }, "required": [ "type" ] } } } }, "required": [ "type" ] } } }, "description": "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." }, "etag": { "readOnly": true, "type": "string", "description": "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." }, "jobStorageAccount": { "$ref": "#/$defs/JobStorageAccount" }, "contentStoragePolicy": { "readOnly": false, "type": "string", "description": "Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .", "enum": [ "SystemAccount", "JobStorageAccount" ], "x-ms-enum": { "name": "ContentStoragePolicy", "modelAsString": true } }, "cluster": { "$ref": "#/$defs/ClusterInfo" } } } } }