Streaming Jobs - List

Lists all of the streaming jobs in the given subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2017-04-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/streamingjobs?$expand={$expand}&api-version=2017-04-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

$expand
query
  • string

The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.

Responses

Name Type Description
200 OK

Successfully listed the streaming jobs under the given subscription.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List all streaming jobs in a subscription and do not use the $expand OData query parameter
List all streaming jobs in a subscription and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions

List all streaming jobs in a subscription and do not use the $expand OData query parameter

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2017-04-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest",
      "name": "asaClusterTest",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "tags": {
        "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":2}"
      },
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "c5b86804-4b8e-4d99-885f-910ea24b51f4",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Stop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2020-07-15T03:41:25.7Z",
        "compatibilityLevel": "1.2",
        "jobStorageAccount": null,
        "contentStoragePolicy": "SystemAccount",
        "etag": "ba6f6d8e-57e2-45bd-87ba-2b62c259bbcc",
        "jobType": "Cloud",
        "cluster": {
          "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/zhejunASA"
        }
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest",
      "name": "ASAUDFTest",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "tags": {},
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "8b39d20f-d8df-42e0-8198-a20160e4696b",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Stop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2020-07-16T05:56:55.51Z",
        "compatibilityLevel": "1.2",
        "jobStorageAccount": {
          "authenticationMode": "ConnectionString",
          "accountName": "zhejuntest"
        },
        "contentStoragePolicy": "SystemAccount",
        "etag": "bfee3a7f-cdaf-4b1e-b449-71a3b8b4d6d9",
        "jobType": "Edge",
        "externals": {
          "storageAccount": {
            "accountName": "zhejuntest"
          },
          "container": "container2",
          "path": "UserCustomCode.zip"
        },
        "cluster": null
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest",
      "name": "zhejunmltest",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Drop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2020-07-17T08:36:07.463Z",
        "compatibilityLevel": "1.2",
        "jobStorageAccount": null,
        "contentStoragePolicy": "SystemAccount",
        "etag": "89ba3a42-e217-432e-bf23-798dbf001519",
        "jobType": "Cloud",
        "cluster": null
      }
    }
  ],
  "nextLink": null
}

List all streaming jobs in a subscription and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/providers/Microsoft.StreamAnalytics/streamingjobs?$expand=inputs,outputs,transformation,functions&api-version=2017-04-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest",
      "name": "asaClusterTest",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "tags": {
        "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":2}"
      },
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "c5b86804-4b8e-4d99-885f-910ea24b51f4",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Stop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2020-07-15T03:41:25.7Z",
        "compatibilityLevel": "1.2",
        "jobStorageAccount": null,
        "contentStoragePolicy": "SystemAccount",
        "inputs": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/inputs/HistoricalTrafficData",
            "name": "HistoricalTrafficData",
            "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
            "properties": {
              "type": "Reference",
              "datasource": {
                "type": "Microsoft.Storage/Blob",
                "properties": {
                  "storageAccounts": [
                    {
                      "accountName": "zhejuntest"
                    }
                  ],
                  "container": "container1",
                  "pathPattern": "{date}{time}",
                  "dateFormat": "yyyy/MM/dd",
                  "timeFormat": "HH"
                }
              },
              "compression": {
                "type": "None"
              },
              "serialization": {
                "type": "Csv",
                "properties": {
                  "fieldDelimiter": ",",
                  "encoding": "UTF8"
                }
              },
              "etag": "8ffd285f-cc45-4a0a-9e0b-a7cfd7f7130c"
            }
          },
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/inputs/input",
            "name": "input",
            "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
            "properties": {
              "type": "Stream",
              "datasource": {
                "type": "Microsoft.ServiceBus/EventHub",
                "properties": {
                  "consumerGroupName": "1",
                  "eventHubName": "input",
                  "serviceBusNamespace": "azuremlbugbash",
                  "sharedAccessPolicyName": "inputpolicy",
                  "authenticationMode": "ConnectionString"
                }
              },
              "compression": {
                "type": "None"
              },
              "serialization": {
                "type": "Json",
                "properties": {
                  "encoding": "UTF8"
                }
              },
              "etag": "d62c06ad-343b-4631-81cc-2c63c4081869"
            }
          }
        ],
        "transformation": {
          "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/transformations/Transformation",
          "name": "Transformation",
          "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
          "properties": {
            "streamingUnits": 3,
            "query": "-- input refers to the alias of your event hub \r\n\r\nWITH  \r\n\r\nTripData AS ( \r\n\r\n    SELECT TRY_CAST(pickupLat AS float) as pickupLat, \r\n\r\n    TRY_CAST(pickupLon AS float) as pickupLon, \r\n\r\n    passengerCount, TripTimeinSeconds,  \r\n\r\n    pickupTime, VendorID, tripDistanceInMiles \r\n\r\n    FROM input timestamp by pickupTime \r\n\r\n    WHERE pickupLat > -90 AND pickupLat < 90 AND pickupLon > -180 AND pickupLon < 180 \r\n\r\n) \r\n\r\n \r\n\r\n--query 1 \r\n\r\nSELECT count(*), system.timestamp as timestamps \r\n\r\nINTO output \r\n\r\nFROM TripData \r\n\r\nGroup by hoppingwindow(second,60,5) \r\n\r\n \r\n\r\n \r\n\r\n--query 2 where HistoricalTrafficData is the alias of your reference data \r\n\r\nSELECT count(TripData.VendorID) as NbTrips, avg(TripData.passengerCount) as AvgPassenger, avg(TripData.TripTimeinSeconds) as TripTimeinSeconds, System.Timestamp as timestamps, TRY_CAST(HistoricalTrafficData.avgTraffic as bigint) as historicalTraffic \r\n\r\nINTO PBI \r\n\r\nFROM TripData \r\n\r\nJOIN HistoricalTrafficData ON \r\n\r\ndatepart(hour,TripData.pickupTime) = TRY_CAST(HistoricalTrafficData.hour as bigint) \r\n\r\nGroup By TripData.VendorID, HistoricalTrafficData.avgTraffic, hoppingwindow(second,60,5) ",
            "etag": "cc14703e-4d5f-489c-97e4-adf75698b20d"
          }
        },
        "functions": [],
        "outputs": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/outputs/output",
            "name": "output",
            "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
            "properties": {
              "datasource": {
                "type": "Microsoft.Storage/Blob",
                "properties": {
                  "storageAccounts": [
                    {
                      "accountName": "zhejuntest"
                    }
                  ],
                  "container": "output",
                  "pathPattern": "",
                  "dateFormat": "yyyy/MM/dd",
                  "timeFormat": "HH",
                  "authenticationMode": "ConnectionString"
                }
              },
              "timeWindow": "01:59:00",
              "sizeWindow": 1,
              "serialization": {
                "type": "Json",
                "properties": {
                  "encoding": "UTF8",
                  "format": "LineSeparated"
                }
              },
              "etag": "3632dbc3-1a8c-49dc-838d-1f84b709c667"
            }
          }
        ],
        "etag": "ba6f6d8e-57e2-45bd-87ba-2b62c259bbcc",
        "jobType": "Cloud",
        "cluster": {
          "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/zhejunASA"
        }
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest",
      "name": "ASAUDFTest",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "tags": {},
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "8b39d20f-d8df-42e0-8198-a20160e4696b",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Stop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2020-07-16T05:56:55.51Z",
        "compatibilityLevel": "1.2",
        "jobStorageAccount": {
          "authenticationMode": "ConnectionString",
          "accountName": "zhejuntest"
        },
        "contentStoragePolicy": "SystemAccount",
        "inputs": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/inputs/Input",
            "name": "Input",
            "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
            "properties": {
              "type": "Stream",
              "datasource": {
                "type": "GatewayMessageBus"
              },
              "compression": {
                "type": "None"
              },
              "serialization": {
                "type": "Json",
                "properties": {
                  "encoding": "UTF8"
                }
              },
              "etag": "34dcf5e8-d33e-4de3-b413-580fa9316f4b"
            }
          }
        ],
        "transformation": {
          "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/transformations/Transformation",
          "name": "Transformation",
          "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
          "properties": {
            "streamingUnits": null,
            "query": "    SELECT machine.temperature, udf.ASAEdgeUDFDemo_Class1_SquareFunction(try_cast(machine.temperature as bigint))\r\n    INTO Output\r\n    FROM Input",
            "etag": "29beb753-10cb-4627-91df-09dbfea9ac77"
          }
        },
        "functions": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/functions/ASAEdgeUDFDemo_Class1_SquareFunction",
            "name": "ASAEdgeUDFDemo_Class1_SquareFunction",
            "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
            "properties": {
              "type": "Scalar",
              "properties": {
                "inputs": [
                  {
                    "dataType": "any",
                    "isConfigurationParameter": null
                  }
                ],
                "output": {
                  "dataType": "any"
                },
                "binding": {
                  "type": "Microsoft.StreamAnalytics/CLRUdf",
                  "properties": {
                    "dllPath": "ASAEdgeApplication2_CodeBehind",
                    "class": "ASAEdgeUDFDemo.Class1",
                    "method": "SquareFunction"
                  }
                }
              },
              "etag": "c3f6f31b-6b42-42c9-8cb1-1d12d6ab448a"
            }
          }
        ],
        "outputs": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/outputs/Output",
            "name": "Output",
            "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
            "properties": {
              "datasource": {
                "type": "GatewayMessageBus"
              },
              "serialization": {
                "type": "Json",
                "properties": {
                  "encoding": "UTF8",
                  "format": "Array"
                }
              },
              "etag": "c6ba3df6-13af-40af-992f-9317e8537590"
            }
          }
        ],
        "etag": "bfee3a7f-cdaf-4b1e-b449-71a3b8b4d6d9",
        "jobType": "Edge",
        "externals": {
          "storageAccount": {
            "accountName": "zhejuntest"
          },
          "container": "container2",
          "path": "UserCustomCode.zip"
        },
        "cluster": null
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest",
      "name": "zhejunmltest",
      "type": "Microsoft.StreamAnalytics/streamingjobs",
      "location": "West US",
      "properties": {
        "sku": {
          "name": "Standard"
        },
        "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0",
        "provisioningState": "Succeeded",
        "jobState": "Created",
        "eventsOutOfOrderPolicy": "Adjust",
        "outputErrorPolicy": "Drop",
        "eventsOutOfOrderMaxDelayInSeconds": 0,
        "eventsLateArrivalMaxDelayInSeconds": 5,
        "dataLocale": "en-US",
        "createdDate": "2020-07-17T08:36:07.463Z",
        "compatibilityLevel": "1.2",
        "jobStorageAccount": null,
        "contentStoragePolicy": "SystemAccount",
        "inputs": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/inputs/Input",
            "name": "Input",
            "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
            "properties": {
              "type": "Stream",
              "datasource": {
                "type": "Microsoft.Devices/IotHubs",
                "properties": {
                  "iotHubNamespace": "MyASAIoT",
                  "sharedAccessPolicyName": "iothubowner",
                  "endpoint": "messages/events",
                  "consumerGroupName": "$Default"
                }
              },
              "compression": {
                "type": "None"
              },
              "serialization": {
                "type": "Json",
                "properties": {
                  "encoding": "UTF8"
                }
              },
              "etag": "3cb574f7-b63a-4ac1-a1db-8e8a3b88a20d"
            }
          }
        ],
        "transformation": {
          "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/transformations/Transformation",
          "name": "Transformation",
          "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
          "properties": {
            "streamingUnits": 3,
            "query": "\r\nWITH sentiment AS (  \r\nSELECT Temperature, diabetespredict(Temperature) as result \r\nFROM Input  \r\n)  \r\n\r\nSELECT Temperature, result.[Score]  \r\nINTO BlobOutput1\r\nFROM sentiment\r\n\r\n/*\r\nSELECT data, MLFunction2(data)\r\nFROM sampleRequestData\r\n*/\r\n/*\r\nSELECT data, AksArrayScore(data)\r\nFROM sampleData\r\n*/",
            "etag": "7241d411-e71d-4205-b77e-4cc56aba34c0"
          }
        },
        "functions": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/diabetespredict",
            "name": "diabetespredict",
            "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
            "properties": {
              "type": "Scalar",
              "properties": {
                "inputs": [
                  {
                    "dataType": "array",
                    "isConfigurationParameter": null
                  }
                ],
                "output": {
                  "dataType": "float"
                },
                "binding": {
                  "type": "Microsoft.MachineLearningServices",
                  "properties": {
                    "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score",
                    "apiKey": null,
                    "inputs": [
                      {
                        "name": "data",
                        "dataType": "array",
                        "mapTo": 0
                      }
                    ],
                    "outputs": [
                      {
                        "name": "output",
                        "dataType": "double",
                        "mapTo": 0
                      }
                    ],
                    "batchSize": 1000,
                    "numberOfParallelRequests": 1
                  }
                }
              },
              "etag": "acfdd307-418c-48f3-8856-7c176d38529f"
            }
          },
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction2",
            "name": "MLFunction2",
            "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
            "properties": {
              "type": "Scalar",
              "properties": {
                "inputs": [
                  {
                    "dataType": "array",
                    "isConfigurationParameter": null
                  }
                ],
                "output": {
                  "dataType": "float"
                },
                "binding": {
                  "type": "Microsoft.MachineLearningServices",
                  "properties": {
                    "endpoint": "http://13.83.67.157/api/v1/service/nyc-fare-predict/score",
                    "apiKey": null,
                    "inputs": [
                      {
                        "name": "data",
                        "dataType": "array",
                        "mapTo": 0
                      }
                    ],
                    "outputs": [
                      {
                        "name": "output",
                        "dataType": "double",
                        "mapTo": 0
                      }
                    ],
                    "batchSize": 1000,
                    "numberOfParallelRequests": 1
                  }
                }
              },
              "etag": "4d537fa6-f43c-4ee6-a45e-9a8f8002a65c"
            }
          },
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction3",
            "name": "MLFunction3",
            "type": "Microsoft.StreamAnalytics/streamingjobs/functions",
            "properties": {
              "type": "Scalar",
              "properties": {
                "inputs": [
                  {
                    "dataType": "array",
                    "isConfigurationParameter": null
                  }
                ],
                "output": {
                  "dataType": "float"
                },
                "binding": {
                  "type": "Microsoft.MachineLearningServices",
                  "properties": {
                    "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score",
                    "apiKey": null,
                    "inputs": [
                      {
                        "name": "data",
                        "dataType": "array",
                        "mapTo": 0
                      }
                    ],
                    "outputs": [
                      {
                        "name": "output",
                        "dataType": "double",
                        "mapTo": 0
                      }
                    ],
                    "batchSize": 1000,
                    "numberOfParallelRequests": 1
                  }
                }
              },
              "etag": "912f08e7-4a8c-46eb-afaf-d88f930a7b45"
            }
          }
        ],
        "outputs": [
          {
            "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/outputs/BlobOutput1",
            "name": "BlobOutput1",
            "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
            "properties": {
              "datasource": {
                "type": "Microsoft.Storage/Blob",
                "properties": {
                  "storageAccounts": [
                    {
                      "accountName": "zhejuntest2"
                    }
                  ],
                  "container": "output",
                  "pathPattern": "{date}{time}",
                  "dateFormat": "yyyy/MM/dd",
                  "timeFormat": "HH",
                  "authenticationMode": "ConnectionString"
                }
              },
              "serialization": {
                "type": "Json",
                "properties": {
                  "encoding": "UTF8",
                  "format": "LineSeparated"
                }
              },
              "etag": "1c271cd5-dd4a-4d3e-95ee-1dbcaa530c2c"
            }
          }
        ],
        "etag": "89ba3a42-e217-432e-bf23-798dbf001519",
        "jobType": "Cloud",
        "cluster": null
      }
    }
  ],
  "nextLink": null
}

Definitions

AggregateFunctionProperties

The properties that are associated with an aggregate function.

AuthenticationMode

Authentication Mode. Valid modes are ConnectionString, Msi and 'UserToken'.

AvroSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.

AzureDataLakeStoreOutputDataSource

Describes an Azure Data Lake Store output data source.

AzureFunctionOutputDataSource

Defines the metadata of AzureFunctionOutputDataSource

AzureMachineLearningServiceFunctionBinding

The binding to an Azure Machine Learning web service.

AzureMachineLearningServiceInputColumn

Describes an input column for the Azure Machine Learning web service endpoint.

AzureMachineLearningServiceOutputColumn

Describes an output column for the Azure Machine Learning web service endpoint.

AzureMachineLearningStudioFunctionBinding

The binding to an Azure Machine Learning Studio.

AzureMachineLearningStudioInputColumn

Describes an input column for the Azure Machine Learning Studio endpoint.

AzureMachineLearningStudioInputs

The inputs for the Azure Machine Learning Studio endpoint.

AzureMachineLearningStudioOutputColumn

Describes an output column for the Azure Machine Learning Studio endpoint.

AzureSqlDatabaseOutputDataSource

Describes an Azure SQL database output data source.

AzureSqlReferenceInputDataSource

Describes an Azure SQL database reference input data source.

AzureSqlReferenceInputDataSourceProperties
AzureSynapseOutputDataSource

Describes an Azure Synapse output data source.

AzureTableOutputDataSource

Describes an Azure Table output data source.

BlobOutputDataSource

Describes a blob output data source.

BlobReferenceInputDataSource

Describes a blob input data source that contains reference data.

BlobStreamInputDataSource

Describes a blob input data source that contains stream data.

ClusterInfo

The properties associated with a Stream Analytics cluster.

CompatibilityLevel

Controls certain runtime behaviors of the streaming job.

Compression

Describes how input data is compressed

ContentStoragePolicy

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

CSharpFunctionBinding

The binding to a CSharp function.

CsvSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.

CustomClrSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in custom format.

DiagnosticCondition

Condition applicable to the resource, or to the job overall, that warrant customer attention.

Diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

DocumentDbOutputDataSource

Describes a DocumentDB output data source.

Encoding

Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.

EventHubOutputDataSource

Describes an Event Hub output data source.

EventHubStreamInputDataSource

Describes an Event Hub input data source that contains stream data.

EventHubV2OutputDataSource

Describes an Event Hub output data source.

EventHubV2StreamInputDataSource

Describes an Event Hub input data source that contains stream data.

EventSerializationType

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

EventsOutOfOrderPolicy

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

External

The storage account where the custom code artifacts are located.

Function

A function object, containing all information associated with the named function. All functions are contained under a streaming job.

FunctionInput

Describes one input parameter of a function.

FunctionOutput

Describes the output of a function.

Identity

Describes how identity is verified

Input

An input object, containing all information associated with the named input. All inputs are contained under a streaming job.

IoTHubStreamInputDataSource

Describes an IoT Hub input data source that contains stream data.

JavaScriptFunctionBinding

The binding to a JavaScript function.

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

JsonOutputSerializationFormat

Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.

JsonSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.

Output

An output object, containing all information associated with the named output. All outputs are contained under a streaming job.

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

OutputStartMode

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.

ParquetSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.

PowerBIOutputDataSource

Describes a Power BI output data source.

ReferenceInputProperties

The properties that are associated with an input containing reference data.

ScalarFunctionProperties

The properties that are associated with a scalar function.

ServiceBusQueueOutputDataSource

Describes a Service Bus Queue output data source.

ServiceBusTopicOutputDataSource

Describes a Service Bus Topic output data source.

StorageAccount

The properties that are associated with an Azure Storage account

StreamingJob

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

StreamingJobListResult

Object containing a list of streaming jobs.

StreamingJobSku

The properties that are associated with a SKU.

StreamingJobSkuName

The name of the SKU. Required on PUT (CreateOrReplace) requests.

StreamInputProperties

The properties that are associated with an input containing stream data.

Transformation

A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.

AggregateFunctionProperties

The properties that are associated with an aggregate function.

Name Type Description
etag
  • string

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.binding FunctionBinding:

The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.

properties.inputs

Describes one input parameter of a function.

properties.output

Describes the output of a function.

type string:
  • Aggregate

Indicates the type of function.

AuthenticationMode

Authentication Mode. Valid modes are ConnectionString, Msi and 'UserToken'.

Name Type Description
ConnectionString
  • string
Msi
  • string
UserToken
  • string

AvroSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.

Name Type Description
type string:
  • Avro

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

AzureDataLakeStoreOutputDataSource

Describes an Azure Data Lake Store output data source.

Name Type Description
properties.accountName
  • string

The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests.

properties.authenticationMode

Authentication Mode.

properties.dateFormat
  • string

The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead.

properties.filePathPrefix
  • string

The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests.

properties.refreshToken
  • string

A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.

properties.tenantId
  • string

The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests.

properties.timeFormat
  • string

The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead.

properties.tokenUserDisplayName
  • string

The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

properties.tokenUserPrincipalName
  • string

The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

type string:
  • Microsoft.DataLake/Accounts

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureFunctionOutputDataSource

Defines the metadata of AzureFunctionOutputDataSource

Name Type Description
properties.apiKey
  • string

If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.

properties.functionAppName
  • string

The name of your Azure Functions app.

properties.functionName
  • string

The name of the function in your Azure Functions app.

properties.maxBatchCount
  • number

A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100.

properties.maxBatchSize
  • number

A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB).

type string:
  • Microsoft.AzureFunction

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureMachineLearningServiceFunctionBinding

The binding to an Azure Machine Learning web service.

Name Type Description
properties.apiKey
  • string

The API key used to authenticate with Request-Response endpoint.

properties.batchSize
  • integer

Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.

properties.endpoint
  • string

The Request-Response execute endpoint of the Azure Machine Learning web service.

properties.inputs

The inputs for the Azure Machine Learning web service endpoint.

properties.numberOfParallelRequests
  • integer

The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1.

properties.outputs

A list of outputs from the Azure Machine Learning web service endpoint execution.

type string:
  • Microsoft.MachineLearningServices

Indicates the function binding type.

AzureMachineLearningServiceInputColumn

Describes an input column for the Azure Machine Learning web service endpoint.

Name Type Description
dataType
  • string

The (Azure Machine Learning supported) data type of the input column.

mapTo
  • integer

The zero based index of the function parameter this input maps to.

name
  • string

The name of the input column.

AzureMachineLearningServiceOutputColumn

Describes an output column for the Azure Machine Learning web service endpoint.

Name Type Description
dataType
  • string

The (Azure Machine Learning supported) data type of the output column.

mapTo
  • integer

The zero based index of the function parameter this input maps to.

name
  • string

The name of the output column.

AzureMachineLearningStudioFunctionBinding

The binding to an Azure Machine Learning Studio.

Name Type Description
properties.apiKey
  • string

The API key used to authenticate with Request-Response endpoint.

properties.batchSize
  • integer

Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.

properties.endpoint
  • string

The Request-Response execute endpoint of the Azure Machine Learning Studio. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs

properties.inputs

The inputs for the Azure Machine Learning Studio endpoint.

properties.outputs

A list of outputs from the Azure Machine Learning Studio endpoint execution.

type string:
  • Microsoft.MachineLearning/WebService

Indicates the function binding type.

AzureMachineLearningStudioInputColumn

Describes an input column for the Azure Machine Learning Studio endpoint.

Name Type Description
dataType
  • string

The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .

mapTo
  • integer

The zero based index of the function parameter this input maps to.

name
  • string

The name of the input column.

AzureMachineLearningStudioInputs

The inputs for the Azure Machine Learning Studio endpoint.

Name Type Description
columnNames

A list of input columns for the Azure Machine Learning Studio endpoint.

name
  • string

The name of the input. This is the name provided while authoring the endpoint.

AzureMachineLearningStudioOutputColumn

Describes an output column for the Azure Machine Learning Studio endpoint.

