Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Inputs

Package version

Class representing a Inputs.

Hierarchy

  • Inputs

Index

Constructors

Methods

Constructors

constructor

Methods

beginTest

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

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

    • inputName: string

      The name of the input.

    • Optional options: Models.InputsBeginTestOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrReplace

  • createOrReplace(input: Input, resourceGroupName: string, jobName: string, inputName: string, options?: Models.InputsCreateOrReplaceOptionalParams): Promise<Models.InputsCreateOrReplaceResponse>
  • createOrReplace(input: Input, resourceGroupName: string, jobName: string, inputName: string, callback: msRest.ServiceCallback<Input>): void
  • createOrReplace(input: Input, resourceGroupName: string, jobName: string, inputName: string, options: InputsCreateOrReplaceOptionalParams, callback: msRest.ServiceCallback<Input>): void

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

    Parameters

    • input: Input

      The definition of the input that will be used to create a new input 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.

    • inputName: string

      The name of the input.

    • Optional options: Models.InputsCreateOrReplaceOptionalParams

    Returns Promise<Models.InputsCreateOrReplaceResponse>

    Promise<Models.InputsCreateOrReplaceResponse>

  • Parameters

    • input: Input

      The definition of the input that will be used to create a new input 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.

    • inputName: string

      The name of the input.

    • callback: msRest.ServiceCallback<Input>

      The callback

    Returns void

  • Parameters

    • input: Input

      The definition of the input that will be used to create a new input 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.

    • inputName: string

      The name of the input.

    • options: InputsCreateOrReplaceOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Input>

      The callback

    Returns void

deleteMethod

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

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

    • inputName: string

      The name of the input.

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

    • inputName: string

      The name of the input.

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

    • inputName: string

      The name of the input.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, jobName: string, inputName: string, options?: msRest.RequestOptionsBase): Promise<Models.InputsGetResponse>
  • get(resourceGroupName: string, jobName: string, inputName: string, callback: msRest.ServiceCallback<Input>): void
  • get(resourceGroupName: string, jobName: string, inputName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Input>): void

  • Gets details about the specified input.

    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.

    • inputName: string

      The name of the input.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.InputsGetResponse>

    Promise<Models.InputsGetResponse>

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

    • inputName: string

      The name of the input.

    • callback: msRest.ServiceCallback<Input>

      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.

    • inputName: string

      The name of the input.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Input>

      The callback

    Returns void

listByStreamingJob

  • listByStreamingJob(resourceGroupName: string, jobName: string, options?: Models.InputsListByStreamingJobOptionalParams): Promise<Models.InputsListByStreamingJobResponse>
  • listByStreamingJob(resourceGroupName: string, jobName: string, callback: msRest.ServiceCallback<InputListResult>): void
  • listByStreamingJob(resourceGroupName: string, jobName: string, options: InputsListByStreamingJobOptionalParams, callback: msRest.ServiceCallback<InputListResult>): void

  • Lists all of the inputs 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.InputsListByStreamingJobOptionalParams

    Returns Promise<Models.InputsListByStreamingJobResponse>

    Promise<Models.InputsListByStreamingJobResponse>

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

      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: InputsListByStreamingJobOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<InputListResult>

      The callback

    Returns void

listByStreamingJobNext

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

  • Lists all of the inputs 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.InputsListByStreamingJobNextResponse>

    Promise<Models.InputsListByStreamingJobNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<InputListResult>

      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<InputListResult>

      The callback

    Returns void

test

  • test(resourceGroupName: string, jobName: string, inputName: string, options?: Models.InputsTestOptionalParams): Promise<Models.InputsTestResponse>

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

    • inputName: string

      The name of the input.

    • Optional options: Models.InputsTestOptionalParams

    Returns Promise<Models.InputsTestResponse>

    Promise<Models.InputsTestResponse>

update

  • update(input: Input, resourceGroupName: string, jobName: string, inputName: string, options?: Models.InputsUpdateOptionalParams): Promise<Models.InputsUpdateResponse>
  • update(input: Input, resourceGroupName: string, jobName: string, inputName: string, callback: msRest.ServiceCallback<Input>): void
  • update(input: Input, resourceGroupName: string, jobName: string, inputName: string, options: InputsUpdateOptionalParams, callback: msRest.ServiceCallback<Input>): void

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

    Parameters

    • input: Input

      An Input object. The properties specified here will overwrite the corresponding properties in the existing input (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.

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

    • inputName: string

      The name of the input.

    • Optional options: Models.InputsUpdateOptionalParams

    Returns Promise<Models.InputsUpdateResponse>

    Promise<Models.InputsUpdateResponse>

  • Parameters

    • input: Input

      An Input object. The properties specified here will overwrite the corresponding properties in the existing input (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.

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

    • inputName: string

      The name of the input.

    • callback: msRest.ServiceCallback<Input>

      The callback

    Returns void

  • Parameters

    • input: Input

      An Input object. The properties specified here will overwrite the corresponding properties in the existing input (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.

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

    • inputName: string

      The name of the input.

    • options: InputsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Input>

      The callback

    Returns void

Generated using TypeDoc