Compartir a través de


Inputs - Test

Comprueba si el origen de datos de una entrada es accesible y utilizable por el servicio 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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
inputName
path True

string

Nombre de la entrada.

jobName
path True

string

Nombre del trabajo de streaming.

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

Patrón de Regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre Tipo Description
name

string

Nombre del recurso

properties InputProperties:

Propiedades asociadas a una entrada. Se requiere en las solicitudes PUT (CreateOrReplace).

Respuestas

Nombre Tipo Description
200 OK

ResourceTestStatus

La operación de prueba se completó correctamente.

202 Accepted

La solicitud de prueba se inició correctamente.

Other Status Codes

Error

Error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Test the connection for an input

Solicitud de ejemplo

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

Respuesta de muestra

{
  "status": "TestSucceeded"
}

Definiciones

Nombre Description
AuthenticationMode

Modo de autenticación. Los modos válidos son ConnectionString, Msi y "UserToken".

AvroSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Avro.

AzureSqlReferenceInputDataSource

Describe un Azure SQL origen de datos de entrada de referencia de base de datos.

BlobReferenceInputDataSource

Describe un origen de datos de entrada de blobs que contiene datos de referencia.

BlobStreamInputDataSource

Describe un origen de datos de entrada de blobs que contiene datos de flujo.

Compression

Describe cómo se comprimen los datos de entrada.

CompressionType

Indica el tipo de compresión que usa la entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).

CsvSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato CSV.

DiagnosticCondition

Condición aplicable al recurso, o al trabajo en general, que garantiza la atención al cliente.

Diagnostics

Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan la atención al cliente.

Encoding

Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida.

Error

Representación de error común.

ErrorResponse

Describe el error que se produjo.

EventHubStreamInputDataSource

Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.

EventHubV2StreamInputDataSource

Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.

EventSerializationType

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

FileReferenceInputDataSource

Describe un origen de datos de entrada de archivo que contiene datos de referencia.

GatewayMessageBusStreamInputDataSource

Describe un origen de datos de entrada de blobs que contiene datos de flujo.

Input

Objeto de entrada que contiene toda la información asociada a la entrada con nombre. Todas las entradas están contenidas en un trabajo de streaming.

IoTHubStreamInputDataSource

Describe un IoT Hub origen de datos de entrada que contiene datos de flujo.

JsonOutputSerializationFormat

Especifica el formato json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se dará formato al tener cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se dará formato como una matriz de objetos JSON.

JsonSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato JSON.

ParquetSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Parquet.

ReferenceInputProperties

Propiedades asociadas a una entrada que contiene datos de referencia.

RefreshType

Indica el tipo de opción de actualización de datos.

ResourceTestStatus

Describe el estado de la operación de prueba junto con la información de error, si procede.

StorageAccount

Propiedades asociadas a una cuenta de Azure Storage

StreamInputProperties

Propiedades asociadas a una entrada que contiene datos de flujo.

AuthenticationMode

Modo de autenticación. Los modos válidos son ConnectionString, Msi y "UserToken".

Nombre Tipo Description
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Avro.

Nombre Tipo Description
type string:

Avro

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Describe un Azure SQL origen de datos de entrada de referencia de base de datos.

Nombre Tipo Description
properties.database

string

Este elemento está asociado al elemento datasource. Este es el nombre de la base de datos en la que se escribirá la salida.

properties.deltaSnapshotQuery

string

Este elemento está asociado al elemento datasource. Esta consulta se usa para capturar los cambios incrementales de la base de datos SQL. Para usar esta opción, se recomienda usar tablas temporales en Azure SQL Database.

properties.fullSnapshotQuery

string

Este elemento está asociado al elemento datasource. Esta consulta se usa para capturar datos de la base de datos sql.

properties.password

string

Este elemento está asociado al elemento datasource. Esta es la contraseña que se utilizará para conectarse a la instancia de Base de datos SQL.

properties.refreshRate

string

Este elemento está asociado al elemento datasource. Esto indica la frecuencia con la que se capturarán los datos de la base de datos. Es del formato DateTime.

properties.refreshType

RefreshType

Indica el tipo de opción de actualización de datos.

properties.server

string

Este elemento está asociado al elemento datasource. Este es el nombre del servidor que contiene la base de datos en la que se escribirá.

properties.table

string

Este elemento está asociado al elemento datasource. Nombre de la tabla de la Azure SQL base de datos.

properties.user

string

Este elemento está asociado al elemento datasource. Este es el nombre de usuario que se utilizará para conectarse a la instancia de Base de datos SQL.

type string:

Microsoft.Sql/Server/Database

Indica el tipo de origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

BlobReferenceInputDataSource

Describe un origen de datos de entrada de blobs que contiene datos de referencia.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.

properties.container

string

Nombre de un contenedor dentro de la cuenta de almacenamiento asociada. Este contenedor contiene los blobs en los que se van a leer o escribir. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.dateFormat

string

El formato de la fecha. Siempre que {date} aparezca en pathPattern, el valor de esta propiedad se usa como formato de fecha en su lugar.

properties.pathPattern

string

Patrón de ruta de acceso del blob. No es una expresión regular. Representa un patrón con el que se buscarán coincidencias con los nombres de blobs para determinar si se deben incluir como entrada o salida en el trabajo. Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input o https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener una explicación y un ejemplo más detallados.

properties.storageAccounts

StorageAccount[]

Una lista de una o varias cuentas de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.timeFormat

string

Formato de hora. Siempre que aparezca {time} en pathPattern, el valor de esta propiedad se usa como formato de hora en su lugar.

type string:

Microsoft.Storage/Blob

Indica el tipo de origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

BlobStreamInputDataSource

Describe un origen de datos de entrada de blobs que contiene datos de flujo.

Nombre Tipo Valor predeterminado Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.

properties.container

string

Nombre de un contenedor dentro de la cuenta de almacenamiento asociada. Este contenedor contiene los blobs en los que se van a leer o escribir. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.dateFormat

string

El formato de la fecha. Siempre que {date} aparezca en pathPattern, el valor de esta propiedad se usa como formato de fecha en su lugar.

properties.pathPattern

string

Patrón de ruta de acceso del blob. No es una expresión regular. Representa un patrón con el que se buscarán coincidencias con los nombres de blobs para determinar si se deben incluir como entrada o salida en el trabajo. Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input o https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener una explicación y un ejemplo más detallados.

properties.sourcePartitionCount

integer

Recuento de particiones del origen de datos de entrada del blob. Intervalo 1 - 1024.

properties.storageAccounts

StorageAccount[]

Una lista de una o varias cuentas de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.timeFormat

string

Formato de hora. Siempre que aparezca {time} en pathPattern, el valor de esta propiedad se usa como formato de hora en su lugar.

type string:

Microsoft.Storage/Blob

Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

Compression

Describe cómo se comprimen los datos de entrada.

Nombre Tipo Valor predeterminado Description
type

CompressionType

None

Indica el tipo de compresión que usa la entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).

CompressionType

Indica el tipo de compresión que usa la entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).

Nombre Tipo Description
Deflate

string

GZip

string

None

string

CsvSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato CSV.

Nombre Tipo Description
properties.encoding

Encoding

Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.fieldDelimiter

string

Especifica el delimitador que se usará para separar los registros de valores separados por comas (CSV). Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input o https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obtener una lista de valores admitidos. Obligatorio en las solicitudes PUT (CreateOrReplace).

type string:

Csv

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

DiagnosticCondition

Condición aplicable al recurso, o al trabajo en general, que garantiza la atención al cliente.

Nombre Tipo Description
code

string

Código de diagnóstico opaco.

message

string

Mensaje legible que describe la condición en detalle. Localizado en el Accept-Language de la solicitud de cliente.

since

string

Marca de tiempo UTC de cuándo se inició la condición. Los clientes deben poder encontrar un evento correspondiente en el registro de operaciones en este momento.

Diagnostics

Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan la atención al cliente.

Nombre Tipo Description
conditions

DiagnosticCondition[]

Colección de cero o más condiciones aplicables al recurso, o al trabajo en general, que justifican la atención al cliente.

Encoding

Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida.

