Functions interface
Interface representing a Functions.
Methods
| begin |
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. |
| begin |
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. |
| create |
Creates a function or replaces an already existing function under an existing streaming job. |
| delete(string, string, string, Functions |
Deletes a function from the streaming job. |
| get(string, string, string, Functions |
Gets details about the specified function. |
| list |
Lists all of the functions under the specified streaming job. |
| retrieve |
Retrieves the default definition of a function based on the parameters specified. |
| update(string, string, string, Function |
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. |
Method Details
beginTest(string, string, string, FunctionsTestOptionalParams)
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.
function beginTest(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsTestOptionalParams): Promise<PollerLike<PollOperationState<ResourceTestStatus>, ResourceTestStatus>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
- options
- FunctionsTestOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ResourceTestStatus>, ResourceTestStatus>>
beginTestAndWait(string, string, string, FunctionsTestOptionalParams)
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.
function beginTestAndWait(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsTestOptionalParams): Promise<ResourceTestStatus>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
- options
- FunctionsTestOptionalParams
The options parameters.
Returns
Promise<ResourceTestStatus>
createOrReplace(string, string, string, FunctionModel, FunctionsCreateOrReplaceOptionalParams)
Creates a function or replaces an already existing function under an existing streaming job.
function createOrReplace(resourceGroupName: string, jobName: string, functionName: string, functionParam: FunctionModel, options?: FunctionsCreateOrReplaceOptionalParams): Promise<FunctionsCreateOrReplaceResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
- functionParam
- FunctionModel
The definition of the function that will be used to create a new function or replace the existing one under the streaming job.
The options parameters.
Returns
Promise<FunctionsCreateOrReplaceResponse>
delete(string, string, string, FunctionsDeleteOptionalParams)
Deletes a function from the streaming job.
function delete(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
- options
- FunctionsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, FunctionsGetOptionalParams)
Gets details about the specified function.
function get(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsGetOptionalParams): Promise<FunctionsGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
- options
- FunctionsGetOptionalParams
The options parameters.
Returns
Promise<FunctionsGetResponse>
listByStreamingJob(string, string, FunctionsListByStreamingJobOptionalParams)
Lists all of the functions under the specified streaming job.
function listByStreamingJob(resourceGroupName: string, jobName: string, options?: FunctionsListByStreamingJobOptionalParams): PagedAsyncIterableIterator<FunctionModel, FunctionModel[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
The options parameters.
Returns
retrieveDefaultDefinition(string, string, string, FunctionsRetrieveDefaultDefinitionOptionalParams)
Retrieves the default definition of a function based on the parameters specified.
function retrieveDefaultDefinition(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsRetrieveDefaultDefinitionOptionalParams): Promise<FunctionModel>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
The options parameters.
Returns
Promise<FunctionModel>
update(string, string, string, FunctionModel, FunctionsUpdateOptionalParams)
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.
function update(resourceGroupName: string, jobName: string, functionName: string, functionParam: FunctionModel, options?: FunctionsUpdateOptionalParams): Promise<FunctionsUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- functionName
-
string
The name of the function.
- functionParam
- FunctionModel
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.
- options
- FunctionsUpdateOptionalParams
The options parameters.
Returns
Promise<FunctionsUpdateResponse>