Package version:

Interface Functions

Interface representing a Functions.

interface Functions {
    beginTest(resourceGroupName, jobName, functionName, options?): Promise<SimplePollerLike<OperationState<ResourceTestStatus>, ResourceTestStatus>>;
    beginTestAndWait(resourceGroupName, jobName, functionName, options?): Promise<ResourceTestStatus>;
    createOrReplace(resourceGroupName, jobName, functionName, functionParam, options?): Promise<FunctionsCreateOrReplaceResponse>;
    delete(resourceGroupName, jobName, functionName, options?): Promise<void>;
    get(resourceGroupName, jobName, functionName, options?): Promise<FunctionsGetResponse>;
    listByStreamingJob(resourceGroupName, jobName, options?): PagedAsyncIterableIterator<FunctionModel>;
    retrieveDefaultDefinition(resourceGroupName, jobName, functionName, options?): Promise<FunctionModel>;
    update(resourceGroupName, jobName, functionName, functionParam, options?): Promise<FunctionsUpdateResponse>;
}

Index

Methods

beginTest beginTestAndWait createOrReplace delete get listByStreamingJob retrieveDefaultDefinition update

Methods

beginTest

beginTest(resourceGroupName, jobName, functionName, options?): Promise<SimplePollerLike<OperationState<ResourceTestStatus>, ResourceTestStatus>>
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.
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.
- Optional options: FunctionsTestOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ResourceTestStatus>, ResourceTestStatus>>
- Defined in operationsInterfaces/functions.ts:112

beginTestAndWait

beginTestAndWait(resourceGroupName, jobName, functionName, options?): Promise<ResourceTestStatus>
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.
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.
- Optional options: FunctionsTestOptionalParams
  The options parameters.
Returns Promise<ResourceTestStatus>
- Defined in operationsInterfaces/functions.ts:132

createOrReplace

createOrReplace(resourceGroupName, jobName, functionName, functionParam, options?): Promise<FunctionsCreateOrReplaceResponse>
Creates a function or replaces an already existing function under an existing streaming job.
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.
- Optional options: FunctionsCreateOrReplaceOptionalParams
  The options parameters.
Returns Promise<FunctionsCreateOrReplaceResponse>
- Defined in operationsInterfaces/functions.ts:50

delete

delete(resourceGroupName, jobName, functionName, options?): Promise<void>
Deletes a function from the streaming job.
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.
- Optional options: FunctionsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/functions.ts:84

get

get(resourceGroupName, jobName, functionName, options?): Promise<FunctionsGetResponse>
Gets details about the specified function.
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.
- Optional options: FunctionsGetOptionalParams
  The options parameters.
Returns Promise<FunctionsGetResponse>
- Defined in operationsInterfaces/functions.ts:97

listByStreamingJob

listByStreamingJob(resourceGroupName, jobName, options?): PagedAsyncIterableIterator<FunctionModel>
Lists all of the functions under the specified streaming job.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- jobName: string
  The name of the streaming job.
- Optional options: FunctionsListByStreamingJobOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<FunctionModel>
- Defined in operationsInterfaces/functions.ts:36

retrieveDefaultDefinition

retrieveDefaultDefinition(resourceGroupName, jobName, functionName, options?): Promise<FunctionModel>
Retrieves the default definition of a function based on the parameters specified.
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.
- Optional options: FunctionsRetrieveDefaultDefinitionOptionalParams
  The options parameters.
Returns Promise<FunctionModel>
- Defined in operationsInterfaces/functions.ts:145

update

update(resourceGroupName, jobName, functionName, functionParam, options?): Promise<FunctionsUpdateResponse>
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.
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.
- Optional options: FunctionsUpdateOptionalParams
  The options parameters.
Returns Promise<FunctionsUpdateResponse>
- Defined in operationsInterfaces/functions.ts:70

Interface Functions

Index

Methods

Methods

beginTest

Parameters

Returns Promise<SimplePollerLike<OperationState<ResourceTestStatus>, ResourceTestStatus>>

beginTestAndWait

Parameters

Returns Promise<ResourceTestStatus>

createOrReplace

Parameters

Returns Promise<FunctionsCreateOrReplaceResponse>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<FunctionsGetResponse>

listByStreamingJob

Parameters

Returns PagedAsyncIterableIterator<FunctionModel>

retrieveDefaultDefinition

Parameters

Returns Promise<FunctionModel>

update

Parameters

Returns Promise<FunctionsUpdateResponse>

Settings

Member Visibility

Theme