Nombre Tipo Description
UTF8

string

Error

Representación de error común.

Nombre Tipo Description
error

Error

Propiedades de definición de error.

ErrorResponse

Describe el error que se produjo.

Nombre Tipo Description
code

string

Código de error asociado al error que se produjo.

message

string

Describe el error en detalle.

EventHubStreamInputDataSource

Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.

Nombre Tipo Valor predeterminado Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.

properties.consumerGroupName

string

Nombre de un grupo de consumidores del centro de eventos que se debe usar para leer eventos del centro de eventos. Especificar nombres de grupo de consumidores distintos para varias entradas permite que cada una de esas entradas reciba los mismos eventos del centro de eventos. Si no se especifica, la entrada usa el grupo de consumidores predeterminado del centro de eventos.

properties.eventHubName

string

Nombre del centro de eventos. Obligatorio en las solicitudes PUT (CreateOrReplace).

serviceBusNamespace

string

Espacio de nombres asociado al centro de eventos deseado, cola de Service Bus, tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).

sharedAccessPolicyKey

string

Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Obligatorio en las solicitudes PUT (CreateOrReplace).

sharedAccessPolicyName

string

El nombre de la directiva de acceso compartido para el centro de eventos, la cola de Service Bus, el tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).

type string:

Microsoft.ServiceBus/EventHub

Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

EventHubV2StreamInputDataSource

Describe un origen de datos de entrada del centro de eventos que contiene datos de flujo.

Nombre Tipo Valor predeterminado Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticación.

properties.consumerGroupName

string

Nombre de un grupo de consumidores del centro de eventos que se debe usar para leer eventos del centro de eventos. Especificar nombres de grupo de consumidores distintos para varias entradas permite que cada una de esas entradas reciba los mismos eventos del centro de eventos. Si no se especifica, la entrada usa el grupo de consumidores predeterminado del centro de eventos.

properties.eventHubName

string

Nombre del centro de eventos. Obligatorio en las solicitudes PUT (CreateOrReplace).

serviceBusNamespace

string

Espacio de nombres asociado al centro de eventos deseado, cola de Service Bus, tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).

sharedAccessPolicyKey

string

Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Obligatorio en las solicitudes PUT (CreateOrReplace).

sharedAccessPolicyName

string

El nombre de la directiva de acceso compartido para el centro de eventos, la cola de Service Bus, el tema de Service Bus, etc. Obligatorio en las solicitudes PUT (CreateOrReplace).

type string:

Microsoft.EventHub/EventHub

Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

EventSerializationType

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

Nombre Tipo Description
Avro

string

Csv

string

Json

string

Parquet

string

FileReferenceInputDataSource

Describe un origen de datos de entrada de archivo que contiene datos de referencia.

Nombre Tipo Description
properties.path

string

Ruta de acceso del archivo.

type string:

File

Indica el tipo de origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Describe un origen de datos de entrada de blobs que contiene datos de flujo.

Nombre Tipo Description
properties.topic

string

Nombre del tema de Service Bus.

type string:

GatewayMessageBus

Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

Input

Objeto de entrada que contiene toda la información asociada a la entrada con nombre. Todas las entradas están contenidas en un trabajo de streaming.

Nombre Tipo Description
id

string

Id. de recurso

name

string

Nombre del recurso

properties InputProperties:

Propiedades asociadas a una entrada. Obligatorio en las solicitudes PUT (CreateOrReplace).

type

string

Tipo de recurso

IoTHubStreamInputDataSource

Describe un IoT Hub origen de datos de entrada que contiene datos de flujo.

Nombre Tipo Description
properties.consumerGroupName

string

Nombre de un grupo de consumidores de IoT Hub que se debe usar para leer eventos del IoT Hub. Si no se especifica, la entrada usa el grupo de consumidores predeterminado de Iot Hub.

properties.endpoint

string

El punto de conexión IoT Hub al que conectarse (es decir, mensajes/eventos, mensajes/operacionesMonitoringEvents, etc.).

properties.iotHubNamespace

string

Nombre o URI del IoT Hub. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

Clave de directiva de acceso compartido para la directiva de acceso compartido especificada. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

