Inputs - Test

Service:

Stream Analytics

API Version:

2020-03-01

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}/test?api-version=2020-03-01

URI Parameters

Name	In	Required	Type	Description
inputName	path	True	string	The name of the input.
jobName	path	True	string	The name of the streaming job.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
name	string	Resource name
properties	InputProperties: StreamInputProperties ReferenceInputProperties	The properties that are associated with an input. Required on PUT (CreateOrReplace) requests.

Responses

Name	Type	Description
200 OK	ResourceTestStatus	The test operation completed successfully.
202 Accepted		The test request was successfully initiated.
Other Status Codes	Error	Error.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Test the connection for an input

Sample request

HTTP

POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225/test?api-version=2020-03-01

Java

import com.azure.core.util.Context;

/** Samples for Inputs Test. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Test.json
     */
    /**
     * Sample code: Test the connection for an input.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void testTheConnectionForAnInput(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.inputs().test("sjrg8440", "sj9597", "input7225", null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Test.json
func ExampleInputsClient_BeginTest() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewInputsClient().BeginTest(ctx, "sjrg8440", "sj9597", "input7225", &armstreamanalytics.InputsClientBeginTestOptions{Input: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ResourceTestStatus = armstreamanalytics.ResourceTestStatus{
	// 	Status: to.Ptr("TestSucceeded"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
 *
 * @summary Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Test.json
 */
async function testTheConnectionForAnInput() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg8440";
  const jobName = "sj9597";
  const inputName = "input7225";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.inputs.beginTestAndWait(resourceGroupName, jobName, inputName);
  console.log(result);
}

testTheConnectionForAnInput().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "status": "TestSucceeded"
}

Status code:

202

Definitions

Name	Description
AuthenticationMode	Authentication Mode. Valid modes are ConnectionString, Msi and 'UserToken'.
AvroSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.
AzureSqlReferenceInputDataSource	Describes an Azure SQL database reference input data source.
BlobReferenceInputDataSource	Describes a blob input data source that contains reference data.
BlobStreamInputDataSource	Describes a blob input data source that contains stream data.
Compression	Describes how input data is compressed
CompressionType	Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.
CsvSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.
DiagnosticCondition	Condition applicable to the resource, or to the job overall, that warrant customer attention.
Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
Encoding	Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.
Error	Common error representation.
ErrorResponse	Describes the error that occurred.
EventHubStreamInputDataSource	Describes an Event Hub input data source that contains stream data.
EventHubV2StreamInputDataSource	Describes an Event Hub input data source that contains stream data.
EventSerializationType	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.
FileReferenceInputDataSource	Describes a file input data source that contains reference data.
GatewayMessageBusStreamInputDataSource	Describes a blob input data source that contains stream data.
Input	An input object, containing all information associated with the named input. All inputs are contained under a streaming job.
IoTHubStreamInputDataSource	Describes an IoT Hub input data source that contains stream data.
JsonOutputSerializationFormat	Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.
JsonSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.
ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.
ReferenceInputProperties	The properties that are associated with an input containing reference data.
RefreshType	Indicates the type of data refresh option.
ResourceTestStatus	Describes the status of the test operation along with error information, if applicable.
StorageAccount	The properties that are associated with an Azure Storage account
StreamInputProperties	The properties that are associated with an input containing stream data.

AuthenticationMode

Authentication Mode. Valid modes are ConnectionString, Msi and 'UserToken'.

Name	Type	Description
ConnectionString	string
Msi	string
UserToken	string

AvroSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.

Name	Type	Description
type	string: Avro	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

AzureSqlReferenceInputDataSource

Describes an Azure SQL database reference input data source.

Name	Type	Description
properties.database	string	This element is associated with the datasource element. This is the name of the database that output will be written to.
properties.deltaSnapshotQuery	string	This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database.
properties.fullSnapshotQuery	string	This element is associated with the datasource element. This query is used to fetch data from the sql database.
properties.password	string	This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance.
properties.refreshRate	string	This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format.
properties.refreshType	RefreshType	Indicates the type of data refresh option.
properties.server	string	This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.
properties.table	string	This element is associated with the datasource element. The name of the table in the Azure SQL database..
properties.user	string	This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance.
type	string: Microsoft.Sql/Server/Database	Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

BlobReferenceInputDataSource

Describes a blob input data source that contains reference data.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.container	string		The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.
properties.dateFormat	string		The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.
properties.pathPattern	string		The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.
properties.storageAccounts	StorageAccount[]		A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.
properties.timeFormat	string		The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.
type	string: Microsoft.Storage/Blob		Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

BlobStreamInputDataSource

Describes a blob input data source that contains stream data.

