Inputs interface
Interface representing a Inputs.
Methods
| begin |
Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service. |
| begin |
Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service. |
| create |
Creates an input or replaces an already existing input under an existing streaming job. |
| delete(string, string, string, Inputs |
Deletes an input from the streaming job. |
| get(string, string, string, Inputs |
Gets details about the specified input. |
| list |
Lists all of the inputs under the specified streaming job. |
| update(string, string, string, Input, Inputs |
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. |
Method Details
beginTest(string, string, string, InputsTestOptionalParams)
Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
function beginTest(resourceGroupName: string, jobName: string, inputName: string, options?: InputsTestOptionalParams): 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.
- inputName
-
string
The name of the input.
- options
- InputsTestOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ResourceTestStatus>, ResourceTestStatus>>
beginTestAndWait(string, string, string, InputsTestOptionalParams)
Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
function beginTestAndWait(resourceGroupName: string, jobName: string, inputName: string, options?: InputsTestOptionalParams): Promise<ResourceTestStatus>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- inputName
-
string
The name of the input.
- options
- InputsTestOptionalParams
The options parameters.
Returns
Promise<ResourceTestStatus>
createOrReplace(string, string, string, Input, InputsCreateOrReplaceOptionalParams)
Creates an input or replaces an already existing input under an existing streaming job.
function createOrReplace(resourceGroupName: string, jobName: string, inputName: string, input: Input, options?: InputsCreateOrReplaceOptionalParams): Promise<InputsCreateOrReplaceResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- inputName
-
string
The name of the input.
- 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.
The options parameters.
Returns
Promise<InputsCreateOrReplaceResponse>
delete(string, string, string, InputsDeleteOptionalParams)
Deletes an input from the streaming job.
function delete(resourceGroupName: string, jobName: string, inputName: string, options?: InputsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- inputName
-
string
The name of the input.
- options
- InputsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, InputsGetOptionalParams)
Gets details about the specified input.
function get(resourceGroupName: string, jobName: string, inputName: string, options?: InputsGetOptionalParams): Promise<InputsGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- inputName
-
string
The name of the input.
- options
- InputsGetOptionalParams
The options parameters.
Returns
Promise<InputsGetResponse>
listByStreamingJob(string, string, InputsListByStreamingJobOptionalParams)
Lists all of the inputs under the specified streaming job.
function listByStreamingJob(resourceGroupName: string, jobName: string, options?: InputsListByStreamingJobOptionalParams): PagedAsyncIterableIterator<Input, Input[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
The options parameters.
Returns
update(string, string, string, Input, InputsUpdateOptionalParams)
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.
function update(resourceGroupName: string, jobName: string, inputName: string, input: Input, options?: InputsUpdateOptionalParams): Promise<InputsUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- jobName
-
string
The name of the streaming job.
- inputName
-
string
The name of the input.
- 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.
- options
- InputsUpdateOptionalParams
The options parameters.
Returns
Promise<InputsUpdateResponse>