Outputs interface

Package:

@azure/arm-streamanalytics

Interface representing a Outputs.

Methods

beginTest(string, string, string, OutputsTestOptionalParams)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
beginTestAndWait(string, string, string, OutputsTestOptionalParams)	Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.
createOrReplace(string, string, string, Output, OutputsCreateOrReplaceOptionalParams)	Creates an output or replaces an already existing output under an existing streaming job.
delete(string, string, string, OutputsDeleteOptionalParams)	Deletes an output from the streaming job.
get(string, string, string, OutputsGetOptionalParams)	Gets details about the specified output.
listByStreamingJob(string, string, OutputsListByStreamingJobOptionalParams)	Lists all of the outputs under the specified streaming job.
update(string, string, string, Output, OutputsUpdateOptionalParams)	Updates an existing output under an existing streaming job. This can be used to partially update (ie. update one or two properties) an output without affecting the rest the job or output definition.

Method Details

beginTest(string, string, string, OutputsTestOptionalParams)

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

function beginTest(resourceGroupName: string, jobName: string, outputName: string, options?: OutputsTestOptionalParams): Promise<PollerLike<PollOperationState<ResourceTestStatus>, ResourceTestStatus>>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

outputName

string

The name of the output.

options

OutputsTestOptionalParams

The options parameters.

Returns

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

beginTestAndWait(string, string, string, OutputsTestOptionalParams)

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

function beginTestAndWait(resourceGroupName: string, jobName: string, outputName: string, options?: OutputsTestOptionalParams): Promise<ResourceTestStatus>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

outputName

string

The name of the output.

options

OutputsTestOptionalParams

The options parameters.

Returns

Promise<ResourceTestStatus>

createOrReplace(string, string, string, Output, OutputsCreateOrReplaceOptionalParams)

Creates an output or replaces an already existing output under an existing streaming job.

function createOrReplace(resourceGroupName: string, jobName: string, outputName: string, output: Output, options?: OutputsCreateOrReplaceOptionalParams): Promise<OutputsCreateOrReplaceResponse>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

outputName

string

The name of the output.

output

Output

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

options

OutputsCreateOrReplaceOptionalParams

The options parameters.

Returns

Promise<OutputsCreateOrReplaceResponse>

delete(string, string, string, OutputsDeleteOptionalParams)

Deletes an output from the streaming job.

function delete(resourceGroupName: string, jobName: string, outputName: string, options?: OutputsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

outputName

string

The name of the output.

options

OutputsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, OutputsGetOptionalParams)

Gets details about the specified output.

function get(resourceGroupName: string, jobName: string, outputName: string, options?: OutputsGetOptionalParams): Promise<OutputsGetResponse>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

outputName

string

The name of the output.

options

OutputsGetOptionalParams

The options parameters.

Returns

Promise<OutputsGetResponse>

listByStreamingJob(string, string, OutputsListByStreamingJobOptionalParams)

Lists all of the outputs under the specified streaming job.

function listByStreamingJob(resourceGroupName: string, jobName: string, options?: OutputsListByStreamingJobOptionalParams): PagedAsyncIterableIterator<Output, Output[], PageSettings>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

options

OutputsListByStreamingJobOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Output, Output[], PageSettings>

update(string, string, string, Output, OutputsUpdateOptionalParams)

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

function update(resourceGroupName: string, jobName: string, outputName: string, output: Output, options?: OutputsUpdateOptionalParams): Promise<OutputsUpdateResponse>

Parameters

resourceGroupName

string

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

jobName

string

The name of the streaming job.

outputName

string

The name of the output.

output

Output

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

options

OutputsUpdateOptionalParams

The options parameters.

Returns

Promise<OutputsUpdateResponse>