Name Type Description
dataType
  • string

The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .

name
  • string

The name of the output column.

AzureSqlDatabaseOutputDataSource

Describes an Azure SQL database output data source.

Name Type Description
properties.authenticationMode

Authentication Mode.

properties.database
  • string

The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.maxBatchCount
  • number

Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests.

properties.maxWriterCount
  • number

Max Write r count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests.

properties.password
  • string

The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.server
  • string

The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.table
  • string

The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.user
  • string

The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.Sql/Server/Database

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureSqlReferenceInputDataSource

Describes an Azure SQL database reference input data source.

Name Type Description
properties
type string:
  • Microsoft.Sql/Server/Database

Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

AzureSqlReferenceInputDataSourceProperties

Name Type Description
database
  • string

This element is associated with the datasource element. This is the name of the database that output will be written to.

deltaSnapshotQuery
  • string

This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database.

fullSnapshotQuery
  • string

This element is associated with the datasource element. This query is used to fetch data from the sql database.

password
  • string

This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance.

refreshRate
  • string

This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format.

refreshType
  • string

This element is associated with the datasource element. This element is of enum type. It indicates what kind of data refresh option do we want to use:Static/RefreshPeriodicallyWithFull/RefreshPeriodicallyWithDelta

server
  • string

This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.

table
  • string

This element is associated with the datasource element. The name of the table in the Azure SQL database..

user
  • string

This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance.

AzureSynapseOutputDataSource

Describes an Azure Synapse output data source.

Name Type Description
properties.database
  • string

The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.password
  • string

The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.server
  • string

The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.table
  • string

The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests.

properties.user
  • string

The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.Sql/Server/DataWarehouse

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

AzureTableOutputDataSource

Describes an Azure Table output data source.

Name Type Description
properties.accountKey
  • string

The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.

properties.accountName
  • string

The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

properties.batchSize
  • integer

The number of rows to write to the Azure Table at a time.

properties.columnsToRemove
  • string[]

If specified, each item in the array is the name of a column to remove (if present) from output event entities.

properties.partitionKey
  • string

This element indicates the name of a column from the SELECT statement in the query that will be used as the partition key for the Azure Table. Required on PUT (CreateOrReplace) requests.

properties.rowKey
  • string

This element indicates the name of a column from the SELECT statement in the query that will be used as the row key for the Azure Table. Required on PUT (CreateOrReplace) requests.

properties.table
  • string

The name of the Azure Table. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.Storage/Table

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

BlobOutputDataSource

Describes a blob output data source.

Name Type Description
properties.authenticationMode

Authentication Mode.

properties.container
  • string

The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.

properties.dateFormat
  • string

The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.

properties.pathPattern
  • string

The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.

properties.storageAccounts

A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.

properties.timeFormat
  • string

The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.

type string:
  • Microsoft.Storage/Blob

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

BlobReferenceInputDataSource

Describes a blob input data source that contains reference data.

Name Type Description
properties.container
  • string

The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.

properties.dateFormat
  • string

The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.

properties.pathPattern
  • string

The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.

properties.storageAccounts

A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.

properties.timeFormat
  • string

The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.

type string:
  • Microsoft.Storage/Blob

Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

BlobStreamInputDataSource

Describes a blob input data source that contains stream data.

Name Type Description
properties.container
  • string

The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.

properties.dateFormat
  • string

The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.

properties.pathPattern
  • string

The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.

properties.sourcePartitionCount
  • integer

The partition count of the blob input data source. Range 1 - 256.

properties.storageAccounts

A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.

properties.timeFormat
  • string

The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.

type string:
  • Microsoft.Storage/Blob

Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

ClusterInfo

The properties associated with a Stream Analytics cluster.

Name Type Description
id
  • string

The resource id of cluster.

CompatibilityLevel

Controls certain runtime behaviors of the streaming job.

Name Type Description
1.0
  • string

Compression

Describes how input data is compressed

Name Type Description
type
  • string

ContentStoragePolicy

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

Name Type Description
JobStorageAccount
  • string
SystemAccount
  • string

CSharpFunctionBinding

The binding to a CSharp function.

Name Type Description
properties.class
  • string

The Csharp code containing a single function definition.

properties.dllPath
  • string

The Csharp code containing a single function definition.

properties.method
  • string

The Csharp code containing a single function definition.

properties.script
  • string

The Csharp code containing a single function definition.

type string:
  • Microsoft.StreamAnalytics/CLRUdf

Indicates the function binding type.

CsvSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.

Name Type Description
properties.encoding

Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.

properties.fieldDelimiter
  • string

Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests.

type string:
  • Csv

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

CustomClrSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in custom format.

Name Type Description
properties.serializationClassName
  • string

The serialization class name.

properties.serializationDllPath
  • string

The serialization library path.

type string:
  • CustomClr

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

DiagnosticCondition

