Package version:

Interface StreamingJobs

Interface representing a StreamingJobs.

interface StreamingJobs {
    beginCreateOrReplace(resourceGroupName, jobName, streamingJob, options?): Promise<SimplePollerLike<OperationState<StreamingJobsCreateOrReplaceResponse>, StreamingJobsCreateOrReplaceResponse>>;
    beginCreateOrReplaceAndWait(resourceGroupName, jobName, streamingJob, options?): Promise<StreamingJobsCreateOrReplaceResponse>;
    beginDelete(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName, jobName, options?): Promise<void>;
    beginScale(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginScaleAndWait(resourceGroupName, jobName, options?): Promise<void>;
    beginStart(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStartAndWait(resourceGroupName, jobName, options?): Promise<void>;
    beginStop(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginStopAndWait(resourceGroupName, jobName, options?): Promise<void>;
    get(resourceGroupName, jobName, options?): Promise<StreamingJobsGetResponse>;
    list(options?): PagedAsyncIterableIterator<StreamingJob>;
    listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<StreamingJob>;
    update(resourceGroupName, jobName, streamingJob, options?): Promise<StreamingJobsUpdateResponse>;
}

Methods

beginCreateOrReplace beginCreateOrReplaceAndWait beginDelete beginDeleteAndWait beginScale beginScaleAndWait beginStart beginStartAndWait beginStop beginStopAndWait get list listByResourceGroup update

Methods

beginCreateOrReplace

beginCreateOrReplaceAndWait

beginDelete

  • beginDelete(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Deletes a 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: StreamingJobsDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

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

  • Deletes a 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: StreamingJobsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginScale

  • beginScale(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Scales a streaming job when the job is running.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • Optional options: StreamingJobsScaleOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginScaleAndWait

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

  • Scales a streaming job when the job is running.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • Optional options: StreamingJobsScaleOptionalParams

      The options parameters.

    Returns Promise<void>

beginStart

  • beginStart(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Starts a streaming job. Once a job is started it will start processing input events and produce output.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • Optional options: StreamingJobsStartOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

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

  • Starts a streaming job. Once a job is started it will start processing input events and produce output.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • Optional options: StreamingJobsStartOptionalParams

      The options parameters.

    Returns Promise<void>

beginStop

  • beginStop(resourceGroupName, jobName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • Optional options: StreamingJobsStopOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

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

  • Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • Optional options: StreamingJobsStopOptionalParams

      The options parameters.

    Returns Promise<void>

get

list

listByResourceGroup

update

  • update(resourceGroupName, jobName, streamingJob, options?): Promise<StreamingJobsUpdateResponse>

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

    Parameters

    • resourceGroupName: string

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

    • jobName: string

      The name of the streaming job.

    • streamingJob: StreamingJob

      A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (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: StreamingJobsUpdateOptionalParams

      The options parameters.

    Returns Promise<StreamingJobsUpdateResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc