diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json index 0ed2b6255799..21e6eaf74a24 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json @@ -200,6 +200,14 @@ "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region to which the request is sent. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/", + "x-ms-parameter-location": "method" } } } diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_CompileQuery.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_CompileQuery.json new file mode 100644 index 000000000000..6a389438a862 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_CompileQuery.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "compileQuery": { + "query": "SELECT\r\n *\r\nINTO\r\n [output1]\r\nFROM\r\n [input1]", + "inputs": [ + { + "name": "input1", + "type": "Stream" + } + ], + "functions": [ + { + "name": "function1", + "type": "Scalar", + "bindingType": "Microsoft.StreamAnalytics/JavascriptUdf", + "inputs": [ + { + "dataType": "any", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "bigint" + } + } + ], + "jobType": "Cloud", + "compatibilityLevel": "1.2" + } + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "message": "Query failed to compile.", + "isGlobal": true + } + ], + "inputs": [ + "inputtest" + ], + "outputs": [ + "outputtest" + ], + "functions": [ + "transformationtest" + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_SampleInput.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_SampleInput.json new file mode 100644 index 000000000000..c5015cc6c2c5 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_SampleInput.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "sampleInput": { + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "sourcePartitionCount": 16 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + }, + "compatibilityLevel": "1.2", + "eventsUri": "http://myoutput.com", + "dataLocale": "en-US" + } + }, + "responses": { + "202": { + "body": { + "status": "ReadAllEventsInRange", + "diagnostics": [ + "" + ], + "eventsDownloadUrl": "http://myoutput.com", + "lastArrivalTime": "2020-12-05T14:35:00Z" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestInput.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestInput.json new file mode 100644 index 000000000000..24bc6ca20419 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestInput.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "testInput": { + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "sourcePartitionCount": 16 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "status": "TestSuceeded" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestOutput.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestOutput.json new file mode 100644 index 000000000000..d016882c7994 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestOutput.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "testOutput": { + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "accountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "status": "TestSuceeded" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestQuery.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestQuery.json new file mode 100644 index 000000000000..f4bce8a44f88 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestQuery.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "testQuery": { + "diagnostics": { + "writeUri": "http://myoutput.com", + "path": "/pathto/subdirectory" + }, + "streamingJob": { + "properties": { + "sku": { + "name": "Standard" + }, + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "compatibilityLevel": "1.0", + "inputs": [ + { + "properties": { + "type": "Stream", + "datasource": { + "type": "Raw", + "properties": { + "payloadUri": "http://myinput.com" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + }, + "name": "inputtest" + } + ], + "transformation": { + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest" + }, + "name": "transformationtest" + }, + "outputs": [ + { + "properties": { + "datasource": { + "type": "Raw", + "properties": { + "payloadUri": "http://myoutput.com" + } + }, + "serialization": { + "type": "Json" + } + }, + "name": "outputtest" + } + ], + "functions": [] + }, + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + } + } + } + }, + "responses": { + "200": { + "body": { + "status": "Success", + "outputUri": "http://myoutput.com" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json index b33a07742e00..403d9ab28c89 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json @@ -120,6 +120,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -183,6 +189,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -220,6 +232,12 @@ }, "204": { "description": "The function does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -266,6 +284,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -309,6 +333,12 @@ "schema": { "$ref": "#/definitions/FunctionListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -366,12 +396,18 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/RetrieveDefaultDefinition": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/retrieveDefaultDefinition": { "post": { "tags": [ "Functions" @@ -415,6 +451,12 @@ "schema": { "$ref": "#/definitions/Function" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -423,6 +465,7 @@ "definitions": { "Function": { "description": "A function object, containing all information associated with the named function. All functions are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -437,6 +480,7 @@ }, "FunctionProperties": { "description": "The properties that are associated with a function.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -458,6 +502,7 @@ ] }, "FunctionConfiguration": { + "type": "object", "properties": { "inputs": { "type": "array", @@ -475,6 +520,7 @@ }, "ScalarFunctionProperties": { "description": "The properties that are associated with a scalar function.", + "type": "object", "x-ms-discriminator-value": "Scalar", "allOf": [ { @@ -484,6 +530,7 @@ }, "FunctionInput": { "description": "Describes one input parameter of a function.", + "type": "object", "properties": { "dataType": { "type": "string", @@ -497,6 +544,7 @@ }, "FunctionOutput": { "description": "Describes the output of a function.", + "type": "object", "properties": { "dataType": { "type": "string", @@ -506,6 +554,7 @@ }, "FunctionBinding": { "description": "The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -519,6 +568,7 @@ }, "AzureMachineLearningStudioFunctionBinding": { "description": "The binding to an Azure Machine Learning Studio.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", "allOf": [ { @@ -535,6 +585,7 @@ }, "AzureMachineLearningStudioFunctionBindingProperties": { "description": "The binding properties associated with an Azure Machine learning Studio.", + "type": "object", "properties": { "endpoint": { "type": "string", @@ -564,6 +615,7 @@ }, "AzureMachineLearningStudioInputs": { "description": "The inputs for the Azure Machine Learning Studio endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -580,6 +632,7 @@ }, "AzureMachineLearningStudioInputColumn": { "description": "Describes an input column for the Azure Machine Learning Studio endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -598,6 +651,7 @@ }, "AzureMachineLearningStudioOutputColumn": { "description": "Describes an output column for the Azure Machine Learning Studio endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -611,6 +665,7 @@ }, "JavaScriptFunctionBinding": { "description": "The binding to a JavaScript function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", "allOf": [ { @@ -627,6 +682,7 @@ }, "JavaScriptFunctionBindingProperties": { "description": "The binding properties associated with a JavaScript function.", + "type": "object", "properties": { "script": { "type": "string", @@ -636,6 +692,7 @@ }, "CSharpFunctionBinding": { "description": "The binding to a CSharp function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/CLRUdf", "allOf": [ { @@ -652,6 +709,7 @@ }, "CSharpFunctionBindingProperties": { "description": "The binding properties associated with a CSharp function.", + "type": "object", "properties": { "script": { "type": "string", @@ -673,6 +731,7 @@ }, "FunctionRetrieveDefaultDefinitionParameters": { "description": "Parameters used to specify the type of function to retrieve the default definition for.", + "type": "object", "discriminator": "bindingType", "properties": { "bindingType": { @@ -686,6 +745,7 @@ }, "AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning Studio function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", "allOf": [ { @@ -702,6 +762,7 @@ }, "AzureMachineLearningStudioFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with an Azure Machine learning Studio.", + "type": "object", "properties": { "executeEndpoint": { "type": "string", @@ -715,6 +776,7 @@ }, "AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning web service function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearningServices", "allOf": [ { @@ -731,6 +793,7 @@ }, "AzureMachineLearningServiceFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with an Azure Machine learning web service.", + "type": "object", "properties": { "executeEndpoint": { "type": "string", @@ -744,6 +807,7 @@ }, "JavaScriptFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for a JavaScript function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", "allOf": [ { @@ -760,6 +824,7 @@ }, "JavaScriptFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with a JavaScript function.", + "type": "object", "properties": { "script": { "type": "string", @@ -773,6 +838,7 @@ }, "CSharpFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for a CSharp function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/CLRUdf", "allOf": [ { @@ -789,6 +855,7 @@ }, "CSharpFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with a CSharp function.", + "type": "object", "properties": { "script": { "type": "string", @@ -802,6 +869,7 @@ }, "AzureMachineLearningServiceFunctionBinding": { "description": "The binding to an Azure Machine Learning web service.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearningServices", "allOf": [ { @@ -818,6 +886,7 @@ }, "AzureMachineLearningServiceFunctionBindingProperties": { "description": "The binding properties associated with an Azure Machine learning web service.", + "type": "object", "properties": { "endpoint": { "type": "string", @@ -855,6 +924,7 @@ }, "AzureMachineLearningServiceInputs": { "description": "The inputs for the Azure Machine Learning web service endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -871,6 +941,7 @@ }, "AzureMachineLearningServiceInputColumn": { "description": "Describes an input column for the Azure Machine Learning web service endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -889,6 +960,7 @@ }, "AzureMachineLearningServiceOutputColumn": { "description": "Describes an output column for the Azure Machine Learning web service endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -906,6 +978,7 @@ } }, "FunctionListResult": { + "description": "Object containing a list of functions under a streaming job.", "properties": { "value": { "type": "array", @@ -920,8 +993,7 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of functions under a streaming job." + } }, "UdfType": { "type": "string", @@ -936,6 +1008,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, @@ -956,6 +1029,7 @@ }, "AggregateFunctionProperties": { "description": "The properties that are associated with an aggregate function.", + "type": "object", "x-ms-discriminator-value": "Aggregate", "allOf": [ { diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json index 51178cc6130c..c9cae92eed52 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json @@ -120,6 +120,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -189,6 +195,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -226,6 +238,12 @@ }, "204": { "description": "The input does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -278,6 +296,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -324,6 +348,12 @@ "schema": { "$ref": "#/definitions/InputListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -378,6 +408,12 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -387,6 +423,7 @@ "definitions": { "Input": { "description": "An input object, containing all information associated with the named input. All inputs are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -401,6 +438,7 @@ }, "InputProperties": { "description": "The properties that are associated with an input.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -435,6 +473,7 @@ }, "StreamInputProperties": { "description": "The properties that are associated with an input containing stream data.", + "type": "object", "x-ms-discriminator-value": "Stream", "allOf": [ { @@ -450,6 +489,7 @@ }, "ReferenceInputProperties": { "description": "The properties that are associated with an input containing reference data.", + "type": "object", "x-ms-discriminator-value": "Reference", "allOf": [ { @@ -465,6 +505,7 @@ }, "StreamInputDataSource": { "description": "Describes an input data source that contains stream data.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -478,6 +519,7 @@ }, "BlobStreamInputDataSource": { "description": "Describes a blob input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Blob", "allOf": [ { @@ -494,6 +536,7 @@ }, "BlobStreamInputDataSourceProperties": { "description": "The properties that are associated with a blob input containing stream data.", + "type": "object", "allOf": [ { "$ref": "#/definitions/BlobDataSourceProperties" @@ -509,6 +552,7 @@ }, "EventHubStreamInputDataSource": { "description": "Describes an Event Hub input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", "allOf": [ { @@ -525,6 +569,7 @@ }, "EventHubV2StreamInputDataSource": { "description": "Describes an Event Hub input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", "allOf": [ { @@ -541,6 +586,7 @@ }, "EventHubStreamInputDataSourceProperties": { "description": "The properties that are associated with a Event Hub input containing stream data.", + "type": "object", "allOf": [ { "$ref": "#/definitions/EventHubDataSourceProperties" @@ -555,6 +601,7 @@ }, "IoTHubStreamInputDataSource": { "description": "Describes an IoT Hub input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Devices/IotHubs", "allOf": [ { @@ -571,6 +618,7 @@ }, "IoTHubStreamInputDataSourceProperties": { "description": "The properties that are associated with a IoT Hub input containing stream data.", + "type": "object", "properties": { "iotHubNamespace": { "type": "string", @@ -594,8 +642,26 @@ } } }, + "RawStreamInputDataSource": { + "description": "Describes a raw input data source that contains stream data. This data source type is only applicable/usable when using the query testing API. You cannot create a job with this data source type or add an input of this data source type to an existing job.", + "type": "object", + "x-ms-discriminator-value": "Raw", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RawInputDatasourceProperties", + "description": "The properties that are associated with a raw input. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, "ReferenceInputDataSource": { "description": "Describes an input data source that contains reference data.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -609,6 +675,7 @@ }, "BlobReferenceInputDataSource": { "description": "Describes a blob input data source that contains reference data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Blob", "allOf": [ { @@ -625,6 +692,7 @@ }, "BlobReferenceInputDataSourceProperties": { "description": "The properties that are associated with a blob input containing reference data.", + "type": "object", "allOf": [ { "$ref": "#/definitions/BlobDataSourceProperties" @@ -632,8 +700,26 @@ ], "properties": {} }, + "RawReferenceInputDataSource": { + "description": "Describes a raw input data source that contains reference data. This data source type is only applicable/usable when using the query testing API. You cannot create a job with this data source type or add an input of this data source type to an existing job.", + "type": "object", + "x-ms-discriminator-value": "Raw", + "allOf": [ + { + "$ref": "#/definitions/ReferenceInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RawInputDatasourceProperties", + "description": "The properties that are associated with a raw input containing reference data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, "BlobDataSourceProperties": { "description": "The properties that are associated with a blob data source.", + "type": "object", "properties": { "storageAccounts": { "type": "array", @@ -660,8 +746,23 @@ } } }, + "RawInputDatasourceProperties": { + "description": "The properties that are associated with a raw input.", + "type": "object", + "properties": { + "payload": { + "description": "The JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. ", + "type": "string" + }, + "payloadUri": { + "description": "The SAS URL to a blob containing the JSON serialized content of the input data. Either payload or payloadUri must be set, but not both.", + "type": "string" + } + } + }, "StorageAccount": { "description": "The properties that are associated with an Azure Storage account", + "type": "object", "properties": { "accountName": { "type": "string", @@ -675,6 +776,7 @@ }, "ServiceBusDataSourceProperties": { "description": "The common properties that are associated with Service Bus data sources (Queues, Topics, Event Hubs, etc.).", + "type": "object", "properties": { "serviceBusNamespace": { "type": "string", @@ -696,6 +798,7 @@ }, "EventHubDataSourceProperties": { "description": "The common properties that are associated with Event Hub data sources.", + "type": "object", "allOf": [ { "$ref": "#/definitions/ServiceBusDataSourceProperties" @@ -710,6 +813,7 @@ }, "Diagnostics": { "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.", + "type": "object", "properties": { "conditions": { "readOnly": true, @@ -723,6 +827,7 @@ }, "DiagnosticCondition": { "description": "Condition applicable to the resource, or to the job overall, that warrant customer attention.", + "type": "object", "properties": { "since": { "readOnly": true, @@ -742,6 +847,8 @@ } }, "InputListResult": { + "description": "Object containing a list of inputs under a streaming job.", + "type": "object", "properties": { "value": { "type": "array", @@ -756,11 +863,11 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of inputs under a streaming job." + } }, "Serialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -773,6 +880,7 @@ }, "ParquetSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.", + "type": "object", "x-ms-discriminator-value": "Parquet", "allOf": [ { @@ -789,10 +897,12 @@ }, "ParquetSerializationProperties": { "description": "The properties that are associated with the Parquet serialization type.", + "type": "object", "properties": {} }, "CustomClrSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in custom format.", + "type": "object", "x-ms-discriminator-value": "CustomClr", "allOf": [ { @@ -809,6 +919,7 @@ }, "CustomClrSerializationProperties": { "description": "The properties that are associated with the CustomClr serialization type.", + "type": "object", "properties": { "serializationDllPath": { "type": "string", @@ -822,6 +933,7 @@ }, "CsvSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.", + "type": "object", "x-ms-discriminator-value": "Csv", "allOf": [ { @@ -838,6 +950,7 @@ }, "CsvSerializationProperties": { "description": "The properties that are associated with the CSV serialization type.", + "type": "object", "properties": { "fieldDelimiter": { "type": "string", @@ -851,6 +964,7 @@ }, "JsonSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.", + "type": "object", "x-ms-discriminator-value": "Json", "allOf": [ { @@ -867,6 +981,7 @@ }, "JsonSerializationProperties": { "description": "The properties that are associated with the JSON serialization type.", + "type": "object", "properties": { "encoding": { "$ref": "#/definitions/Encoding", @@ -880,6 +995,7 @@ }, "AvroSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.", + "type": "object", "x-ms-discriminator-value": "Avro", "allOf": [ { @@ -896,6 +1012,7 @@ }, "AvroSerializationProperties": { "description": "The properties that are associated with the Avro serialization type.", + "type": "object", "properties": {} }, "Encoding": { @@ -923,6 +1040,7 @@ }, "ResourceTestStatus": { "description": "Describes the status of the test operation along with error information, if applicable.", + "type": "object", "properties": { "status": { "readOnly": true, @@ -938,6 +1056,7 @@ }, "ErrorResponse": { "description": "Describes the error that occurred.", + "type": "object", "properties": { "code": { "readOnly": true, @@ -953,6 +1072,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, @@ -973,6 +1093,7 @@ }, "Compression": { "description": "Describes how input data is compressed", + "type": "object", "properties": { "type": { "type": "string" @@ -984,6 +1105,7 @@ }, "Identity": { "description": "Describes how identity is verified", + "type": "object", "properties": { "tenantId": { "type": "string" @@ -998,6 +1120,7 @@ }, "AzureSqlReferenceInputDataSource": { "description": "Describes an Azure SQL database reference input data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", "allOf": [ { @@ -1011,6 +1134,8 @@ } }, "AzureSqlReferenceInputDataSourceProperties": { + "description": "Describes Azure SQL database reference input data source properties.", + "type": "object", "properties": { "server": { "description": "This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.", diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json index 1272302df934..75b1b2f27efa 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json @@ -56,6 +56,12 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -67,6 +73,7 @@ "definitions": { "OperationListResult": { "description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", "properties": { "value": { "description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", @@ -94,6 +101,7 @@ }, "display": { "description": "Contains the localized display information for this particular operation / action.", + "type": "object", "readOnly": true, "properties": { "provider": { diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json index 0e2134ff78df..bc4f331876d0 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json @@ -135,6 +135,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -219,6 +225,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -256,6 +268,12 @@ }, "204": { "description": "The output does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -329,6 +347,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -372,6 +396,12 @@ "schema": { "$ref": "#/definitions/OutputListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -426,6 +456,12 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -435,6 +471,7 @@ "definitions": { "Output": { "description": "An output object, containing all information associated with the named output. All outputs are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -450,6 +487,7 @@ }, "OutputProperties": { "description": "The properties that are associated with an output.", + "type": "object", "properties": { "datasource": { "$ref": "#/definitions/OutputDataSource", @@ -479,6 +517,7 @@ }, "OutputDataSource": { "description": "Describes the data source that output will be written to.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -490,8 +529,36 @@ "type" ] }, + "RawOutputDatasource": { + "description": "Describes a raw output data source. This data source type is only applicable/usable when using the query testing API. You cannot create a job with this data source type or add an output of this data source type to an existing job.", + "type": "object", + "x-ms-discriminator-value": "Raw", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "description": "The properties that are associated with a raw output. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/RawOutputDatasourceProperties", + "x-ms-client-flatten": true + } + } + }, + "RawOutputDatasourceProperties": { + "description": "The properties that are associated with a raw output.", + "type": "object", + "properties": { + "payloadUri": { + "description": "The SAS URL to a blob where the output should be written. If this property is not set, output data will be written into a temporary storage, and a SAS URL to that temporary storage will be included in the result.", + "type": "string" + } + } + }, "BlobOutputDataSource": { "description": "Describes a blob output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Blob", "allOf": [ { @@ -508,6 +575,7 @@ }, "BlobOutputDataSourceProperties": { "description": "The properties that are associated with a blob output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/BlobDataSourceProperties" @@ -522,6 +590,7 @@ }, "AzureTableOutputDataSource": { "description": "Describes an Azure Table output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Table", "allOf": [ { @@ -538,6 +607,7 @@ }, "AzureTableOutputDataSourceProperties": { "description": "The properties that are associated with an Azure Table output.", + "type": "object", "properties": { "accountName": { "type": "string", @@ -575,6 +645,7 @@ }, "EventHubOutputDataSource": { "description": "Describes an Event Hub output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", "allOf": [ { @@ -591,6 +662,7 @@ }, "EventHubV2OutputDataSource": { "description": "Describes an Event Hub output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", "allOf": [ { @@ -607,6 +679,7 @@ }, "EventHubOutputDataSourceProperties": { "description": "The properties that are associated with an Event Hub output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/EventHubDataSourceProperties" @@ -627,6 +700,7 @@ }, "AzureSqlDatabaseOutputDataSource": { "description": "Describes an Azure SQL database output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", "allOf": [ { @@ -643,6 +717,7 @@ }, "AzureSqlDatabaseOutputDataSourceProperties": { "description": "The properties that are associated with an Azure SQL database output.", + "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlDatabaseDataSourceProperties" @@ -652,6 +727,7 @@ }, "AzureSynapseOutputDataSource": { "description": "Describes an Azure Synapse output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Sql/Server/DataWarehouse", "allOf": [ { @@ -668,6 +744,7 @@ }, "AzureSynapseOutputDataSourceProperties": { "description": "The properties that are associated with an Azure Synapse output.", + "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSynapseDataSourceProperties" @@ -677,6 +754,7 @@ }, "AzureSynapseDataSourceProperties": { "description": "The properties that are associated with an Azure SQL database data source.", + "type": "object", "properties": { "server": { "type": "string", @@ -702,6 +780,7 @@ }, "DocumentDbOutputDataSource": { "description": "Describes a DocumentDB output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/DocumentDB", "allOf": [ { @@ -718,6 +797,7 @@ }, "DocumentDbOutputDataSourceProperties": { "description": "The properties that are associated with a DocumentDB output.", + "type": "object", "properties": { "accountId": { "type": "string", @@ -747,6 +827,7 @@ }, "AzureFunctionOutputDataSource": { "description": "Defines the metadata of AzureFunctionOutputDataSource", + "type": "object", "x-ms-discriminator-value": "Microsoft.AzureFunction", "allOf": [ { @@ -763,6 +844,7 @@ }, "AzureFunctionOutputDataSourceProperties": { "description": "The properties that are associated with a DocumentDB output.", + "type": "object", "properties": { "functionAppName": { "description": "The name of your Azure Functions app.", @@ -788,6 +870,7 @@ }, "ServiceBusQueueOutputDataSource": { "description": "Describes a Service Bus Queue output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/Queue", "allOf": [ { @@ -804,6 +887,7 @@ }, "ServiceBusQueueOutputDataSourceProperties": { "description": "The properties that are associated with a Service Bus Queue output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" @@ -831,6 +915,7 @@ }, "ServiceBusTopicOutputDataSource": { "description": "Describes a Service Bus Topic output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/Topic", "allOf": [ { @@ -847,6 +932,7 @@ }, "ServiceBusTopicOutputDataSourceProperties": { "description": "The properties that are associated with a Service Bus Topic output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" @@ -874,6 +960,7 @@ }, "PowerBIOutputDataSource": { "description": "Describes a Power BI output data source.", + "type": "object", "x-ms-discriminator-value": "PowerBI", "allOf": [ { @@ -890,6 +977,7 @@ }, "PowerBIOutputDataSourceProperties": { "description": "The properties that are associated with a Power BI output.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OAuthBasedDataSourceProperties" @@ -920,6 +1008,7 @@ }, "AzureDataLakeStoreOutputDataSource": { "description": "Describes an Azure Data Lake Store output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.DataLake/Accounts", "allOf": [ { @@ -936,6 +1025,7 @@ }, "AzureDataLakeStoreOutputDataSourceProperties": { "description": "The properties that are associated with an Azure Data Lake Store.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OAuthBasedDataSourceProperties" @@ -969,6 +1059,8 @@ } }, "OutputListResult": { + "description": "Object containing a list of outputs under a streaming job.", + "type": "object", "properties": { "value": { "type": "array", @@ -983,11 +1075,11 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of outputs under a streaming job." + } }, "AzureSqlDatabaseDataSourceProperties": { "description": "The properties that are associated with an Azure SQL database data source.", + "type": "object", "properties": { "server": { "type": "string", @@ -1025,6 +1117,7 @@ }, "OAuthBasedDataSourceProperties": { "description": "The properties that are associated with data sources that use OAuth as their authentication model.", + "type": "object", "properties": { "refreshToken": { "type": "string", @@ -1042,6 +1135,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json index d2fc8f4ffeef..8d64e173e3f2 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json @@ -111,6 +111,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -169,6 +175,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -206,6 +218,12 @@ }, "204": { "description": "The streaming job does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -257,6 +275,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -300,6 +324,12 @@ "schema": { "$ref": "#/definitions/StreamingJobListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -343,6 +373,12 @@ "schema": { "$ref": "#/definitions/StreamingJobListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -397,6 +433,12 @@ }, "202": { "description": "The start streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -434,6 +476,12 @@ }, "202": { "description": "The stop streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -443,6 +491,7 @@ "definitions": { "External": { "description": "The storage account where the custom code artifacts are located.", + "type": "object", "properties": { "storageAccount": { "$ref": "./inputs.json#/definitions/StorageAccount" @@ -455,63 +504,9 @@ } } }, - "OperationListResult": { - "description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "Operation": { - "description": "A Stream Analytics REST API operation", - "type": "object", - "properties": { - "name": { - "description": "The name of the operation being performed on this particular object.", - "type": "string", - "readOnly": true - }, - "display": { - "description": "Contains the localized display information for this particular operation / action.", - "readOnly": true, - "properties": { - "provider": { - "description": "The localized friendly form of the resource provider name.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "The localized friendly form of the resource type related to this action/operation.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The localized friendly name for the operation.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The localized friendly description for the operation.", - "type": "string", - "readOnly": true - } - } - } - } - }, "StreamingJob": { "description": "A streaming job object, containing all information associated with the named streaming job.", + "type": "object", "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" @@ -531,6 +526,7 @@ }, "StreamingJobProperties": { "description": "The properties that are associated with a streaming job.", + "type": "object", "properties": { "sku": { "description": "Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.", @@ -668,6 +664,7 @@ }, "ClusterInfo": { "description": "The properties associated with a Stream Analytics cluster.", + "type": "object", "properties": { "id": { "description": "The resource id of cluster.", @@ -677,6 +674,7 @@ }, "StreamingJobSku": { "description": "The properties that are associated with a SKU.", + "type": "object", "properties": { "name": { "type": "string", @@ -692,6 +690,7 @@ } }, "StreamingJobListResult": { + "description": "Object containing a list of streaming jobs.", "properties": { "value": { "type": "array", @@ -706,11 +705,11 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of streaming jobs." + } }, "StartStreamingJobParameters": { "description": "Parameters supplied to the Start Streaming Job operation.", + "type": "object", "properties": { "outputStartMode": { "$ref": "#/definitions/OutputStartMode", @@ -773,6 +772,7 @@ }, "JobStorageAccount": { "description": "The properties that are associated with an Azure Storage account with MSI", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/StorageAccount" diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json index e20939d8ed25..b72a491c50c8 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json @@ -47,11 +47,7 @@ }, "parameters": [ { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/" + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" @@ -66,6 +62,271 @@ "schema": { "$ref": "#/definitions/SubscriptionQuotasListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/testQuery": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_TestQuery", + "description": "Test the Stream Analytics query on a sample input.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test the Stream Analytics query": { + "$ref": "./examples/Subscription_TestQuery.json" + } + }, + "parameters": [ + { + "name": "testQuery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestQuery" + }, + "description": "The query testing object that defines the input, output, and transformation for the query testing." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request to test the Stream Analytics query was successful.", + "schema": { + "$ref": "#/definitions/QueryTestingResult" + } + }, + "202": { + "description": "The request to test the Stream Analytics query was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/compileQuery": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CompileQuery", + "description": "Compile the Stream Analytics query.", + "x-ms-examples": { + "Compile the Stream Analytics query": { + "$ref": "./examples/Subscription_CompileQuery.json" + } + }, + "parameters": [ + { + "name": "compileQuery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompileQuery" + }, + "description": "The query compilation object which defines the input, output, and transformation for the query compilation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Stream Analytics query was compiled successfully.", + "schema": { + "$ref": "#/definitions/QueryCompilationResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/sampleInput": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_SampleInput", + "description": "Sample the Stream Analytics input data.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Sample the Stream Analytics input data": { + "$ref": "./examples/Subscription_SampleInput.json" + } + }, + "parameters": [ + { + "name": "sampleInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SampleInput" + }, + "description": "Defines the necessary parameters for sampling the Stream Analytics input data." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The request to sample the Stream Analytics input was successfully initiated.", + "schema": { + "$ref": "#/definitions/SampleInputResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/testInput": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_TestInput", + "description": "Test the Stream Analytics input.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test the Stream Analytics input": { + "$ref": "./examples/Subscription_TestInput.json" + } + }, + "parameters": [ + { + "name": "testInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestInput" + }, + "description": "Defines the necessary parameters for testing the Stream Analytics input." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The request to test the Stream Analytics input was successfully initiated.", + "schema": { + "$ref": "#/definitions/TestDatasourceResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/testOutput": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_TestOutput", + "description": "Test the Stream Analytics output.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test the Stream Analytics output": { + "$ref": "./examples/Subscription_TestOutput.json" + } + }, + "parameters": [ + { + "name": "testOutput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestOutput" + }, + "description": "Defines the necessary parameters for testing the Stream Analytics output." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The request to test the Stream Analytics output was successfully initiated.", + "schema": { + "$ref": "#/definitions/TestDatasourceResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -74,6 +335,7 @@ "definitions": { "SubscriptionQuotasListResult": { "description": "Result of the GetQuotas operation. It contains a list of quotas for the subscription in a particular region.", + "type": "object", "properties": { "value": { "description": "List of quotas for the subscription in a particular region.", @@ -115,8 +377,447 @@ } } }, + "TestQuery": { + "description": "The request object for query testing.", + "type": "object", + "properties": { + "diagnostics": { + "description": "Diagnostics information related to query testing.", + "type": "object", + "properties": { + "writeUri": { + "description": "The SAS URI to the container or directory.", + "type": "string" + }, + "path": { + "description": "The path to the subdirectory.", + "type": "string" + } + }, + "required": [ + "writeUri" + ] + }, + "streamingJob": { + "description": "Stream analytics job object which defines the input, output, and transformation for the query testing.", + "$ref": "./streamingjobs.json#/definitions/StreamingJob" + } + }, + "required": [ + "streamingJob" + ] + }, + "QueryTestingResult": { + "description": "The result of the query testing request.", + "type": "object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + ], + "properties": { + "status": { + "description": "The status of the query testing request.", + "$ref": "#/definitions/QueryTestingResultStatus" + }, + "outputUri": { + "description": "The SAS URL to the outputs payload.", + "type": "string", + "readOnly": true + } + } + }, + "QueryTestingResultStatus": { + "description": "The status of the query testing request.", + "readOnly": true, + "type": "string", + "enum": [ + "Started", + "Success", + "CompilerError", + "RuntimeError", + "Timeout", + "UnknownError" + ], + "x-ms-enum": { + "name": "QueryTestingResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Started", + "description": "The query testing operation was initiated." + }, + { + "value": "Success", + "description": "The query testing operation succeeded." + }, + { + "value": "CompilerError", + "description": "The query testing operation failed due to a compiler error." + }, + { + "value": "RuntimeError", + "description": "The query testing operation failed due to a runtime error." + }, + { + "value": "Timeout", + "description": "The query testing operation failed due to a timeout." + }, + { + "value": "UnknownError", + "description": "The query testing operation failed due to an unknown error ." + } + ] + } + }, + "CompileQuery": { + "description": "The query compilation object which defines the input, output, and transformation for the query compilation.", + "type": "object", + "properties": { + "query": { + "description": "The query to compile.", + "type": "string" + }, + "inputs": { + "description": "The inputs for the query compilation.", + "type": "array", + "items": { + "description": "An input for the query compilation.", + "$ref": "#/definitions/QueryInput" + } + }, + "functions": { + "description": "The functions for the query compilation.", + "type": "array", + "items": { + "description": "A function for the query compilation.", + "$ref": "#/definitions/QueryFunction" + } + }, + "jobType": { + "type": "string", + "description": "Describes the type of the job. Valid values are `Cloud` and 'Edge'.", + "enum": [ + "Cloud", + "Edge" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "compatibilityLevel": { + "description": "The query to compile.", + "$ref": "./streamingjobs.json#/definitions/CompatibilityLevel" + } + }, + "required": [ + "query", + "jobType" + ] + }, + "QueryInput": { + "description": "An input for the query compilation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the input.", + "type": "string" + }, + "type": { + "description": "The type of the input, can be Stream or Reference.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "QueryFunction": { + "description": "A function for the query compilation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the function.", + "type": "string" + }, + "type": { + "description": "The type of the function.", + "type": "string" + }, + "bindingType": { + "description": "The type of the function binding.", + "type": "string" + }, + "inputs": { + "description": "The inputs for the function.", + "type": "array", + "items": { + "description": "An input for the function.", + "$ref": "./functions.json#/definitions/FunctionInput" + } + }, + "output": { + "description": "An output for the function.", + "$ref": "./functions.json#/definitions/FunctionOutput" + } + }, + "required": [ + "name", + "type", + "bindingType", + "inputs", + "output" + ] + }, + "QueryCompilationResult": { + "description": "The result of the query compilation request.", + "type": "object", + "properties": { + "errors": { + "description": "Error messages produced by the compiler.", + "type": "array", + "readOnly": true, + "items": { + "description": "An error produced by the compiler.", + "$ref": "#/definitions/QueryCompilationError" + } + }, + "warnings": { + "description": "Warning messages produced by the compiler.", + "type": "array", + "readOnly": true, + "items": { + "description": "A warning produced by the compiler.", + "type": "string", + "readOnly": true + } + }, + "inputs": { + "description": "All input names used by the query.", + "type": "array", + "readOnly": true, + "items": { + "description": "An input used by the query.", + "type": "string", + "readOnly": true + } + }, + "outputs": { + "description": "All output names used by the query.", + "type": "array", + "readOnly": true, + "items": { + "description": "An output used by the query.", + "type": "string", + "readOnly": true + } + }, + "functions": { + "description": "All function names used by the query.", + "type": "array", + "readOnly": true, + "items": { + "description": "A function used by the query.", + "type": "string", + "readOnly": true + } + } + } + }, + "QueryCompilationError": { + "description": "An error produced by the compiler.", + "type": "object", + "properties": { + "message": { + "description": "The content of the error message.", + "type": "string", + "readOnly": true + }, + "startLine": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "startColumn": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "endLine": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "endColumn": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "isGlobal": { + "description": "Whether the error is not for a specific part but for the entire query.", + "type": "boolean", + "readOnly": true + } + } + }, + "SampleInput": { + "description": "The stream analytics input to sample.", + "type": "object", + "properties": { + "input": { + "description": "The stream analytics input to sample.", + "$ref": "./inputs.json#/definitions/Input" + }, + "compatibilityLevel": { + "description": "Defaults to the default ASA job compatibility level. Today it is 1.2", + "type": "string" + }, + "eventsUri": { + "description": "The SAS URI of the storage blob for service to write the sampled events to. If this parameter is not provided, service will write events to he system account and share a temporary SAS URI to it.", + "type": "string" + }, + "dataLocale": { + "description": "Defaults to en-US.", + "type": "string" + } + } + }, + "SampleInputResult": { + "description": "The result of the sample input request.", + "type": "object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + ], + "properties": { + "status": { + "description": "The status of the sample input request.", + "$ref": "#/definitions/SampleInputResultStatus" + }, + "diagnostics": { + "description": "Diagnostics messages. E.g. message indicating some partitions from the input have no data.", + "type": "array", + "readOnly": true, + "items": { + "description": "A diagnostics message.", + "type": "string", + "readOnly": true + } + }, + "eventsDownloadUrl": { + "description": "A SAS URL to download the sampled input data.", + "type": "string", + "readOnly": true + }, + "lastArrivalTime": { + "description": "The timestamp for the last event in the data. It is in DateTime format.", + "type": "string", + "readOnly": true + } + } + }, + "SampleInputResultStatus": { + "description": "The status of the sample input request.", + "readOnly": true, + "type": "string", + "enum": [ + "ReadAllEventsInRange", + "NoEventsFoundInRange", + "ErrorConnectingToInput" + ], + "x-ms-enum": { + "name": "SampleInputResultStatus", + "modelAsString": true, + "values": [ + { + "value": "ReadAllEventsInRange", + "description": "The sample input operation successfully read all the events in the range." + }, + { + "value": "NoEventsFoundInRange", + "description": "The sample input operation found no events in the range." + }, + { + "value": "ErrorConnectingToInput", + "description": "The sample input operation failed to connect to the input." + } + ] + } + }, + "TestInput": { + "description": "A stream analytics input.", + "type": "object", + "properties": { + "input": { + "description": "The stream analytics input to test.", + "$ref": "./inputs.json#/definitions/Input" + } + }, + "required": [ + "input" + ] + }, + "TestOutput": { + "description": "A stream analytics output.", + "type": "object", + "properties": { + "output": { + "description": "The stream analytics output to test.", + "$ref": "./outputs.json#/definitions/Output" + } + }, + "required": [ + "output" + ] + }, + "TestDatasourceResult": { + "description": "The result of the test input or output request.", + "type": "object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + ], + "properties": { + "status": { + "description": "The status of the sample output request.", + "$ref": "#/definitions/TestDatasourceResultStatus" + } + } + }, + "TestDatasourceResultStatus": { + "description": "The status of the test input or output request.", + "readOnly": true, + "type": "string", + "enum": [ + "TestSucceeded", + "TestFailed" + ], + "x-ms-enum": { + "name": "TestDatasourceResultStatus", + "modelAsString": true, + "values": [ + { + "value": "TestSucceeded", + "description": "The test datasource operation succeeded." + }, + { + "value": "TestFailed", + "description": "The test datasource operation failed." + } + ] + } + }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json index 9543efbc90a1..614825dc874a 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json @@ -111,6 +111,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -171,6 +177,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -214,6 +226,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -222,6 +240,7 @@ "definitions": { "Transformation": { "description": "A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -237,6 +256,7 @@ }, "TransformationProperties": { "description": "The properties that are associated with a transformation.", + "type": "object", "properties": { "streamingUnits": { "type": "integer", @@ -256,6 +276,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true,