Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transformations

Package version

Class representing a Transformations.

Hierarchy

  • Transformations

Index

Constructors

Methods

Constructors

constructor

Methods

createOrReplace

  • createOrReplace(transformation: Transformation, resourceGroupName: string, jobName: string, transformationName: string, options?: Models.TransformationsCreateOrReplaceOptionalParams): Promise<Models.TransformationsCreateOrReplaceResponse>
  • createOrReplace(transformation: Transformation, resourceGroupName: string, jobName: string, transformationName: string, callback: msRest.ServiceCallback<Transformation>): void
  • createOrReplace(transformation: Transformation, resourceGroupName: string, jobName: string, transformationName: string, options: TransformationsCreateOrReplaceOptionalParams, callback: msRest.ServiceCallback<Transformation>): void

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

    Parameters

    • 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.

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • Optional options: Models.TransformationsCreateOrReplaceOptionalParams

    Returns Promise<Models.TransformationsCreateOrReplaceResponse>

    Promise<Models.TransformationsCreateOrReplaceResponse>

  • Parameters

    • 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.

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • callback: msRest.ServiceCallback<Transformation>

      The callback

    Returns void

  • Parameters

    • 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.

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • options: TransformationsCreateOrReplaceOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Transformation>

      The callback

    Returns void

get

  • get(resourceGroupName: string, jobName: string, transformationName: string, options?: msRest.RequestOptionsBase): Promise<Models.TransformationsGetResponse>
  • get(resourceGroupName: string, jobName: string, transformationName: string, callback: msRest.ServiceCallback<Transformation>): void
  • get(resourceGroupName: string, jobName: string, transformationName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Transformation>): void

  • Gets details about the specified transformation.

    Parameters

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TransformationsGetResponse>

    Promise<Models.TransformationsGetResponse>

  • Parameters

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • callback: msRest.ServiceCallback<Transformation>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Transformation>

      The callback

    Returns void

update

  • update(transformation: Transformation, resourceGroupName: string, jobName: string, transformationName: string, options?: Models.TransformationsUpdateOptionalParams): Promise<Models.TransformationsUpdateResponse>
  • update(transformation: Transformation, resourceGroupName: string, jobName: string, transformationName: string, callback: msRest.ServiceCallback<Transformation>): void
  • update(transformation: Transformation, resourceGroupName: string, jobName: string, transformationName: string, options: TransformationsUpdateOptionalParams, callback: msRest.ServiceCallback<Transformation>): void

  • 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.

    Parameters

    • 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.

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • Optional options: Models.TransformationsUpdateOptionalParams

    Returns Promise<Models.TransformationsUpdateResponse>

    Promise<Models.TransformationsUpdateResponse>

  • Parameters

    • 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.

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • callback: msRest.ServiceCallback<Transformation>

      The callback

    Returns void

  • Parameters

    • 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.

    • resourceGroupName: string

      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: string

      The name of the streaming job.

    • transformationName: string

      The name of the transformation.

    • options: TransformationsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Transformation>

      The callback

    Returns void

Generated using TypeDoc