Package version:

Interface Inputs

Interface representing a Inputs.

interface Inputs {
    beginTest(resourceGroupName, jobName, inputName, options?): Promise<SimplePollerLike<OperationState<ResourceTestStatus>, ResourceTestStatus>>;
    beginTestAndWait(resourceGroupName, jobName, inputName, options?): Promise<ResourceTestStatus>;
    createOrReplace(resourceGroupName, jobName, inputName, input, options?): Promise<InputsCreateOrReplaceResponse>;
    delete(resourceGroupName, jobName, inputName, options?): Promise<void>;
    get(resourceGroupName, jobName, inputName, options?): Promise<InputsGetResponse>;
    listByStreamingJob(resourceGroupName, jobName, options?): PagedAsyncIterableIterator<Input>;
    update(resourceGroupName, jobName, inputName, input, options?): Promise<InputsUpdateResponse>;
}

Methods

beginTest beginTestAndWait createOrReplace delete get listByStreamingJob update

Methods

beginTest

beginTestAndWait

  • beginTestAndWait(resourceGroupName, jobName, inputName, options?): Promise<ResourceTestStatus>

  • Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • inputName: string

      The name of the input.

    • Optional options: InputsTestOptionalParams

      The options parameters.

    Returns Promise<ResourceTestStatus>

createOrReplace

  • createOrReplace(resourceGroupName, jobName, inputName, input, options?): Promise<InputsCreateOrReplaceResponse>

  • Creates an input or replaces an already existing input 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.

    • inputName: string

      The name of the input.

    • input: Input

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

    • Optional options: InputsCreateOrReplaceOptionalParams

      The options parameters.

    Returns Promise<InputsCreateOrReplaceResponse>

delete

  • delete(resourceGroupName, jobName, inputName, options?): Promise<void>

  • Deletes an input 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.

    • inputName: string

      The name of the input.

    • Optional options: InputsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

listByStreamingJob

  • listByStreamingJob(resourceGroupName, jobName, options?): PagedAsyncIterableIterator<Input>

  • Lists all of the inputs 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: InputsListByStreamingJobOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Input>

update

  • update(resourceGroupName, jobName, inputName, input, options?): Promise<InputsUpdateResponse>

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

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • inputName: string

      The name of the input.

    • input: Input

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

    • Optional options: InputsUpdateOptionalParams

      The options parameters.

    Returns Promise<InputsUpdateResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc