Поделиться через


Inputs - Test

Проверяет, доступен ли входной источник данных и доступен ли он службе Azure Stream Analytics.

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

Имя группы ресурсов. Регистр букв в имени не учитывается.

Шаблон регулярного выражения: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Тип Описание
name

string

Имя ресурса

properties InputProperties:

Свойства, связанные с входными данными. Требуется для запросов PUT (CreateOrReplace).

Ответы

Имя Тип Описание
200 OK

ResourceTestStatus

Тестовая операция успешно завершена.

202 Accepted

Тестовый запрос был успешно инициирован.

Other Status Codes

Error

Ошибка.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: 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

Пример ответа

{
  "status": "TestSucceeded"
}

Определения

Имя Описание
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

Описывает источник входных данных Центр Интернета вещей, содержащий потоковые данные.

JsonOutputSerializationFormat

Указывает формат JSON, в котором будут записаны выходные данные. В настоящее время поддерживаются значения lineSeparated, указывающие, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой и массива, указывающего, что выходные данные будут отформатированы в виде массива объектов JSON.

JsonSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате JSON.

ParquetSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате Parquet.

ReferenceInputProperties

Свойства, связанные с входными данными, содержащими ссылочные данные.

RefreshType

Указывает тип параметра обновления данных.

ResourceTestStatus

Описывает состояние тестовой операции, а также сведения об ошибке, если применимо.

StorageAccount

Свойства, связанные с учетной записью хранения Azure

StreamInputProperties

Свойства, связанные с входными данными, содержащими потоковые данные.

AuthenticationMode

Режим проверки подлинности. Допустимые режимы: ConnectionString, Msi и UserToken.

Имя Тип Описание
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

Описывается сериализация данных из входных данных или сериализация данных при записи в выходные данные в формате Avro.

Имя Тип Описание
type string:

Avro

Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Описывает источник входных данных Azure SQL базы данных.

Имя Тип Описание
properties.database

string

Этот элемент связан с элементом datasource. Это имя базы данных, в которую буду записаны выходные данные.

properties.deltaSnapshotQuery

string

Этот элемент связан с элементом datasource. Этот запрос используется для получения добавочных изменений из базы данных SQL. Чтобы использовать этот параметр, рекомендуется использовать темпоральные таблицы в базе данных Azure SQL.

properties.fullSnapshotQuery

string

Этот элемент связан с элементом datasource. Этот запрос используется для получения данных из базы данных SQL.

properties.password

string

Этот элемент связан с элементом datasource. Это пароль, который будет использоваться для подключения к экземпляру базы данных SQL.

properties.refreshRate

string

Этот элемент связан с элементом datasource. Это указывает, как часто данные будут извлекаться из базы данных. Имеет формат DateTime.

properties.refreshType

RefreshType

Указывает тип параметра обновления данных.

properties.server

string

Этот элемент связан с элементом datasource. Это имя сервера, содержащего базу данных,в которую будет выполняться запись.

properties.table

string

Этот элемент связан с элементом datasource. Имя таблицы в базе данных Azure SQL.

properties.user

string

Этот элемент связан с элементом datasource. Это имя пользователя, которое будет использоваться для подключения к экземпляру базы данных SQL.

type string:

Microsoft.Sql/Server/Database

Указывает тип источника входных данных, содержащего эталонные данные. Требуется для запросов PUT (CreateOrReplace).

BlobReferenceInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий эталонные данные.

Имя Тип Default value Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.container

string

Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит большие двоичные объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).

properties.dateFormat

string

Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.

properties.pathPattern

string

Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, по которому имена 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

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

Имя Тип Default value Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.container

string

Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит большие двоичные объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).

properties.dateFormat

string

Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.

properties.pathPattern

string

Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, по которому имена 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

Число секций источника входных данных BLOB-объекта. Диапазон от 1 до 1024.

properties.storageAccounts

StorageAccount[]

Список из одной или нескольких учетных записей хранения Azure. Требуется для запросов PUT (CreateOrReplace).

properties.timeFormat

string

Формат времени. Везде, где {time} отображается в pathPattern, в качестве формата времени используется значение этого свойства.

type string:

Microsoft.Storage/Blob

Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

Compression

Описывает, как сжимаются входные данные

Имя Тип Default value Описание
type

CompressionType

None

Указывает тип сжатия, используемого входными данными. Требуется для запросов PUT (CreateOrReplace).

CompressionType

Указывает тип сжатия, используемого входными данными. Требуется для запросов PUT (CreateOrReplace).

Имя Тип Описание
Deflate

string

GZip

string

None

string

CsvSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате 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

Условие, применимое к ресурсу или заданию в целом, которое требует внимания клиента.

Имя Тип Описание
code

string

Непрозрачный диагностический код.

message

string

Понятное сообщение с подробным описанием условия. Локализовано в Accept-Language клиентского запроса.

since

string

Метка времени начала условия в формате UTC. Клиенты должны найти соответствующее событие в журнале операций примерно в это время.

Diagnostics

Описывает условия, применимые к входным, выходным данным или заданию в целом, которые требуют внимания клиента.

Имя Тип Описание
conditions

DiagnosticCondition[]

Коллекция из нуля или более условий, применимых к ресурсу или к заданию в целом, которые требуют внимания клиента.

Encoding

Задает кодировку входящих данных в случае входных данных и кодировку исходящих данных в случае выходных данных.

Имя Тип Описание
UTF8

string

Error

Представление распространенных ошибок.

Имя Тип Описание
error

Error

Свойства определения ошибки.

ErrorResponse

Описывает возникную ошибку.

Имя Тип Описание
code

string

Код ошибки, связанный с возникной ошибкой.

message

string

Подробно описывает ошибку.

EventHubStreamInputDataSource

Описывает источник входных данных концентратора событий, содержащий потоковые данные.

Имя Тип Default value Описание
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

Описывает источник входных данных концентратора событий, содержащий потоковые данные.

Имя Тип Default value Описание
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).

Имя Тип Описание
Avro

string

Csv

string

Json

string

Parquet

string

FileReferenceInputDataSource

Описывает источник входных данных файла, содержащий эталонные данные.

Имя Тип Описание
properties.path

string

Путь к файлу.

type string:

File

Указывает тип источника входных данных, содержащего эталонные данные. Требуется для запросов PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

Имя Тип Описание
properties.topic

string

Имя раздела служебной шины.

type string:

GatewayMessageBus

Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

Input

Входной объект, содержащий все сведения, связанные с именованным входным объектом. Все входные данные содержатся в задании потоковой передачи.

Имя Тип Описание
id

string

Идентификатор ресурса

name

string

Имя ресурса

properties InputProperties:

Свойства, связанные с входными данными. Требуется для запросов PUT (CreateOrReplace).

type

string

Тип ресурса

IoTHubStreamInputDataSource

Описывает источник входных данных Центр Интернета вещей, содержащий потоковые данные.

Имя Тип Описание
properties.consumerGroupName

string

Имя группы потребителей Центр Интернета вещей, которая должна использоваться для чтения событий из Центр Интернета вещей. Если не указано, входные данные используют группу потребителей Центра Интернета вещей по умолчанию.

properties.endpoint

string

Конечная точка Центр Интернета вещей для подключения (например, messages/events, messages/operationsMonitoringEvents и т. д.).

properties.iotHubNamespace

string

Имя или URI Центр Интернета вещей. Требуется для запросов PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

Ключ политики общего доступа для указанной политики общего доступа. Требуется для запросов PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

Имя политики общего доступа для Центр Интернета вещей. Эта политика должна содержать по крайней мере разрешение на подключение к службе. Требуется для запросов PUT (CreateOrReplace).

type string:

Microsoft.Devices/IotHubs

Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

JsonOutputSerializationFormat

Указывает формат JSON, в котором будут записаны выходные данные. В настоящее время поддерживаются значения lineSeparated, указывающие, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой и массива, указывающего, что выходные данные будут отформатированы в виде массива объектов JSON.

Имя Тип Описание
Array

string

LineSeparated

string

JsonSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате JSON.

Имя Тип Описание
properties.encoding

Encoding

Задает кодировку входящих данных в случае входных данных и кодировку исходящих данных в случае выходных данных. Требуется для запросов PUT (CreateOrReplace).

properties.format

JsonOutputSerializationFormat

Это свойство применяется только к сериализации выходных данных JSON. Она неприменима к входным данным. Это свойство задает формат JSON, в который будут записаны выходные данные. В настоящее время поддерживаются значения lineSeparated, указывающие, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой и массива, указывающего, что выходные данные будут отформатированы в виде массива объектов JSON. Значение по умолчанию — lineSeparated, если оставить значение NULL.

type string:

Json

Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

ParquetSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате Parquet.

Имя Тип Описание
type string:

Parquet

Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

ReferenceInputProperties

Свойства, связанные с входными данными, содержащими ссылочные данные.

Имя Тип Описание
compression

Compression

Описывает, как сжимаются входные данные

datasource ReferenceInputDataSource:

Описывает источник входных данных, содержащий эталонные данные. Требуется для запросов PUT (CreateOrReplace).

diagnostics

Diagnostics

Описывает условия, применимые к входным, выходным данным или заданию в целом, которые требуют внимания клиента.

etag

string

Текущий тег сущности для входных данных. Это непрозрачная строка. С его помощью можно определить, изменился ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

partitionKey

string

partitionKey Описывает ключ во входных данных, который используется для секционирования входных данных.

serialization Serialization:

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные. Требуется для запросов PUT (CreateOrReplace).

type string:

Reference

Указывает, является ли вход источником ссылочных данных или потоковых данных. Требуется для запросов PUT (CreateOrReplace).

RefreshType

Указывает тип параметра обновления данных.

Имя Тип Описание
RefreshPeriodicallyWithDelta

string

RefreshPeriodicallyWithFull

string

Static

string

ResourceTestStatus

Описывает состояние тестовой операции, а также сведения об ошибке, если применимо.

Имя Тип Описание
error

ErrorResponse

Описывает возникную ошибку.

status

string

Состояние тестовой операции.

StorageAccount

Свойства, связанные с учетной записью хранения Azure

Имя Тип Описание
accountKey

string

Ключ учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

accountName

string

имя учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

StreamInputProperties

Свойства, связанные с входными данными, содержащими потоковые данные.

Имя Тип Описание
compression

Compression

Описывает, как сжимаются входные данные

datasource StreamInputDataSource:

Описывает источник входных данных, содержащий потоковые данные. Требуется для запросов PUT (CreateOrReplace).

diagnostics

Diagnostics

Описывает условия, применимые к входным, выходным данным или заданию в целом, которые требуют внимания клиента.

etag

string

Текущий тег сущности для входных данных. Это непрозрачная строка. С его помощью можно определить, изменился ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

partitionKey

string

partitionKey Описывает ключ во входных данных, который используется для секционирования входных данных.

serialization Serialization:

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные. Требуется для запросов PUT (CreateOrReplace).

type string:

Stream

Указывает, является ли вход источником ссылочных данных или потоковых данных. Требуется для запросов PUT (CreateOrReplace).