你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Inputs - Test

服务:: Stream Analytics

API 版本:: 2020-03-01

测试输入的数据源是否可供 Azure 流分析服务访问和使用。

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

URI 参数

名称	在	必需	类型	说明
inputName	path	True	string	输入的名称。
jobName	path	True	string	流式处理作业的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
name	string	资源名称
properties	InputProperties: StreamInputProperties ReferenceInputProperties	与输入关联的属性。 PUT （CreateOrReplace）请求时是必需的。

响应

名称	类型	说明
200 OK	ResourceTestStatus	测试作成功完成。
202 Accepted		测试请求已成功启动。
Other Status Codes	Error	错误。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Test the connection for an input

示例请求

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


/**
 * 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, com.azure.core.util.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

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

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

示例响应

状态代码:: 200

{
  "status": "TestSucceeded"
}

状态代码:: 202

定义

名称	说明
AuthenticationMode	身份验证模式。有效模式 `ConnectionString`、`Msi` 和“UserToken”。
AvroSerialization	描述如何序列化来自输入的数据，或者当以 Avro 格式写入输出时如何序列化数据。
AzureSqlReferenceInputDataSource	介绍 Azure SQL 数据库引用输入数据源。
BlobReferenceInputDataSource	描述包含引用数据的 Blob 输入数据源。
BlobStreamInputDataSource	描述包含流数据的 Blob 输入数据源。
Compression	描述如何压缩输入数据
CompressionType	指示输入使用的压缩类型。 PUT （CreateOrReplace）请求时是必需的。
CsvSerialization	描述如何序列化输入中的数据，或者将数据写入 CSV 格式时如何序列化数据。
DiagnosticCondition	适用于资源或整体作业的条件，值得客户注意。
Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
Encoding	指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。
Error	常见的错误表示形式。
ErrorResponse	描述发生的错误。
EventHubStreamInputDataSource	描述包含流数据的事件中心输入数据源。
EventHubV2StreamInputDataSource	描述包含流数据的事件中心输入数据源。
EventSerializationType	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。
FileReferenceInputDataSource	描述包含引用数据的文件输入数据源。
GatewayMessageBusStreamInputDataSource	描述包含流数据的 Blob 输入数据源。
Input	一个输入对象，包含与命名输入关联的所有信息。所有输入都包含在流式处理作业下。
IoTHubStreamInputDataSource	描述包含流数据的 IoT 中心输入数据源。
JsonOutputSerializationFormat	指定输出将写入的 JSON 的格式。当前支持的值是“lineSeparated”，指示输出将设置格式，方法是让每个 JSON 对象用新行分隔，“array”指示输出将格式化为 JSON 对象的数组。
JsonSerialization	描述如何序列化输入中的数据，或者以 JSON 格式写入输出时如何序列化数据。
ParquetSerialization	描述如何序列化输入中的数据，或者当以 Parquet 格式写入输出时如何序列化数据。
ReferenceInputProperties	与包含引用数据的输入关联的属性。
RefreshType	指示数据刷新选项的类型。
ResourceTestStatus	描述测试作的状态以及错误信息（如果适用）。
StorageAccount	与 Azure 存储帐户关联的属性
StreamInputProperties	与包含流数据的输入关联的属性。

AuthenticationMode

枚举

身份验证模式。有效模式 ConnectionString、Msi 和“UserToken”。

值	说明
Msi
UserToken
ConnectionString

AvroSerialization

Object

描述如何序列化来自输入的数据，或者当以 Avro 格式写入输出时如何序列化数据。

名称	类型	说明
type	string: Avro	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

AzureSqlReferenceInputDataSource

Object

介绍 Azure SQL 数据库引用输入数据源。

名称	类型	说明
properties.database	string	此元素与数据源元素相关联。这是输出将写入到的数据库的名称。
properties.deltaSnapshotQuery	string	此元素与数据源元素相关联。此查询用于从 SQL 数据库提取增量更改。若要使用此选项，建议在 Azure SQL 数据库中使用临时表。
properties.fullSnapshotQuery	string	此元素与数据源元素相关联。此查询用于从 sql 数据库提取数据。
properties.password	string	此元素与数据源元素相关联。这是用于连接到 SQL 数据库实例的密码。
properties.refreshRate	string	此元素与数据源元素相关联。这表示从数据库提取数据的频率。它采用 DateTime 格式。
properties.refreshType	RefreshType	指示数据刷新选项的类型。
properties.server	string	此元素与数据源元素相关联。这是包含要写入的数据库的服务器的名称。
properties.table	string	此元素与数据源元素相关联。 Azure SQL 数据库中表的名称。
properties.user	string	此元素与数据源元素相关联。这是用于连接到 SQL 数据库实例的用户名。
type	string: Microsoft.Sql/Server/Database	指示包含引用数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

BlobReferenceInputDataSource

Object

描述包含引用数据的 Blob 输入数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.container	string		关联的存储帐户中的容器的名称。此容器包含要从中读取或写入到的 blob（s）。 PUT （CreateOrReplace）请求时是必需的。
properties.dateFormat	string		日期格式。无论 {date} 出现在 pathPattern 中，此属性的值将改为用作日期格式。
properties.pathPattern	string		Blob 路径模式。不是正则表达式。它表示将匹配 Blob 名称的模式，以确定它们是否应作为作业的输入或输出包含在内。有关更详细的说明和示例，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。
properties.storageAccounts	StorageAccount[]		一个或多个 Azure 存储帐户的列表。 PUT （CreateOrReplace）请求时是必需的。
properties.timeFormat	string		时间格式。无论 {time} 出现在 pathPattern 中，此属性的值将改为用作时间格式。
type	string: Microsoft.Storage/Blob		指示包含引用数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

BlobStreamInputDataSource

Object

描述包含流数据的 Blob 输入数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.container	string		关联的存储帐户中的容器的名称。此容器包含要从中读取或写入到的 blob（s）。 PUT （CreateOrReplace）请求时是必需的。
properties.dateFormat	string		日期格式。无论 {date} 出现在 pathPattern 中，此属性的值将改为用作日期格式。
properties.pathPattern	string		Blob 路径模式。不是正则表达式。它表示将匹配 Blob 名称的模式，以确定它们是否应作为作业的输入或输出包含在内。有关更详细的说明和示例，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。
properties.sourcePartitionCount	integer (int32)		Blob 输入数据源的分区计数。范围 1 - 1024。
properties.storageAccounts	StorageAccount[]		一个或多个 Azure 存储帐户的列表。 PUT （CreateOrReplace）请求时是必需的。
properties.timeFormat	string		时间格式。无论 {time} 出现在 pathPattern 中，此属性的值将改为用作时间格式。
type	string: Microsoft.Storage/Blob		指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

Compression

Object

描述如何压缩输入数据

名称	类型	默认值	说明
type	CompressionType	None	指示输入使用的压缩类型。 PUT （CreateOrReplace）请求时是必需的。

CompressionType

枚举

指示输入使用的压缩类型。 PUT （CreateOrReplace）请求时是必需的。

值	说明
None
GZip
Deflate

CsvSerialization

Object

描述如何序列化输入中的数据，或者将数据写入 CSV 格式时如何序列化数据。

名称	类型	说明
properties.encoding	Encoding	指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。 PUT （CreateOrReplace）请求时是必需的。
properties.fieldDelimiter	string	指定将用于分隔逗号分隔值（CSV）记录的分隔符。有关受支持值列表，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。 PUT （CreateOrReplace）请求时是必需的。
type	string: Csv	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

DiagnosticCondition

Object

适用于资源或整体作业的条件，值得客户注意。

名称	类型	说明
code	string	不透明的诊断代码。
message	string	详细描述条件的可读消息。在客户端请求的 Accept-Language 中本地化。
since	string	条件启动时的 UTC 时间戳。客户此时应该能够在作日志中找到相应的事件。

Diagnostics

Object

描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。

名称	类型	说明
conditions	DiagnosticCondition[]	适用于资源或整体作业的零个或多个条件的集合，值得客户注意。

Encoding

枚举

指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。

值	说明
UTF8

Error

Object

常见的错误表示形式。

名称	类型	说明
error	Error	错误定义属性。

ErrorResponse

Object

描述发生的错误。

名称	类型	说明
code	string	与发生的错误关联的错误代码。
message	string	详细描述错误。

EventHubStreamInputDataSource

Object

描述包含流数据的事件中心输入数据源。

名称	类型	默认值	说明
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.consumerGroupName	string		事件中心使用者组的名称，该组应用于从事件中心读取事件。为多个输入指定不同的使用者组名称允许每个输入从事件中心接收相同的事件。如果未指定，则输入使用事件中心的默认使用者组。
properties.eventHubName	string		事件中心的名称。 PUT （CreateOrReplace）请求时是必需的。
serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.ServiceBus/EventHub		指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

EventHubV2StreamInputDataSource

Object

描述包含流数据的事件中心输入数据源。

名称	类型	默认值	说明
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.consumerGroupName	string		事件中心使用者组的名称，该组应用于从事件中心读取事件。为多个输入指定不同的使用者组名称允许每个输入从事件中心接收相同的事件。如果未指定，则输入使用事件中心的默认使用者组。
properties.eventHubName	string		事件中心的名称。 PUT （CreateOrReplace）请求时是必需的。
serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.EventHub/EventHub		指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

EventSerializationType

枚举

指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

值	说明
Csv
Avro
Json
Parquet

FileReferenceInputDataSource

Object

描述包含引用数据的文件输入数据源。

名称	类型	说明
properties.path	string	文件的路径。
type	string: File	指示包含引用数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

GatewayMessageBusStreamInputDataSource

Object

描述包含流数据的 Blob 输入数据源。

名称	类型	说明
properties.topic	string	服务总线主题的名称。
type	string: GatewayMessageBus	指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

Input

Object

一个输入对象，包含与命名输入关联的所有信息。所有输入都包含在流式处理作业下。

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties	InputProperties: ReferenceInputProperties StreamInputProperties	与输入关联的属性。 PUT （CreateOrReplace）请求时是必需的。
type	string	资源类型

IoTHubStreamInputDataSource

Object

描述包含流数据的 IoT 中心输入数据源。

名称	类型	说明
properties.consumerGroupName	string	应用于从 IoT 中心读取事件的 IoT 中心使用者组的名称。如果未指定，则输入使用 Iot 中心的默认使用者组。
properties.endpoint	string	要连接到的 IoT 中心终结点（例如消息/事件、消息/operationsMonitoringEvents 等）。
properties.iotHubNamespace	string	IoT 中心的名称或 URI。 PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyKey	string	指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyName	string	IoT 中心的共享访问策略名称。此策略必须至少包含服务连接权限。 PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.Devices/IotHubs	指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

JsonOutputSerializationFormat

枚举

指定输出将写入的 JSON 的格式。当前支持的值是“lineSeparated”，指示输出将设置格式，方法是让每个 JSON 对象用新行分隔，“array”指示输出将格式化为 JSON 对象的数组。

值	说明
LineSeparated
Array

JsonSerialization

Object

描述如何序列化输入中的数据，或者以 JSON 格式写入输出时如何序列化数据。

名称	类型	说明
properties.encoding	Encoding	指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。 PUT （CreateOrReplace）请求时是必需的。
properties.format	JsonOutputSerializationFormat	此属性仅适用于输出的 JSON 序列化。它不适用于输入。此属性指定输出将写入的 JSON 的格式。当前支持的值是“lineSeparated”，指示输出将设置格式，方法是让每个 JSON 对象用新行分隔，“array”指示输出将格式化为 JSON 对象的数组。如果为 null，则默认值为“lineSeparated”。
type	string: Json	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

ParquetSerialization

Object

描述如何序列化输入中的数据，或者当以 Parquet 格式写入输出时如何序列化数据。

名称	类型	说明
type	string: Parquet	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

ReferenceInputProperties

Object

与包含引用数据的输入关联的属性。

名称	类型	说明
compression	Compression	描述如何压缩输入数据
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	描述包含引用数据的输入数据源。 PUT （CreateOrReplace）请求时是必需的。
diagnostics	Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
etag	string	输入的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
partitionKey	string	partitionKey 描述用于对输入数据进行分区的输入数据中的键
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	描述如何序列化输入中的数据，或将数据写入输出时如何序列化数据。 PUT （CreateOrReplace）请求时是必需的。
type	string: Reference	指示输入是引用数据源还是流数据源。 PUT （CreateOrReplace）请求时是必需的。

RefreshType

枚举

指示数据刷新选项的类型。

值	说明
Static
RefreshPeriodicallyWithFull
RefreshPeriodicallyWithDelta

ResourceTestStatus

Object

描述测试作的状态以及错误信息（如果适用）。

名称	类型	说明
error	ErrorResponse	描述发生的错误。
status	string	测试作的状态。

StorageAccount

Object

与 Azure 存储帐户关联的属性

名称	类型	说明
accountKey	string	Azure 存储帐户的帐户密钥。 PUT （CreateOrReplace）请求时是必需的。
accountName	string	Azure 存储帐户的名称。 PUT （CreateOrReplace）请求时是必需的。

StreamInputProperties

Object

与包含流数据的输入关联的属性。

名称	类型	说明
compression	Compression	描述如何压缩输入数据
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	描述包含流数据的输入数据源。 PUT （CreateOrReplace）请求时是必需的。
diagnostics	Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
etag	string	输入的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
partitionKey	string	partitionKey 描述用于对输入数据进行分区的输入数据中的键
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	描述如何序列化输入中的数据，或将数据写入输出时如何序列化数据。 PUT （CreateOrReplace）请求时是必需的。
type	string: Stream	指示输入是引用数据源还是流数据源。 PUT （CreateOrReplace）请求时是必需的。

通过

Inputs - Test

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Test the connection for an input

示例请求

示例响应

定义

AuthenticationMode

AvroSerialization

AzureSqlReferenceInputDataSource

BlobReferenceInputDataSource

BlobStreamInputDataSource

Compression

CompressionType

CsvSerialization

DiagnosticCondition

Diagnostics

Encoding

Error

ErrorResponse

EventHubStreamInputDataSource

EventHubV2StreamInputDataSource

EventSerializationType

FileReferenceInputDataSource

GatewayMessageBusStreamInputDataSource

Input

IoTHubStreamInputDataSource

JsonOutputSerializationFormat

JsonSerialization

ParquetSerialization

ReferenceInputProperties

RefreshType

ResourceTestStatus

StorageAccount

StreamInputProperties