StreamingJobs interface

Package:

@azure/arm-streamanalytics

Interface representing a StreamingJobs.

Methods

beginCreateOrReplace(string, string, StreamingJob, StreamingJobsCreateOrReplaceOptionalParams)	Creates a streaming job or replaces an already existing streaming job.
beginCreateOrReplaceAndWait(string, string, StreamingJob, StreamingJobsCreateOrReplaceOptionalParams)	Creates a streaming job or replaces an already existing streaming job.
beginDelete(string, string, StreamingJobsDeleteOptionalParams)	Deletes a streaming job.
beginDeleteAndWait(string, string, StreamingJobsDeleteOptionalParams)	Deletes a streaming job.
beginScale(string, string, StreamingJobsScaleOptionalParams)	Scales a streaming job when the job is running.
beginScaleAndWait(string, string, StreamingJobsScaleOptionalParams)	Scales a streaming job when the job is running.
beginStart(string, string, StreamingJobsStartOptionalParams)	Starts a streaming job. Once a job is started it will start processing input events and produce output.
beginStartAndWait(string, string, StreamingJobsStartOptionalParams)	Starts a streaming job. Once a job is started it will start processing input events and produce output.
beginStop(string, string, StreamingJobsStopOptionalParams)	Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
beginStopAndWait(string, string, StreamingJobsStopOptionalParams)	Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
get(string, string, StreamingJobsGetOptionalParams)	Gets details about the specified streaming job.
list(StreamingJobsListOptionalParams)	Lists all of the streaming jobs in the given subscription.
listByResourceGroup(string, StreamingJobsListByResourceGroupOptionalParams)	Lists all of the streaming jobs in the specified resource group.
update(string, string, StreamingJob, StreamingJobsUpdateOptionalParams)	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.

Method Details

beginCreateOrReplace(string, string, StreamingJob, StreamingJobsCreateOrReplaceOptionalParams)

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

function beginCreateOrReplace(resourceGroupName: string, jobName: string, streamingJob: StreamingJob, options?: StreamingJobsCreateOrReplaceOptionalParams): Promise<PollerLike<PollOperationState<StreamingJobsCreateOrReplaceResponse>, StreamingJobsCreateOrReplaceResponse>>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

streamingJob

StreamingJob

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

options

StreamingJobsCreateOrReplaceOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<StreamingJobsCreateOrReplaceResponse>, StreamingJobsCreateOrReplaceResponse>>

beginCreateOrReplaceAndWait(string, string, StreamingJob, StreamingJobsCreateOrReplaceOptionalParams)

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

function beginCreateOrReplaceAndWait(resourceGroupName: string, jobName: string, streamingJob: StreamingJob, options?: StreamingJobsCreateOrReplaceOptionalParams): Promise<StreamingJobsCreateOrReplaceResponse>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

streamingJob

StreamingJob

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

options

StreamingJobsCreateOrReplaceOptionalParams

The options parameters.

Returns

Promise<StreamingJobsCreateOrReplaceResponse>

beginDelete(string, string, StreamingJobsDeleteOptionalParams)

Deletes a streaming job.

function beginDelete(resourceGroupName: string, jobName: string, options?: StreamingJobsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, StreamingJobsDeleteOptionalParams)

Deletes a streaming job.

function beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: StreamingJobsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginScale(string, string, StreamingJobsScaleOptionalParams)

Scales a streaming job when the job is running.

function beginScale(resourceGroupName: string, jobName: string, options?: StreamingJobsScaleOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsScaleOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginScaleAndWait(string, string, StreamingJobsScaleOptionalParams)

Scales a streaming job when the job is running.

function beginScaleAndWait(resourceGroupName: string, jobName: string, options?: StreamingJobsScaleOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsScaleOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, StreamingJobsStartOptionalParams)

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

function beginStart(resourceGroupName: string, jobName: string, options?: StreamingJobsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsStartOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStartAndWait(string, string, StreamingJobsStartOptionalParams)

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

function beginStartAndWait(resourceGroupName: string, jobName: string, options?: StreamingJobsStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, StreamingJobsStopOptionalParams)

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

function beginStop(resourceGroupName: string, jobName: string, options?: StreamingJobsStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsStopOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginStopAndWait(string, string, StreamingJobsStopOptionalParams)

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

function beginStopAndWait(resourceGroupName: string, jobName: string, options?: StreamingJobsStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsStopOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, StreamingJobsGetOptionalParams)

Gets details about the specified streaming job.

function get(resourceGroupName: string, jobName: string, options?: StreamingJobsGetOptionalParams): Promise<StreamingJobsGetResponse>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

StreamingJobsGetOptionalParams

The options parameters.

Returns

Promise<StreamingJobsGetResponse>

list(StreamingJobsListOptionalParams)

Lists all of the streaming jobs in the given subscription.

function list(options?: StreamingJobsListOptionalParams): PagedAsyncIterableIterator<StreamingJob, StreamingJob[], PageSettings>

Parameters

options

StreamingJobsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StreamingJob, StreamingJob[], PageSettings>

listByResourceGroup(string, StreamingJobsListByResourceGroupOptionalParams)

Lists all of the streaming jobs in the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: StreamingJobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StreamingJob, StreamingJob[], PageSettings>

Parameters

resourceGroupName

string

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

options

StreamingJobsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StreamingJob, StreamingJob[], PageSettings>

update(string, string, StreamingJob, StreamingJobsUpdateOptionalParams)

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.

function update(resourceGroupName: string, jobName: string, streamingJob: StreamingJob, options?: StreamingJobsUpdateOptionalParams): Promise<StreamingJobsUpdateResponse>

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.

options

StreamingJobsUpdateOptionalParams

The options parameters.

Returns

Promise<StreamingJobsUpdateResponse>