Nombre de la directiva de acceso compartido para el IoT Hub. Esta directiva debe contener al menos el permiso De conexión de servicio. Obligatorio en las solicitudes PUT (CreateOrReplace).

type string:

Microsoft.Devices/IotHubs

Indica el tipo de origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

JsonOutputSerializationFormat

Especifica el formato json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se dará formato al tener cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se dará formato como una matriz de objetos JSON.

Nombre Tipo Description
Array

string

LineSeparated

string

JsonSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato JSON.

Nombre Tipo Description
properties.encoding

Encoding

Especifica la codificación de los datos entrantes en el caso de la entrada y la codificación de los datos salientes en el caso de la salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

properties.format

JsonOutputSerializationFormat

Esta propiedad solo se aplica a la serialización JSON de salidas. No es aplicable a las entradas. Esta propiedad especifica el formato json en el que se escribirá la salida. Los valores admitidos actualmente son "lineSeparated" que indican que la salida se dará formato al tener cada objeto JSON separado por una nueva línea y "matriz" que indica que la salida se dará formato como una matriz de objetos JSON. El valor predeterminado es "lineSeparated" si se deja null.

type string:

Json

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

ParquetSerialization

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida en formato Parquet.

Nombre Tipo Description
type string:

Parquet

Indica el tipo de serialización que usa la entrada o salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

ReferenceInputProperties

Propiedades asociadas a una entrada que contiene datos de referencia.

Nombre Tipo Description
compression

Compression

Describe cómo se comprimen los datos de entrada.

datasource ReferenceInputDataSource:

Describe un origen de datos de entrada que contiene datos de referencia. Obligatorio en las solicitudes PUT (CreateOrReplace).

diagnostics

Diagnostics

Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan la atención al cliente.

etag

string

Etiqueta de entidad actual para la entrada. Se trata de una cadena opaca. Puede usarlo para detectar si el recurso ha cambiado entre solicitudes. También puede usarlo en los encabezados If-Match o If-None-Match para operaciones de escritura para la simultaneidad optimista.

partitionKey

string

partitionKey Describe una clave en los datos de entrada que se usan para crear particiones de los datos de entrada.

serialization Serialization:

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

type string:

Reference

Indica si la entrada es un origen de datos de referencia o datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

RefreshType

Indica el tipo de opción de actualización de datos.

Nombre Tipo Description
RefreshPeriodicallyWithDelta

string

RefreshPeriodicallyWithFull

string

Static

string

ResourceTestStatus

Describe el estado de la operación de prueba junto con la información de error, si procede.

Nombre Tipo Description
error

ErrorResponse

Describe el error que se produjo.

status

string

Estado de la operación de prueba.

StorageAccount

Propiedades asociadas a una cuenta de Azure Storage

Nombre Tipo Description
accountKey

string

Clave de cuenta de la cuenta de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).

accountName

string

nombre de la cuenta de Azure Storage. Obligatorio en las solicitudes PUT (CreateOrReplace).

StreamInputProperties

Propiedades asociadas a una entrada que contiene datos de flujo.

Nombre Tipo Description
compression

Compression

Describe cómo se comprimen los datos de entrada.

datasource StreamInputDataSource:

Describe un origen de datos de entrada que contiene datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).

diagnostics

Diagnostics

Describe las condiciones aplicables a la entrada, la salida o el trabajo en general, que garantizan la atención al cliente.

etag

string

Etiqueta de entidad actual para la entrada. Se trata de una cadena opaca. Puede usarlo para detectar si el recurso ha cambiado entre solicitudes. También puede usarlo en los encabezados If-Match o If-None-Match para operaciones de escritura para la simultaneidad optimista.

partitionKey

string

partitionKey Describe una clave en los datos de entrada que se usan para crear particiones de los datos de entrada.

serialization Serialization:

Describe cómo se serializan los datos de una entrada o cómo se serializan los datos cuando se escriben en una salida. Obligatorio en las solicitudes PUT (CreateOrReplace).

type string:

Stream

Indica si la entrada es un origen de datos de referencia o datos de flujo. Obligatorio en las solicitudes PUT (CreateOrReplace).