Inputs - Test
Testa se a origem 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 |
---|---|---|---|---|
input
|
path | True |
string |
O nome da entrada. |
job
|
path | True |
string |
O nome da tarefa de transmissão em fluxo. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. Padrão Regex: |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar 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 pedidos PUT (CreateOrReplace). |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
A operação de teste foi concluída com êxito. |
|
202 Accepted |
O pedido de teste foi iniciado com êxito. |
|
Other Status Codes |
Error. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar 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 |
---|---|
Authentication |
Modo de Autenticação. Os modos válidos são |
Avro |
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato Avro. |
Azure |
Descreve uma origem de dados de entrada de referência de base de dados SQL do Azure. |
Blob |
Descreve uma origem de dados de entrada de blobs que contém dados de referência. |
Blob |
Descreve uma origem de dados de entrada de blobs que contém dados de fluxo. |
Compression |
Descreve como os dados de entrada são comprimidos |
Compression |
Indica o tipo de compressão que a entrada utiliza. Necessário em pedidos PUT (CreateOrReplace). |
Csv |
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato CSV. |
Diagnostic |
Condição aplicável ao recurso, ou ao trabalho geral, que justifica a atenção do cliente. |
Diagnostics |
Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente. |
Encoding |
Especifica a codificação dos dados recebidos no caso da entrada e a codificação de dados de saída no caso da saída. |
Error |
Representação comum de erros. |
Error |
Descreve o erro que ocorreu. |
Event |
Descreve uma origem de dados de entrada do Hub de Eventos que contém dados de fluxo. |
Event |
Descreve uma origem de dados de entrada do Hub de Eventos que contém dados de fluxo. |
Event |
Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace). |
File |
Descreve uma origem de dados de entrada de ficheiro que contém dados de referência. |
Gateway |
Descreve uma origem de dados de entrada de blobs que contém dados de fluxo. |
Input |
Um objeto de entrada que contém todas as informações associadas à entrada nomeada. Todas as entradas estão contidas numa tarefa de transmissão em fluxo. |
Io |
Descreve uma origem de dados de entrada Hub IoT que contém dados de fluxo. |
Json |
Especifica o formato do JSON no qual a saída será escrita. Os valores atualmente suportados são "lineSeparated" que indica que a saída será formatada ao separar cada objeto JSON por uma nova linha e "matriz", que indica que a saída será formatada como uma matriz de objetos JSON. |
Json |
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato JSON. |
Parquet |
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato Parquet. |
Reference |
As propriedades associadas a uma entrada que contém dados de referência. |
Refresh |
Indica o tipo de opção de atualização de dados. |
Resource |
Descreve o estado da operação de teste juntamente com as informações de erro, se aplicável. |
Storage |
As propriedades associadas a uma conta de Armazenamento do Azure |
Stream |
As propriedades associadas a uma entrada que contém dados de fluxo. |
AuthenticationMode
Modo de Autenticação. Os modos válidos são ConnectionString
e Msi
"UserToken".
Name | Tipo | Description |
---|---|---|
ConnectionString |
string |
|
Msi |
string |
|
UserToken |
string |
AvroSerialization
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato Avro.
Name | Tipo | Description |
---|---|---|
type |
string:
Avro |
Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace). |
AzureSqlReferenceInputDataSource
Descreve uma origem de dados de entrada de referência de base de dados SQL do Azure.
Name | Tipo | Description |
---|---|---|
properties.database |
string |
Este elemento está associado ao elemento de origem de dados. Este é o nome da base de dados na qual a saída será escrita. |
properties.deltaSnapshotQuery |
string |
Este elemento está associado ao elemento de origem de dados. Esta consulta é utilizada para obter alterações incrementais da base de dados SQL. Para utilizar esta opção, recomendamos a utilização de tabelas temporais na Base de Dados do SQL do Azure. |
properties.fullSnapshotQuery |
string |
Este elemento está associado ao elemento de origem de dados. Esta consulta é utilizada para obter dados da base de dados sql. |
properties.password |
string |
Este elemento está associado ao elemento de origem de dados. Esta é a palavra-passe que será utilizada para ligar à instância Base de Dados SQL. |
properties.refreshRate |
string |
Este elemento está associado ao elemento de origem de dados. Isto indica a frequência com que os dados serão obtidos a partir da base de dados. É do formato DateTime. |
properties.refreshType |
Indica o tipo de opção de atualização de dados. |
|
properties.server |
string |
Este elemento está associado ao elemento de origem de dados. Este é o nome do servidor que contém a base de dados na qual será escrita. |
properties.table |
string |
Este elemento está associado ao elemento de origem de dados. O nome da tabela na base de dados SQL do Azure.. |
properties.user |
string |
Este elemento está associado ao elemento de origem de dados. Este é o nome de utilizador que será utilizado para ligar à instância Base de Dados SQL. |
type |
string:
Microsoft. |
Indica o tipo de origem de dados de entrada que contém dados de referência. Necessário em pedidos PUT (CreateOrReplace). |
BlobReferenceInputDataSource
Descreve uma origem de dados de entrada de blobs que contém dados de referência.
Name | Tipo | Default value | Description |
---|---|---|---|
properties.authenticationMode | ConnectionString |
Modo de Autenticação. |
|
properties.container |
string |
O nome de um contentor na conta de Armazenamento associada. Este contentor contém os blobs a serem lidos ou escritos. Necessário em pedidos PUT (CreateOrReplace). |
|
properties.dateFormat |
string |
O formato de data. Onde {date} aparecer em pathPattern, o valor desta propriedade é utilizado como o formato de data. |
|
properties.pathPattern |
string |
O padrão do caminho do blob. Não é uma expressão normal. Representa um padrão em relação ao qual os nomes de blobs serão correspondidos para determinar se devem ou não ser incluídos como entrada ou saída para a tarefa. Veja 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 e exemplo mais detalhados. |
|
properties.storageAccounts |
Uma lista de uma ou mais contas de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace). |
||
properties.timeFormat |
string |
O formato de hora. Onde {time} aparecer em pathPattern, o valor desta propriedade é utilizado como o formato de hora. |
|
type |
string:
Microsoft. |
Indica o tipo de origem de dados de entrada que contém dados de referência. Necessário em pedidos PUT (CreateOrReplace). |
BlobStreamInputDataSource
Descreve uma origem de dados de entrada de blobs que contém dados de fluxo.
Name | Tipo | Default value | Description |
---|---|---|---|
properties.authenticationMode | ConnectionString |
Modo de Autenticação. |
|
properties.container |
string |
O nome de um contentor na conta de Armazenamento associada. Este contentor contém os blob(s) a serem lidos ou escritos em. Necessário em pedidos PUT (CreateOrReplace). |
|
properties.dateFormat |
string |
O formato de data. Onde quer que {date} apareça no pathPattern, o valor desta propriedade é utilizado como o formato de data. |
|
properties.pathPattern |
string |
O padrão do caminho do blob. Não é uma expressão normal. Representa um padrão em relação ao qual os nomes de blobs serão correspondidos para determinar se devem ou não ser incluídos como entrada ou saída para a tarefa. Veja 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 e um exemplo mais detalhados. |
|
properties.sourcePartitionCount |
integer |
A contagem de partições da origem de dados de entrada de blobs. Intervalo 1 - 1024. |
|
properties.storageAccounts |
Uma lista de uma ou mais contas de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace). |
||
properties.timeFormat |
string |
O formato de hora. Onde quer que {time} apareça no pathPattern, o valor desta propriedade é utilizado como o formato de hora. |
|
type |
string:
Microsoft. |
Indica o tipo de origem de dados de entrada que contém dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
Compression
Descreve como os dados de entrada são comprimidos
Name | Tipo | Default value | Description |
---|---|---|---|
type | None |
Indica o tipo de compressão que a entrada utiliza. Necessário em pedidos PUT (CreateOrReplace). |
CompressionType
Indica o tipo de compressão que a entrada utiliza. Necessário em pedidos PUT (CreateOrReplace).
Name | Tipo | Description |
---|---|---|
Deflate |
string |
|
GZip |
string |
|
None |
string |
CsvSerialization
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato CSV.
Name | Tipo | Description |
---|---|---|
properties.encoding |
Especifica a codificação dos dados recebidos no caso da entrada e a codificação de dados de saída no caso da saída. Necessário em pedidos PUT (CreateOrReplace). |
|
properties.fieldDelimiter |
string |
Especifica o delimitador que será utilizado para separar registos de valores separados por vírgulas (CSV). Veja 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 pedidos PUT (CreateOrReplace). |
type |
string:
Csv |
Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace). |
DiagnosticCondition
Condição aplicável ao recurso, ou ao trabalho geral, que justifica 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 detalhe. Localizado na Accept-Language do pedido de cliente. |
since |
string |
O carimbo de data/hora UTC de quando a condição começou. Os clientes devem conseguir encontrar um evento correspondente no registo de operações por esta altura. |
Diagnostics
Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente.
Name | Tipo | Description |
---|---|---|
conditions |
Uma coleção de zero ou mais condições aplicáveis ao recurso, ou ao trabalho em geral, que garante a atenção do cliente. |
Encoding
Especifica a codificação dos dados recebidos no caso da entrada e a codificação de dados de saída no caso da saída.
Name | Tipo | Description |
---|---|---|
UTF8 |
string |
Error
Representação comum de erros.
Name | Tipo | Description |
---|---|---|
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 detalhe. |
EventHubStreamInputDataSource
Descreve uma origem de dados de entrada do Hub de Eventos que contém dados de fluxo.
Name | Tipo | Default value | Description |
---|---|---|---|
authenticationMode | ConnectionString |
Modo de Autenticação. |
|
properties.consumerGroupName |
string |
O nome de um Grupo de Consumidores do Hub de Eventos que deve ser utilizado para ler eventos a partir do Hub de Eventos. Especificar nomes de grupos de consumidores distintos para múltiplas entradas permite que cada uma dessas entradas receba os mesmos eventos do Hub de Eventos. Se não for especificado, a entrada utiliza o grupo de consumidores predefinido do Hub de Eventos. |
|
properties.eventHubName |
string |
O nome do Hub de Eventos. Necessário em pedidos PUT (CreateOrReplace). |
|
serviceBusNamespace |
string |
O espaço de nomes associado ao Hub de Eventos pretendido, à Fila do Service Bus, ao Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace). |
|
sharedAccessPolicyKey |
string |
A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace). |
|
sharedAccessPolicyName |
string |
O nome da política de acesso partilhado para o Hub de Eventos, Fila do Service Bus, Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace). |
|
type |
string:
Microsoft. |
Indica o tipo de origem de dados de entrada que contém dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
EventHubV2StreamInputDataSource
Descreve uma origem de dados de entrada do Hub de Eventos que contém dados de fluxo.
Name | Tipo | Default value | Description |
---|---|---|---|
authenticationMode | ConnectionString |
Modo de Autenticação. |
|
properties.consumerGroupName |
string |
O nome de um Grupo de Consumidores do Hub de Eventos que deve ser utilizado para ler eventos a partir do Hub de Eventos. Especificar nomes de grupos de consumidores distintos para múltiplas entradas permite que cada uma dessas entradas receba os mesmos eventos do Hub de Eventos. Se não for especificado, a entrada utiliza o grupo de consumidores predefinido do Hub de Eventos. |
|
properties.eventHubName |
string |
O nome do Hub de Eventos. Necessário em pedidos PUT (CreateOrReplace). |
|
serviceBusNamespace |
string |
O espaço de nomes associado ao Hub de Eventos pretendido, à Fila do Service Bus, ao Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace). |
|
sharedAccessPolicyKey |
string |
A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace). |
|
sharedAccessPolicyName |
string |
O nome da política de acesso partilhado para o Hub de Eventos, Fila do Service Bus, Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace). |
|
type |
string:
Microsoft. |
Indica o tipo de origem de dados de entrada que contém dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
EventSerializationType
Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).
Name | Tipo | Description |
---|---|---|
Avro |
string |
|
Csv |
string |
|
Json |
string |
|
Parquet |
string |
FileReferenceInputDataSource
Descreve uma origem de dados de entrada de ficheiro que contém dados de referência.
Name | Tipo | Description |
---|---|---|
properties.path |
string |
O caminho do ficheiro. |
type |
string:
File |
Indica o tipo de origem de dados de entrada que contém dados de referência. Necessário em pedidos PUT (CreateOrReplace). |
GatewayMessageBusStreamInputDataSource
Descreve uma origem de dados de entrada de blobs que contém dados de fluxo.
Name | Tipo | Description |
---|---|---|
properties.topic |
string |
O nome do tópico do Service Bus. |
type |
string:
Gateway |
Indica o tipo de origem de dados de entrada que contém dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
Input
Um objeto de entrada que contém todas as informações associadas à entrada nomeada. Todas as entradas estão contidas numa tarefa de transmissão em fluxo.
Name | Tipo | Description |
---|---|---|
id |
string |
ID do Recurso |
name |
string |
Nome do recurso |
properties | InputProperties: |
As propriedades associadas a uma entrada. Necessário em pedidos PUT (CreateOrReplace). |
type |
string |
Tipo de recurso |
IoTHubStreamInputDataSource
Descreve uma origem de dados de entrada Hub IoT que contém dados de fluxo.
Name | Tipo | Description |
---|---|---|
properties.consumerGroupName |
string |
O nome de um Hub IoT Grupo de Consumidores que deve ser utilizado para ler eventos do Hub IoT. Se não for especificado, a entrada utiliza o grupo de consumidores predefinido do Hub IoT. |
properties.endpoint |
string |
O ponto final Hub IoT ao qual ligar (ou seja, mensagens/eventos, mensagens/operaçõesMonitorizaçãoEventos, etc.). |
properties.iotHubNamespace |
string |
O nome ou o URI do Hub IoT. Necessário em pedidos PUT (CreateOrReplace). |
properties.sharedAccessPolicyKey |
string |
A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace). |
properties.sharedAccessPolicyName |
string |
O nome da política de acesso partilhado do Hub IoT. Esta política tem de conter, pelo menos, a permissão ligação do Serviço. Necessário em pedidos PUT (CreateOrReplace). |
type |
string:
Microsoft. |
Indica o tipo de origem de dados de entrada que contém dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
JsonOutputSerializationFormat
Especifica o formato do JSON no qual a saída será escrita. Os valores atualmente suportados são "lineSeparated" que indica que a saída será formatada ao separar cada objeto JSON por uma nova linha e "matriz", que indica que a saída será formatada como uma matriz de objetos JSON.
Name | Tipo | Description |
---|---|---|
Array |
string |
|
LineSeparated |
string |
JsonSerialization
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato JSON.
Name | Tipo | Description |
---|---|---|
properties.encoding |
Especifica a codificação dos dados recebidos no caso da entrada e a codificação de dados de saída no caso da saída. Necessário em pedidos PUT (CreateOrReplace). |
|
properties.format |
Esta propriedade aplica-se apenas à serialização JSON de saídas. Não é aplicável a entradas. Esta propriedade especifica o formato do JSON no qual a saída será escrita. Os valores atualmente suportados são "lineSeparated" que indica que a saída será formatada ao separar cada objeto JSON por uma nova linha e "matriz", que indica que a saída será formatada como uma matriz de objetos JSON. O valor predefinido é "lineSeparated" se for deixado nulo. |
|
type |
string:
Json |
Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace). |
ParquetSerialization
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando são escritos numa saída no formato Parquet.
Name | Tipo | Description |
---|---|---|
type |
string:
Parquet |
Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace). |
ReferenceInputProperties
As propriedades associadas a uma entrada que contém dados de referência.
Name | Tipo | Description |
---|---|---|
compression |
Descreve como os dados de entrada são comprimidos |
|
datasource | ReferenceInputDataSource: |
Descreve uma origem de dados de entrada que contém dados de referência. Necessário em pedidos PUT (CreateOrReplace). |
diagnostics |
Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente. |
|
etag |
string |
A etiqueta de entidade atual para a entrada. Esta é uma cadeia opaca. Pode utilizá-lo para detetar se o recurso mudou entre pedidos. Também pode utilizá-lo nos cabeçalhos If-Match ou If-None-Match para operações de escrita para simultaneidade otimista. |
partitionKey |
string |
partitionKey Descreve uma chave nos dados de entrada que é utilizada para criar partições dos dados de entrada |
serialization | Serialization: |
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando escritos numa saída. Necessário em pedidos PUT (CreateOrReplace). |
type |
string:
Reference |
Indica se a entrada é uma origem de dados de referência ou dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
RefreshType
Indica o tipo de opção de atualização de dados.
Name | Tipo | Description |
---|---|---|
RefreshPeriodicallyWithDelta |
string |
|
RefreshPeriodicallyWithFull |
string |
|
Static |
string |
ResourceTestStatus
Descreve o estado da operação de teste juntamente com as informações de erro, se aplicável.
Name | Tipo | Description |
---|---|---|
error |
Descreve o erro que ocorreu. |
|
status |
string |
O estado 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 da conta de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace). |
accountName |
string |
O nome da conta de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace). |
StreamInputProperties
As propriedades associadas a uma entrada que contém dados de fluxo.
Name | Tipo | Description |
---|---|---|
compression |
Descreve como os dados de entrada são comprimidos |
|
datasource | StreamInputDataSource: |
Descreve uma origem de dados de entrada que contém dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |
diagnostics |
Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente. |
|
etag |
string |
A etiqueta de entidade atual para a entrada. Esta é uma cadeia opaca. Pode utilizá-lo para detetar se o recurso mudou entre pedidos. Também pode utilizá-lo nos cabeçalhos If-Match ou If-None-Match para operações de escrita para simultaneidade otimista. |
partitionKey |
string |
partitionKey Descreve uma chave nos dados de entrada que é utilizada para criar partições dos dados de entrada |
serialization | Serialization: |
Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando escritos numa saída. Necessário em pedidos PUT (CreateOrReplace). |
type |
string:
Stream |
Indica se a entrada é uma origem de dados de referência ou dados de fluxo. Necessário em pedidos PUT (CreateOrReplace). |