Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Outputs

Package version

Class representing a Outputs.

Hierarchy

  • Outputs

Index

Constructors

Methods

Constructors

constructor

Methods

beginTest

  • beginTest(resourceGroupName: string, jobName: string, outputName: string, options?: Models.OutputsBeginTestOptionalParams): Promise<msRestAzure.LROPoller>

  • 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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • Optional options: Models.OutputsBeginTestOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrReplace

  • createOrReplace(output: Output, resourceGroupName: string, jobName: string, outputName: string, options?: Models.OutputsCreateOrReplaceOptionalParams): Promise<Models.OutputsCreateOrReplaceResponse>
  • createOrReplace(output: Output, resourceGroupName: string, jobName: string, outputName: string, callback: msRest.ServiceCallback<Output>): void
  • createOrReplace(output: Output, resourceGroupName: string, jobName: string, outputName: string, options: OutputsCreateOrReplaceOptionalParams, callback: msRest.ServiceCallback<Output>): void

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

    Parameters

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

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • Optional options: Models.OutputsCreateOrReplaceOptionalParams

    Returns Promise<Models.OutputsCreateOrReplaceResponse>

    Promise<Models.OutputsCreateOrReplaceResponse>

  • Parameters

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

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • callback: msRest.ServiceCallback<Output>

      The callback

    Returns void

  • Parameters

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

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • options: OutputsCreateOrReplaceOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Output>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, jobName: string, outputName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, jobName: string, outputName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, jobName: string, outputName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes an output from the streaming job.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, jobName: string, outputName: string, options?: msRest.RequestOptionsBase): Promise<Models.OutputsGetResponse>
  • get(resourceGroupName: string, jobName: string, outputName: string, callback: msRest.ServiceCallback<Output>): void
  • get(resourceGroupName: string, jobName: string, outputName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Output>): void

  • Gets details about the specified output.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.OutputsGetResponse>

    Promise<Models.OutputsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • callback: msRest.ServiceCallback<Output>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Output>

      The callback

    Returns void

listByStreamingJob

  • listByStreamingJob(resourceGroupName: string, jobName: string, options?: Models.OutputsListByStreamingJobOptionalParams): Promise<Models.OutputsListByStreamingJobResponse>
  • listByStreamingJob(resourceGroupName: string, jobName: string, callback: msRest.ServiceCallback<OutputListResult>): void
  • listByStreamingJob(resourceGroupName: string, jobName: string, options: OutputsListByStreamingJobOptionalParams, callback: msRest.ServiceCallback<OutputListResult>): void

  • Lists all of the outputs under the specified streaming job.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.OutputsListByStreamingJobOptionalParams

    Returns Promise<Models.OutputsListByStreamingJobResponse>

    Promise<Models.OutputsListByStreamingJobResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • callback: msRest.ServiceCallback<OutputListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • options: OutputsListByStreamingJobOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<OutputListResult>

      The callback

    Returns void

listByStreamingJobNext

  • listByStreamingJobNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.OutputsListByStreamingJobNextResponse>
  • listByStreamingJobNext(nextPageLink: string, callback: msRest.ServiceCallback<OutputListResult>): void
  • listByStreamingJobNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<OutputListResult>): void

  • Lists all of the outputs under the specified streaming job.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.OutputsListByStreamingJobNextResponse>

    Promise<Models.OutputsListByStreamingJobNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<OutputListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<OutputListResult>

      The callback

    Returns void

test

  • test(resourceGroupName: string, jobName: string, outputName: string, options?: Models.OutputsTestOptionalParams): Promise<Models.OutputsTestResponse>

  • 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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • Optional options: Models.OutputsTestOptionalParams

    Returns Promise<Models.OutputsTestResponse>

    Promise<Models.OutputsTestResponse>

update

  • update(output: Output, resourceGroupName: string, jobName: string, outputName: string, options?: Models.OutputsUpdateOptionalParams): Promise<Models.OutputsUpdateResponse>
  • update(output: Output, resourceGroupName: string, jobName: string, outputName: string, callback: msRest.ServiceCallback<Output>): void
  • update(output: Output, resourceGroupName: string, jobName: string, outputName: string, options: OutputsUpdateOptionalParams, callback: msRest.ServiceCallback<Output>): void

  • 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

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

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • Optional options: Models.OutputsUpdateOptionalParams

    Returns Promise<Models.OutputsUpdateResponse>

    Promise<Models.OutputsUpdateResponse>

  • Parameters

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

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • callback: msRest.ServiceCallback<Output>

      The callback

    Returns void

  • Parameters

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

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • outputName: string

      The name of the output.

    • options: OutputsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Output>

      The callback

    Returns void

Generated using TypeDoc