{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-streamanalytics-functions","description":"StreamAnalyticsManagementClient","version":"2016-03-01","base_url":"https://management.azure.com","endpoints":7,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api StreamAnalyticsManagementClient\n@base https://management.azure.com\n@version 2016-03-01\n@auth OAuth2\n@common_fields {api-version: any # Client Api Version., subscriptionId: any # GUID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., jobName: any # The name of the streaming job.}\n@endpoints 7\n@toc subscriptions(7)\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}\n@desc Creates a function or replaces an already existing function under an existing streaming job.\n@required {function: any # The definition of the function that will be used to create a new function or replace the existing one under the streaming job., functionName: any # The name of the function.}\n@optional {If-Match: any # The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes., If-None-Match: any # Set to '*' to allow a new function to be created, but to prevent updating an existing function. Other values will result in a 412 Pre-condition Failed response.}\n@returns(200) The function was successfully created or replaced.\n@returns(201) The function was successfully created or replaced.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}\n@desc Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.\n@required {function: any # A function object. The properties specified here will overwrite the corresponding properties in the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing function will remain the same and not change as a result of this PATCH operation., functionName: any # The name of the function.}\n@optional {If-Match: any # The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.}\n@returns(200) The function was successfully updated.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}\n@desc Deletes a function from the streaming job.\n@required {functionName: any # The name of the function.}\n@returns(200) The function was successfully deleted.\n@returns(204) The function does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}\n@desc Gets details about the specified function.\n@required {functionName: any # The name of the function.}\n@returns(200) Successfully retrieved the specified function.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions\n@desc Lists all of the functions under the specified streaming job.\n@optional {$select: any # The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value.}\n@returns(200) Successfully listed the functions under the specified streaming job.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/test\n@desc Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.\n@required {functionName: any # The name of the function.}\n@optional {function: any # If the function specified does not already exist, this parameter must contain the full function definition intended to be tested. If the function specified already exists, this parameter can be left null to test the existing function as is or if specified, the properties specified will overwrite the corresponding properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested.}\n@returns(200) The test operation completed successfully.\n@returns(202) The test request was successfully initiated.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/retrieveDefaultDefinition\n@desc Retrieves the default definition of a function based on the parameters specified.\n@required {functionName: any # The name of the function.}\n@optional {functionRetrieveDefaultDefinitionParameters: any # Parameters used to specify the type of function to retrieve the default definition for.}\n@returns(200) Successfully retrieved the function's default definition.\n\n@end\n"}