Condition applicable to the resource, or to the job overall, that warrant customer attention.

Name Type Description
code
  • string

The opaque diagnostic code.

message
  • string

The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request.

since
  • string

The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time.

Diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

Name Type Description
conditions

A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention.

DocumentDbOutputDataSource

Describes a DocumentDB output data source.

Name Type Description
properties.accountId
  • string

The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests.

properties.accountKey
  • string

The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests.

properties.collectionNamePattern
  • string

The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.

properties.database
  • string

The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests.

properties.documentId
  • string

The name of the field in output events used to specify the primary key which insert or update operations are based on.

properties.partitionKey
  • string

The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified.

type string:
  • Microsoft.Storage/DocumentDB

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

Encoding

Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.

Name Type Description
UTF8
  • string

EventHubOutputDataSource

Describes an Event Hub output data source.

Name Type Description
authenticationMode

Authentication Mode.

properties.eventHubName
  • string

The name of the Event Hub. Required on PUT (CreateOrReplace) requests.

properties.partitionKey
  • string

The key/column that is used to determine to which partition to send event data.

properties.propertyColumns
  • string[]
serviceBusNamespace
  • string

The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyName
  • string

The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.ServiceBus/EventHub

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

EventHubStreamInputDataSource

Describes an Event Hub input data source that contains stream data.

Name Type Description
authenticationMode

Authentication Mode.

properties.consumerGroupName
  • string

The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.

properties.eventHubName
  • string

The name of the Event Hub. Required on PUT (CreateOrReplace) requests.

serviceBusNamespace
  • string

The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyName
  • string

The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.ServiceBus/EventHub

Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

EventHubV2OutputDataSource

Describes an Event Hub output data source.

Name Type Description
authenticationMode

Authentication Mode.

properties.eventHubName
  • string

The name of the Event Hub. Required on PUT (CreateOrReplace) requests.

properties.partitionKey
  • string

The key/column that is used to determine to which partition to send event data.

properties.propertyColumns
  • string[]
serviceBusNamespace
  • string

The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyName
  • string

The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.EventHub/EventHub

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

EventHubV2StreamInputDataSource

Describes an Event Hub input data source that contains stream data.

Name Type Description
authenticationMode

Authentication Mode.

properties.consumerGroupName
  • string

The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.

properties.eventHubName
  • string

The name of the Event Hub. Required on PUT (CreateOrReplace) requests.

serviceBusNamespace
  • string

The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

sharedAccessPolicyName
  • string

The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.EventHub/EventHub

Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

EventSerializationType

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

Name Type Description
Avro
  • string
Csv
  • string
CustomClr
  • string
Json
  • string
Parquet
  • string

EventsOutOfOrderPolicy

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

Name Type Description
Adjust
  • string
Drop
  • string

External

The storage account where the custom code artifacts are located.

Name Type Description
container
  • string
path
  • string
storageAccount

The properties that are associated with an Azure Storage account

Function

A function object, containing all information associated with the named function. All functions are contained under a streaming job.

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties FunctionProperties:

The properties that are associated with a function.

type
  • string

Resource type

FunctionInput

Describes one input parameter of a function.

Name Type Description
dataType
  • string

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
  • boolean

A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.

FunctionOutput

Describes the output of a function.

Name Type Description
dataType
  • string

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

Identity

Describes how identity is verified

Name Type Description
principalId
  • string
tenantId
  • string
type
  • string

Input

An input object, containing all information associated with the named input. All inputs are contained under a streaming job.

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties InputProperties:

The properties that are associated with an input. Required on PUT (CreateOrReplace) requests.

type
  • string

Resource type

IoTHubStreamInputDataSource

Describes an IoT Hub input data source that contains stream data.

Name Type Description
properties.consumerGroupName
  • string

The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.

properties.endpoint
  • string

The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).

properties.iotHubNamespace
  • string

The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.

properties.sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

properties.sharedAccessPolicyName
  • string

The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.Devices/IotHubs

Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

JavaScriptFunctionBinding

The binding to a JavaScript function.

Name Type Description
properties.script
  • string

The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'

type string:
  • Microsoft.StreamAnalytics/JavascriptUdf

Indicates the function binding type.

JobStorageAccount

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

Name Type Description
accountKey
  • string

The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.

accountName
  • string

The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

authenticationMode

Authentication Mode.

JobType

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

Name Type Description
Cloud
  • string
Edge
  • string

JsonOutputSerializationFormat

Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.

Name Type Description
Array
  • string
LineSeparated
  • string

JsonSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.

Name Type Description
properties.encoding

Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.

properties.format

This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null.

type string:
  • Json

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

Output

An output object, containing all information associated with the named output. All outputs are contained under a streaming job.

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties.datasource OutputDataSource:

Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests.

properties.diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

properties.etag
  • string

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.

properties.serialization Serialization:

Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.

properties.sizeWindow
  • number
properties.timeWindow
  • string
type
  • string

Resource type

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

Name Type Description
Drop
  • string
Stop
  • string

OutputStartMode

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.

Name Type Description
CustomTime
  • string
JobStartTime
  • string
LastOutputEventTime
  • string

ParquetSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.

Name Type Description
type string:
  • Parquet

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

PowerBIOutputDataSource

Describes a Power BI output data source.

Name Type Description
properties.authenticationMode

Authentication Mode.

properties.dataset
  • string

The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests.

properties.groupId
  • string

The ID of the Power BI group.

properties.groupName
  • string

The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.

properties.refreshToken
  • string

A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.

properties.table
  • string

The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests.

properties.tokenUserDisplayName
  • string

The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

properties.tokenUserPrincipalName
  • string

The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

type string:
  • PowerBI

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

ReferenceInputProperties

The properties that are associated with an input containing reference data.

Name Type Description
compression

Describes how input data is compressed

datasource ReferenceInputDataSource:

Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests.

diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

etag
  • string

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.

partitionKey
  • string

partitionKey Describes a key in the input data which is used for partitioning the input data

serialization Serialization:

Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.

type string:
  • Reference

Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.

ScalarFunctionProperties

The properties that are associated with a scalar function.

Name Type Description
etag
  • string

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.binding FunctionBinding:

The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.

properties.inputs

Describes one input parameter of a function.

properties.output

Describes the output of a function.

type string:
  • Scalar

Indicates the type of function.

ServiceBusQueueOutputDataSource

Describes a Service Bus Queue output data source.

Name Type Description
properties.authenticationMode

Authentication Mode.

properties.propertyColumns
  • string[]

A string array of the names of output columns to be attached to Service Bus messages as custom properties.

properties.queueName
  • string

The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests.

properties.serviceBusNamespace
  • string

The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

properties.sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

properties.sharedAccessPolicyName
  • string

The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

properties.systemPropertyColumns
  • object
type string:
  • Microsoft.ServiceBus/Queue

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

ServiceBusTopicOutputDataSource

Describes a Service Bus Topic output data source.

Name Type Description
properties.authenticationMode

Authentication Mode.

properties.propertyColumns
  • string[]

A string array of the names of output columns to be attached to Service Bus messages as custom properties.

properties.serviceBusNamespace
  • string

The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

properties.sharedAccessPolicyKey
  • string

The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.

properties.sharedAccessPolicyName
  • string

The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.

properties.systemPropertyColumns
  • object
properties.topicName
  • string

The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests.

type string:
  • Microsoft.ServiceBus/Topic

Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests.

StorageAccount

The properties that are associated with an Azure Storage account

Name Type Description
accountKey
  • string

The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.

accountName
  • string

The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

StreamingJob

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

Name Type Description
id
  • string

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

identity

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

location
  • string

The geo-location where the resource lives

name
  • string

The name of the resource

properties.cluster

The cluster which streaming jobs will run on.

properties.compatibilityLevel

Controls certain runtime behaviors of the streaming job.

properties.contentStoragePolicy

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

properties.createdDate
  • string

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

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

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

properties.eventsLateArrivalMaxDelayInSeconds
  • integer

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.

properties.eventsOutOfOrderMaxDelayInSeconds
  • integer

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

properties.eventsOutOfOrderPolicy

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

properties.externals

The storage account where the custom code artifacts are located.

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

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

properties.jobId
  • string

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

properties.jobState
  • string

Describes the state of the streaming job.

properties.jobStorageAccount

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

properties.jobType

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

properties.lastOutputEventTime
  • string

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.

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

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

properties.outputStartTime
  • string

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.

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

properties.provisioningState
  • string

Describes the provisioning status of the streaming job.

properties.sku

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

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

tags
  • object

Resource tags.

type
  • string

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

StreamingJobListResult

Object containing a list of streaming jobs.

Name Type Description
nextLink
  • string

The link (url) to the next page of results.

value

A list of streaming jobs. Populated by a 'List' operation.

StreamingJobSku

The properties that are associated with a SKU.

Name Type Description
name

The name of the SKU. Required on PUT (CreateOrReplace) requests.

StreamingJobSkuName

The name of the SKU. Required on PUT (CreateOrReplace) requests.

Name Type Description
Standard
  • string

StreamInputProperties

The properties that are associated with an input containing stream data.

Name Type Description
compression

Describes how input data is compressed

datasource StreamInputDataSource:

Describes an input data source that contains stream data. Required on PUT (CreateOrReplace) requests.

diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

etag
  • string

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.

partitionKey
  • string

partitionKey Describes a key in the input data which is used for partitioning the input data

serialization Serialization:

Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.

type string:
  • Stream

Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.

Transformation

A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties.etag
  • string

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.

properties.query
  • string

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.

properties.streamingUnits
  • integer

Specifies the number of streaming units that the streaming job uses.

type
  • string

Resource type