Package version:

Interface Outputs

Interface representing a Outputs.

interface Outputs {
    beginTest(resourceGroupName, jobName, outputName, options?): Promise<SimplePollerLike<OperationState<ResourceTestStatus>, ResourceTestStatus>>;
    beginTestAndWait(resourceGroupName, jobName, outputName, options?): Promise<ResourceTestStatus>;
    createOrReplace(resourceGroupName, jobName, outputName, output, options?): Promise<OutputsCreateOrReplaceResponse>;
    delete(resourceGroupName, jobName, outputName, options?): Promise<void>;
    get(resourceGroupName, jobName, outputName, options?): Promise<OutputsGetResponse>;
    listByStreamingJob(resourceGroupName, jobName, options?): PagedAsyncIterableIterator<Output>;
    update(resourceGroupName, jobName, outputName, output, options?): Promise<OutputsUpdateResponse>;
}

Methods

beginTest beginTestAndWait createOrReplace delete get listByStreamingJob update

Methods

beginTest

beginTestAndWait

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

  • Tests whether an output’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.

    • outputName: string

      The name of the output.

    • Optional options: OutputsTestOptionalParams

      The options parameters.

    Returns Promise<ResourceTestStatus>

createOrReplace

  • createOrReplace(resourceGroupName, jobName, outputName, output, options?): Promise<OutputsCreateOrReplaceResponse>

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

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

    • Optional options: OutputsCreateOrReplaceOptionalParams

      The options parameters.

    Returns Promise<OutputsCreateOrReplaceResponse>

delete

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

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

    • outputName: string

      The name of the output.

    • Optional options: OutputsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

get

listByStreamingJob

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

  • Lists all of the outputs 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: OutputsListByStreamingJobOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Output>

update

  • update(resourceGroupName, jobName, outputName, output, options?): Promise<OutputsUpdateResponse>

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

    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.

    • Optional options: OutputsUpdateOptionalParams

      The options parameters.

    Returns Promise<OutputsUpdateResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc