Partilhar via


Inputs - Test

Testa se a fonte de dados de uma entrada é acessível e utilizável pelo serviço 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 do URI

Name Em Necessário Tipo Description
inputName
path True

string

O nome da entrada.

jobName
path True

string

O nome do trabalho de streaming.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo do Pedido

Name Tipo Description
name

string

Nome do recurso

properties InputProperties:

As propriedades associadas a uma entrada. Necessário em solicitações PUT (CreateOrReplace).

Respostas

Name Tipo Description
200 OK

ResourceTestStatus

A operação de teste foi concluída com êxito.

202 Accepted

A solicitação de teste foi iniciada com êxito.

Other Status Codes

Error

Erro.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Test the connection for an input

Pedido de amostra

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

Resposta da amostra

{
  "status": "TestSucceeded"
}

Definições

Name Description
AuthenticationMode

Modo de autenticação. Os modos válidos são ConnectionString, Msi e 'UserToken'.

AvroSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato Avro.

AzureSqlReferenceInputDataSource

Descreve uma fonte de dados de entrada de referência do Banco de Dados SQL do Azure.

BlobReferenceInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de referência.

BlobStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Compression

Descreve como os dados de entrada são compactados

CompressionType

Indica o tipo de compactação que a entrada usa. Necessário em solicitações PUT (CreateOrReplace).

CsvSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato CSV.

DiagnosticCondition

Condição aplicável ao recurso, ou ao trabalho em geral, que mereça a atenção do cliente.

Diagnostics

Descreve as condições aplicáveis à entrada, saída ou ao trabalho em geral, que merecem atenção do cliente.

Encoding

Especifica a codificação dos dados de entrada no caso de entrada e a codificação de dados de saída no caso de saída.

Error

Representação de erro comum.

ErrorResponse

Descreve o erro que ocorreu.

EventHubStreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

EventHubV2StreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

EventSerializationType

Indica o tipo de serialização que a entrada ou saída usa. Necessário em solicitações PUT (CreateOrReplace).

FileReferenceInputDataSource

Descreve uma fonte de dados de entrada de arquivo que contém dados de referência.

GatewayMessageBusStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Input

Um objeto de entrada, contendo todas as informações associadas à entrada nomeada. Todas as entradas estão contidas em um trabalho de streaming.

IoTHubStreamInputDataSource

Descreve uma fonte de dados de entrada do Hub IoT que contém dados de fluxo.

JsonOutputSerializationFormat

Especifica o formato do JSON no qual a saída será gravada. Os valores atualmente suportados são 'lineSeparated' indicando que a saída será formatada por ter cada objeto JSON separado por uma nova linha e 'array' indicando que a saída será formatada como uma matriz de objetos JSON.

JsonSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato JSON.

ParquetSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato Parquet.

ReferenceInputProperties

As propriedades associadas a uma entrada que contém dados de referência.

RefreshType

Indica o tipo de opção de atualização de dados.

ResourceTestStatus

Descreve o status da operação de teste, juntamente com informações de erro, se aplicável.

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

StreamInputProperties

As propriedades associadas a uma entrada que contém dados de fluxo.

AuthenticationMode

Modo de autenticação. Os modos válidos são ConnectionString, Msi e 'UserToken'.

Valor Description
Msi
UserToken
ConnectionString

AvroSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato Avro.

Name Tipo Description
type string:

Avro

Indica o tipo de serialização que a entrada ou saída usa. Necessário em solicitações PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Descreve uma fonte de dados de entrada de referência do Banco de Dados SQL do Azure.

Name Tipo Description
properties.database

string

Este elemento está associado ao elemento datasource. Este é o nome do banco de dados no qual a saída será gravada.

properties.deltaSnapshotQuery

string

Este elemento está associado ao elemento datasource. Essa consulta é usada para buscar alterações incrementais do banco de dados SQL. Para usar essa opção, recomendamos o uso de tabelas temporais no Banco de Dados SQL do Azure.

properties.fullSnapshotQuery

string

Este elemento está associado ao elemento datasource. Essa consulta é usada para buscar dados do banco de dados sql.

properties.password

string

Este elemento está associado ao elemento datasource. Essa é a senha que será usada para se conectar à instância do Banco de dados SQL.

properties.refreshRate

string

Este elemento está associado ao elemento datasource. Isso indica com que frequência os dados serão buscados no banco de dados. É de formato DateTime.

properties.refreshType

RefreshType

Indica o tipo de opção de atualização de dados.

properties.server

string

Este elemento está associado ao elemento datasource. Este é o nome do servidor que contém o banco de dados no qual será gravado.

properties.table

string

Este elemento está associado ao elemento datasource. O nome da tabela no banco de dados SQL do Azure..

properties.user

string

Este elemento está associado ao elemento datasource. Este é o nome de usuário que será usado para se conectar à instância do Banco de dados SQL.

type string:

Microsoft.Sql/Server/Database

Indica o tipo de fonte de dados de entrada que contém dados de referência. Necessário em solicitações PUT (CreateOrReplace).

BlobReferenceInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de referência.

Name Tipo Default value Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticação.

properties.container

string

O nome de um contêiner dentro da conta de armazenamento associada. Este recipiente contém o(s) blob(s) a serem lidos ou gravados. Necessário em solicitações PUT (CreateOrReplace).

properties.dateFormat

string

O formato de data. Sempre que {date} aparece em pathPattern, o valor dessa propriedade é usado como o formato de data.

properties.pathPattern

string

O padrão de caminho de blob. Não é uma expressão regular. Ele representa um padrão com o qual os nomes de blob serão combinados para determinar se eles devem ou não ser incluídos como entrada ou saída para o trabalho. Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input ou https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obter uma explicação mais detalhada e um exemplo.

properties.storageAccounts

StorageAccount[]

Uma lista de uma ou mais contas de Armazenamento do Azure. Necessário em solicitações PUT (CreateOrReplace).

properties.timeFormat

string

O formato de hora. Sempre que {time} aparece em pathPattern, o valor dessa propriedade é usado como o formato de hora.

type string:

Microsoft.Storage/Blob

Indica o tipo de fonte de dados de entrada que contém dados de referência. Necessário em solicitações PUT (CreateOrReplace).

BlobStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Name Tipo Default value Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticação.

properties.container

string

O nome de um contêiner dentro da conta de armazenamento associada. Este recipiente contém o(s) blob(s) a serem lidos ou gravados. Necessário em solicitações PUT (CreateOrReplace).

properties.dateFormat

string

O formato de data. Sempre que {date} aparece em pathPattern, o valor dessa propriedade é usado como o formato de data.

properties.pathPattern

string

O padrão de caminho de blob. Não é uma expressão regular. Ele representa um padrão com o qual os nomes de blob serão combinados para determinar se eles devem ou não ser incluídos como entrada ou saída para o trabalho. Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input ou https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obter uma explicação mais detalhada e um exemplo.

properties.sourcePartitionCount

integer (int32)

A contagem de partições da fonte de dados de entrada de blob. Gama 1 - 1024.

properties.storageAccounts

StorageAccount[]

Uma lista de uma ou mais contas de Armazenamento do Azure. Necessário em solicitações PUT (CreateOrReplace).

properties.timeFormat

string

O formato de hora. Sempre que {time} aparece em pathPattern, o valor dessa propriedade é usado como o formato de hora.

type string:

Microsoft.Storage/Blob

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

Compression

Descreve como os dados de entrada são compactados

Name Tipo Default value Description
type

CompressionType

None

Indica o tipo de compactação que a entrada usa. Necessário em solicitações PUT (CreateOrReplace).

CompressionType

Indica o tipo de compactação que a entrada usa. Necessário em solicitações PUT (CreateOrReplace).

Valor Description
None
GZip
Deflate

CsvSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato CSV.

Name Tipo Description
properties.encoding

Encoding

Especifica a codificação dos dados de entrada no caso de entrada e a codificação de dados de saída no caso de saída. Necessário em solicitações PUT (CreateOrReplace).

properties.fieldDelimiter

string

Especifica o delimitador que será usado para separar registros CSV (valores separados por vírgula). Consulte https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input ou https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obter uma lista de valores suportados. Necessário em solicitações PUT (CreateOrReplace).

type string:

Csv

Indica o tipo de serialização que a entrada ou saída usa. Necessário em solicitações PUT (CreateOrReplace).

DiagnosticCondition

Condição aplicável ao recurso, ou ao trabalho em geral, que mereça a atenção do cliente.

Name Tipo Description
code

string

O código de diagnóstico opaco.

message

string

A mensagem legível por humanos que descreve a condição em detalhes. Localizado no Accept-Language da solicitação do cliente.

since

string

O carimbo de data/hora UTC de quando a condição começou. Os clientes devem ser capazes de encontrar um evento correspondente no log de operações por volta desse período.

Diagnostics

Descreve as condições aplicáveis à entrada, saída ou ao trabalho em geral, que merecem atenção do cliente.