Name	Type	Default value	Description
properties.authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.container	string		The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.
properties.dateFormat	string		The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.
properties.pathPattern	string		The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.
properties.sourcePartitionCount	integer		The partition count of the blob input data source. Range 1 - 1024.
properties.storageAccounts	StorageAccount[]		A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.
properties.timeFormat	string		The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.
type	string: Microsoft.Storage/Blob		Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

Compression

Describes how input data is compressed

Name	Type	Default value	Description
type	CompressionType	None	Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.

CompressionType

Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.

Name	Type	Description
Deflate	string
GZip	string
None	string

CsvSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.

Name	Type	Description
properties.encoding	Encoding	Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.
properties.fieldDelimiter	string	Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests.
type	string: Csv	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

DiagnosticCondition

Condition applicable to the resource, or to the job overall, that warrant customer attention.

Name	Type	Description
code	string	The opaque diagnostic code.
message	string	The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request.
since	string	The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time.

Diagnostics

Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.

Name	Type	Description
conditions	DiagnosticCondition[]	A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention.

Encoding

Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.

Name	Type	Description
UTF8	string

Error

Common error representation.

Name	Type	Description
error	Error	Error definition properties.

ErrorResponse

Describes the error that occurred.

Name	Type	Description
code	string	Error code associated with the error that occurred.
message	string	Describes the error in detail.

EventHubStreamInputDataSource

Describes an Event Hub input data source that contains stream data.

Name	Type	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.consumerGroupName	string		The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.
properties.eventHubName	string		The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.ServiceBus/EventHub		Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

EventHubV2StreamInputDataSource

Describes an Event Hub input data source that contains stream data.

Name	Type	Default value	Description
authenticationMode	AuthenticationMode	ConnectionString	Authentication Mode.
properties.consumerGroupName	string		The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.
properties.eventHubName	string		The name of the Event Hub. Required on PUT (CreateOrReplace) requests.
serviceBusNamespace	string		The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyKey	string		The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
sharedAccessPolicyName	string		The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.EventHub/EventHub		Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

EventSerializationType

Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

Name	Type	Description
Avro	string
Csv	string
Json	string
Parquet	string

FileReferenceInputDataSource

Describes a file input data source that contains reference data.

Name	Type	Description
properties.path	string	The path of the file.
type	string: File	Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests.

GatewayMessageBusStreamInputDataSource

Describes a blob input data source that contains stream data.

Name	Type	Description
properties.topic	string	The name of the Service Bus topic.
type	string: GatewayMessageBus	Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

Input

An input object, containing all information associated with the named input. All inputs are contained under a streaming job.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties	InputProperties: ReferenceInputProperties StreamInputProperties	The properties that are associated with an input. Required on PUT (CreateOrReplace) requests.
type	string	Resource type

IoTHubStreamInputDataSource

Describes an IoT Hub input data source that contains stream data.

Name	Type	Description
properties.consumerGroupName	string	The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.
properties.endpoint	string	The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).
properties.iotHubNamespace	string	The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyKey	string	The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.
properties.sharedAccessPolicyName	string	The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.
type	string: Microsoft.Devices/IotHubs	Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests.

JsonOutputSerializationFormat

Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.

Name	Type	Description
Array	string
LineSeparated	string

JsonSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.

Name	Type	Description
properties.encoding	Encoding	Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.
properties.format	JsonOutputSerializationFormat	This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null.
type	string: Json	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

ParquetSerialization

Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.

Name	Type	Description
type	string: Parquet	Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.

ReferenceInputProperties

The properties that are associated with an input containing reference data.

Name	Type	Description
compression	Compression	Describes how input data is compressed
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests.
diagnostics	Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
etag	string	The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
partitionKey	string	partitionKey Describes a key in the input data which is used for partitioning the input data
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
type	string: Reference	Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.

RefreshType

Indicates the type of data refresh option.

Name	Type	Description
RefreshPeriodicallyWithDelta	string
RefreshPeriodicallyWithFull	string
Static	string

ResourceTestStatus

Describes the status of the test operation along with error information, if applicable.

Name	Type	Description
error	ErrorResponse	Describes the error that occurred.
status	string	The status of the test operation.

StorageAccount

The properties that are associated with an Azure Storage account

Name	Type	Description
accountKey	string	The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.
accountName	string	The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

StreamInputProperties

The properties that are associated with an input containing stream data.

Name	Type	Description
compression	Compression	Describes how input data is compressed
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	Describes an input data source that contains stream data. Required on PUT (CreateOrReplace) requests.
diagnostics	Diagnostics	Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.
etag	string	The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
partitionKey	string	partitionKey Describes a key in the input data which is used for partitioning the input data
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests.
type	string: Stream	Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests.