Transformations interface

Interface representing a Transformations.

Methods

createOrReplace(string, string, string, Transformation, TransformationsCreateOrReplaceOptionalParams)

Creates a transformation or replaces an already existing transformation under an existing streaming job.

get(string, string, string, TransformationsGetOptionalParams)

Gets details about the specified transformation.

update(string, string, string, Transformation, TransformationsUpdateOptionalParams)

Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.

Method Details

createOrReplace(string, string, string, Transformation, TransformationsCreateOrReplaceOptionalParams)

Creates a transformation or replaces an already existing transformation under an existing streaming job.

function createOrReplace(resourceGroupName: string, jobName: string, transformationName: string, transformation: Transformation, options?: TransformationsCreateOrReplaceOptionalParams): Promise<TransformationsCreateOrReplaceResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

jobName

string

The name of the streaming job.

transformationName

string

The name of the transformation.

transformation
Transformation

The definition of the transformation that will be used to create a new transformation or replace the existing one under the streaming job.

options
TransformationsCreateOrReplaceOptionalParams

The options parameters.

Returns

get(string, string, string, TransformationsGetOptionalParams)

Gets details about the specified transformation.

function get(resourceGroupName: string, jobName: string, transformationName: string, options?: TransformationsGetOptionalParams): Promise<TransformationsGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

jobName

string

The name of the streaming job.

transformationName

string

The name of the transformation.

options
TransformationsGetOptionalParams

The options parameters.

Returns

update(string, string, string, Transformation, TransformationsUpdateOptionalParams)

Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.

function update(resourceGroupName: string, jobName: string, transformationName: string, transformation: Transformation, options?: TransformationsUpdateOptionalParams): Promise<TransformationsUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

jobName

string

The name of the streaming job.

transformationName

string

The name of the transformation.

transformation
Transformation

A Transformation object. The properties specified here will overwrite the corresponding properties in the existing transformation (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing transformation will remain the same and not change as a result of this PATCH operation.

options
TransformationsUpdateOptionalParams

The options parameters.

Returns