Name Tipo Description
conditions

DiagnosticCondition[]

Um conjunto de zero ou mais condições aplicáveis ao recurso, ou ao trabalho em geral, que mereçam a atenção do cliente.

Encoding

Especifica a codificação dos dados de entrada no caso de entrada e a codificação de dados de saída no caso de saída.

Valor Description
UTF8

Error

Representação de erro comum.

Name Tipo Description
error

Error

Propriedades de definição de erro.

ErrorResponse

Descreve o erro que ocorreu.

Name Tipo Description
code

string

Código de erro associado ao erro que ocorreu.

message

string

Descreve o erro em detalhes.

EventHubStreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

Name Tipo Default value Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticação.

properties.consumerGroupName

string

O nome de um Grupo de Consumidores do Hub de Eventos que deve ser usado para ler eventos do Hub de Eventos. A especificação de nomes distintos de grupos de consumidores para várias entradas permite que cada uma dessas entradas receba os mesmos eventos do Hub de Eventos. Se não for especificada, a entrada usará o grupo de consumidores padrão do Hub de Eventos.

properties.eventHubName

string

O nome do Hub de Eventos. Necessário em solicitações PUT (CreateOrReplace).

serviceBusNamespace

string

O namespace associado ao Hub de Eventos, Fila do Service Bus, Tópico do Service Bus desejado, etc. Necessário em solicitações PUT (CreateOrReplace).

sharedAccessPolicyKey

string

A chave de política de acesso compartilhado para a política de acesso compartilhado especificada. Necessário em solicitações PUT (CreateOrReplace).

sharedAccessPolicyName

string

O nome da política de acesso compartilhado para o Hub de Eventos, Fila do Service Bus, Tópico do Service Bus, etc. Necessário em solicitações PUT (CreateOrReplace).

type string:

Microsoft.ServiceBus/EventHub

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

EventHubV2StreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

Name Tipo Default value Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de autenticação.

properties.consumerGroupName

string

O nome de um Grupo de Consumidores do Hub de Eventos que deve ser usado para ler eventos do Hub de Eventos. A especificação de nomes distintos de grupos de consumidores para várias entradas permite que cada uma dessas entradas receba os mesmos eventos do Hub de Eventos. Se não for especificada, a entrada usará o grupo de consumidores padrão do Hub de Eventos.

properties.eventHubName

string

O nome do Hub de Eventos. Necessário em solicitações PUT (CreateOrReplace).

serviceBusNamespace

string

O namespace associado ao Hub de Eventos, Fila do Service Bus, Tópico do Service Bus desejado, etc. Necessário em solicitações PUT (CreateOrReplace).

sharedAccessPolicyKey

string

A chave de política de acesso compartilhado para a política de acesso compartilhado especificada. Necessário em solicitações PUT (CreateOrReplace).

sharedAccessPolicyName

string

O nome da política de acesso compartilhado para o Hub de Eventos, Fila do Service Bus, Tópico do Service Bus, etc. Necessário em solicitações PUT (CreateOrReplace).

type string:

Microsoft.EventHub/EventHub

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

EventSerializationType

Indica o tipo de serialização que a entrada ou saída usa. Necessário em solicitações PUT (CreateOrReplace).

Valor Description
Csv
Avro
Json
Parquet

FileReferenceInputDataSource

Descreve uma fonte de dados de entrada de arquivo que contém dados de referência.

Name Tipo Description
properties.path

string

O caminho do arquivo.

type string:

File

Indica o tipo de fonte de dados de entrada que contém dados de referência. Necessário em solicitações PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Name Tipo Description
properties.topic

string

O nome do tópico do Service Bus.

type string:

GatewayMessageBus

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

Input

Um objeto de entrada, contendo todas as informações associadas à entrada nomeada. Todas as entradas estão contidas em um trabalho de streaming.

Name Tipo Description
id

string

ID do recurso

name

string

Nome do recurso

properties InputProperties:

As propriedades associadas a uma entrada. Necessário em solicitações PUT (CreateOrReplace).

type

string

Tipo de recurso

IoTHubStreamInputDataSource

Descreve uma fonte de dados de entrada do Hub IoT que contém dados de fluxo.

Name Tipo Description
properties.consumerGroupName

string

O nome de um Grupo de Consumidores do Hub IoT que deve ser usado para ler eventos do Hub IoT. Se não for especificada, a entrada usará o grupo de consumidores padrão do Hub IoT.

properties.endpoint

string

O ponto de extremidade do Hub IoT ao qual se conectar (ou seja, mensagens/eventos, mensagens/operaçõesMonitoringEvents, etc.).

properties.iotHubNamespace

string

O nome ou o URI do Hub IoT. Necessário em solicitações PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

A chave de política de acesso compartilhado para a política de acesso compartilhado especificada. Necessário em solicitações PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

O nome da política de acesso compartilhado para o Hub IoT. Esta política deve conter pelo menos a permissão de conexão de serviço. Necessário em solicitações PUT (CreateOrReplace).

type string:

Microsoft.Devices/IotHubs

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

JsonOutputSerializationFormat

Especifica o formato do JSON no qual a saída será gravada. Os valores atualmente suportados são 'lineSeparated' indicando que a saída será formatada por ter cada objeto JSON separado por uma nova linha e 'array' indicando que a saída será formatada como uma matriz de objetos JSON.

Valor Description
LineSeparated
Array

JsonSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato JSON.

Name Tipo Description
properties.encoding

Encoding

Especifica a codificação dos dados de entrada no caso de entrada e a codificação de dados de saída no caso de saída. Necessário em solicitações PUT (CreateOrReplace).

properties.format

JsonOutputSerializationFormat

Esta propriedade só se aplica à serialização JSON de saídas somente. Não é aplicável a inputs. Esta propriedade especifica o formato do JSON no qual a saída será gravada. Os valores atualmente suportados são 'lineSeparated' indicando que a saída será formatada por ter cada objeto JSON separado por uma nova linha e 'array' indicando que a saída será formatada como uma matriz de objetos JSON. O valor padrão é 'lineSeparated' se deixado nulo.

type string:

Json

Indica o tipo de serialização que a entrada ou saída usa. Necessário em solicitações PUT (CreateOrReplace).

ParquetSerialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída no formato Parquet.

Name Tipo Description
type string:

Parquet

Indica o tipo de serialização que a entrada ou saída usa. Necessário em solicitações PUT (CreateOrReplace).

ReferenceInputProperties

As propriedades associadas a uma entrada que contém dados de referência.

Name Tipo Description
compression

Compression

Descreve como os dados de entrada são compactados

datasource ReferenceInputDataSource:

Descreve uma fonte de dados de entrada que contém dados de referência. Necessário em solicitações PUT (CreateOrReplace).

diagnostics

Diagnostics

Descreve as condições aplicáveis à entrada, saída ou ao trabalho em geral, que merecem atenção do cliente.

etag

string

A marca de entidade atual para a entrada. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o recurso foi alterado entre solicitações. Você também pode usá-lo nos cabeçalhos If-Match ou If-None-Match para operações de gravação para simultaneidade otimista.

partitionKey

string

partitionKey Descreve uma chave nos dados de entrada que é usada para particionar os dados de entrada

serialization Serialization:

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída. Necessário em solicitações PUT (CreateOrReplace).

type string:

Reference

Indica se a entrada é uma fonte de dados de referência ou de dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

RefreshType

Indica o tipo de opção de atualização de dados.

Valor Description
Static
RefreshPeriodicallyWithFull
RefreshPeriodicallyWithDelta

ResourceTestStatus

Descreve o status da operação de teste, juntamente com informações de erro, se aplicável.

Name Tipo Description
error

ErrorResponse

Descreve o erro que ocorreu.

status

string

O status da operação de teste.

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

Name Tipo Description
accountKey

string

A chave de conta para a conta de Armazenamento do Azure. Necessário em solicitações PUT (CreateOrReplace).

accountName

string

O nome da conta de Armazenamento do Azure. Necessário em solicitações PUT (CreateOrReplace).

StreamInputProperties

As propriedades associadas a uma entrada que contém dados de fluxo.

Name Tipo Description
compression

Compression

Descreve como os dados de entrada são compactados

datasource StreamInputDataSource:

Descreve uma fonte de dados de entrada que contém dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).

diagnostics

Diagnostics

Descreve as condições aplicáveis à entrada, saída ou ao trabalho em geral, que merecem atenção do cliente.

etag

string

A marca de entidade atual para a entrada. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o recurso foi alterado entre solicitações. Você também pode usá-lo nos cabeçalhos If-Match ou If-None-Match para operações de gravação para simultaneidade otimista.

partitionKey

string

partitionKey Descreve uma chave nos dados de entrada que é usada para particionar os dados de entrada

serialization Serialization:

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída. Necessário em solicitações PUT (CreateOrReplace).

type string:

Stream

Indica se a entrada é uma fonte de dados de referência ou de dados de fluxo. Necessário em solicitações PUT (CreateOrReplace).