Condividi tramite


Inputs - Test

Verifica se l'origine dati di un input è raggiungibile e utilizzabile dal servizio Analisi di flusso di Azure.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
inputName
path True

string

Nome dell'input.

jobName
path True

string

Nome del processo di streaming.

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
name

string

Nome risorsa

properties InputProperties:

Proprietà associate a un input. Obbligatorio nelle richieste PUT (CreateOrReplace).

Risposte

Nome Tipo Descrizione
200 OK

ResourceTestStatus

Operazione di test completata correttamente.

202 Accepted

La richiesta di test è stata avviata correttamente.

Other Status Codes

Error

Errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Test the connection for an input

Sample Request

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

Sample Response

{
  "status": "TestSucceeded"
}

Definizioni

Nome Descrizione
AuthenticationMode

Modalità di autenticazione. Le modalità valide sono ConnectionString, Msi e 'UserToken'.

AvroSerialization

Descrive come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato Avro.

AzureSqlReferenceInputDataSource

Descrive un'origine dati di riferimento del database Azure SQL.

BlobReferenceInputDataSource

Descrive un'origine dati di input BLOB contenente i dati di riferimento.

BlobStreamInputDataSource

Descrive un'origine dati di input BLOB che contiene dati di flusso.

Compression

Descrive il modo in cui i dati di input vengono compressi

CompressionType

Indica il tipo di compressione usato dall'input. Obbligatorio nelle richieste PUT (CreateOrReplace).

CsvSerialization

Viene descritto come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato CSV.

DiagnosticCondition

Condizione applicabile alla risorsa o al processo complessivo, che garantisce l'attenzione dei clienti.

Diagnostics

Descrive le condizioni applicabili all'input, all'output o al processo in generale, che garantiscono l'attenzione del cliente.

Encoding

Specifica la codifica dei dati in ingresso nel caso di input e la codifica dei dati in uscita nel caso di output.

Error

Rappresentazione di errore comune.

ErrorResponse

Descrive l'errore che si è verificato.

EventHubStreamInputDataSource

Descrive un'origine dati di input dell'hub eventi che contiene dati di flusso.

EventHubV2StreamInputDataSource

Descrive un'origine dati di input dell'hub eventi che contiene dati di flusso.

EventSerializationType

Indica il tipo di serializzazione usato dall'input o dall'output. Obbligatorio nelle richieste PUT (CreateOrReplace).

FileReferenceInputDataSource

Descrive un'origine dati di input file contenente i dati di riferimento.

GatewayMessageBusStreamInputDataSource

Descrive un'origine dati di input BLOB contenente i dati di flusso.

Input

Oggetto di input contenente tutte le informazioni associate all'input denominato. Tutti gli input sono contenuti in un processo di streaming.

IoTHubStreamInputDataSource

Descrive un'origine dati di input hub IoT che contiene dati di flusso.

JsonOutputSerializationFormat

Specifica il formato dell'output JSON in cui verrà scritto. I valori attualmente supportati sono "lineSeparated" che indicano che l'output verrà formattato con ogni oggetto JSON separato da una nuova riga e "array" che indica che l'output verrà formattato come matrice di oggetti JSON.

JsonSerialization

Descrive come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato JSON.

ParquetSerialization

Descrive come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato Parquet.

ReferenceInputProperties

Proprietà associate a un input contenente dati di riferimento.

RefreshType

Indica il tipo di opzione di aggiornamento dei dati.

ResourceTestStatus

Descrive lo stato dell'operazione di test insieme alle informazioni sull'errore, se applicabile.

StorageAccount

Proprietà associate a un account di archiviazione di Azure

StreamInputProperties

Proprietà associate a un input contenente i dati del flusso.

AuthenticationMode

Modalità di autenticazione. Le modalità valide sono ConnectionString, Msi e 'UserToken'.

Nome Tipo Descrizione
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

Descrive come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato Avro.

Nome Tipo Descrizione
type string:

Avro

Indica il tipo di serializzazione usato dall'input o dall'output. Obbligatorio nelle richieste PUT (CreateOrReplace).

AzureSqlReferenceInputDataSource

Descrive un'origine dati di riferimento del database Azure SQL.

Nome Tipo Descrizione
properties.database

string

Questo elemento viene associato all'elemento datasource. Nome del database in cui verrà scritto l'output.

properties.deltaSnapshotQuery

string

Questo elemento viene associato all'elemento datasource. Questa query viene usata per recuperare le modifiche incrementali dal database SQL. Per usare questa opzione, è consigliabile usare tabelle temporali in Azure SQL Database.

properties.fullSnapshotQuery

string

Questo elemento viene associato all'elemento datasource. Questa query viene usata per recuperare i dati dal database SQL.

properties.password

string

Questo elemento viene associato all'elemento datasource. Password che verrà usata per connettersi all'istanza di database SQL.

properties.refreshRate

string

Questo elemento viene associato all'elemento datasource. Ciò indica la frequenza di recupero dei dati dal database. È di formato DateTime.

properties.refreshType

RefreshType

Indica il tipo di opzione di aggiornamento dei dati.

properties.server

string

Questo elemento viene associato all'elemento datasource. Nome del server che contiene il database in cui verranno scritti i dati.

properties.table

string

Questo elemento viene associato all'elemento datasource. Nome della tabella nel database Azure SQL.

properties.user

string

Questo elemento viene associato all'elemento datasource. Nome utente che verrà usato per connettersi all'istanza di database SQL.

type string:

Microsoft.Sql/Server/Database

Indica il tipo di origine dati di input contenente i dati di riferimento. Obbligatorio nelle richieste PUT (CreateOrReplace).

BlobReferenceInputDataSource

Descrive un'origine dati di input BLOB contenente i dati di riferimento.

Nome Tipo Valore predefinito Descrizione
properties.authenticationMode

AuthenticationMode

ConnectionString

Modalità di autenticazione.

properties.container

string

Nome di un contenitore all'interno dell'account di archiviazione associato. Questo contenitore contiene i BLOB da leggere o scrivere in. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.dateFormat

string

Formato della data. Ovunque {date} venga visualizzato in pathPattern, il valore di questa proprietà viene usato come formato data.

properties.pathPattern

string

Modello di percorso BLOB. Non un'espressione regolare. Rappresenta un modello rispetto al quale i nomi BLOB verranno corrispondenti per determinare se devono essere inclusi come input o output al processo. Vedere 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 per una spiegazione più dettagliata ed esempio.

properties.storageAccounts

StorageAccount[]

Elenco di uno o più account di archiviazione di Azure. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.timeFormat

string

Formato ora. Ovunque {time} venga visualizzato in pathPattern, il valore di questa proprietà viene usato come formato ora.

type string:

Microsoft.Storage/Blob

Indica il tipo di origine dati di input contenente i dati di riferimento. Obbligatorio nelle richieste PUT (CreateOrReplace).

BlobStreamInputDataSource

Descrive un'origine dati di input BLOB che contiene dati di flusso.

Nome Tipo Valore predefinito Descrizione
properties.authenticationMode

AuthenticationMode

ConnectionString

Modalità di autenticazione.

properties.container

string

Nome di un contenitore all'interno dell'account di archiviazione associato. Questo contenitore contiene i BLOB da cui leggere o scrivere. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.dateFormat

string

Formato della data. Ovunque venga visualizzato {date} in pathPattern, il valore di questa proprietà viene usato invece come formato data.

properties.pathPattern

string

Modello di percorso DEL BLOB. Non un'espressione regolare. Rappresenta un modello in base al quale i nomi dei BLOB verranno confrontati per determinare se devono essere inclusi o meno come input o output nel processo. Vedere 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 per una spiegazione più dettagliata ed esempio.

properties.sourcePartitionCount

integer

Numero di partizioni dell'origine dati di input DEL BLOB. Intervallo da 1 a 1024.

properties.storageAccounts

StorageAccount[]

Elenco di uno o più account di archiviazione di Azure. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.timeFormat

string

Formato dell'ora. Ovunque venga visualizzato {time} in pathPattern, il valore di questa proprietà viene usato come formato ora.

type string:

Microsoft.Storage/Blob

Indica il tipo di origine dati di input contenente i dati del flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

Compression

Descrive il modo in cui i dati di input vengono compressi

Nome Tipo Valore predefinito Descrizione
type

CompressionType

None

Indica il tipo di compressione utilizzato dall'input. Obbligatorio nelle richieste PUT (CreateOrReplace).

CompressionType

Indica il tipo di compressione usato dall'input. Obbligatorio nelle richieste PUT (CreateOrReplace).

Nome Tipo Descrizione
Deflate

string

GZip

string

None

string

CsvSerialization

Viene descritto come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato CSV.

Nome Tipo Descrizione
properties.encoding

Encoding

Specifica la codifica dei dati in ingresso nel caso di input e la codifica dei dati in uscita nel caso di output. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.fieldDelimiter

string

Specifica il delimitatore che verrà usato per separare i record con valori delimitati da virgole (CSV). Vedere 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 per un elenco di valori supportati. Obbligatorio nelle richieste PUT (CreateOrReplace).

type string:

Csv

Indica il tipo di serializzazione usato dall'input o dall'output. Obbligatorio nelle richieste PUT (CreateOrReplace).

DiagnosticCondition

Condizione applicabile alla risorsa o al processo complessivo, che garantisce l'attenzione dei clienti.

Nome Tipo Descrizione
code

string

Codice diagnostico opaco.

message

string

Messaggio leggibile che descrive in dettaglio la condizione. Localizzato nella Accept-Language della richiesta client.

since

string

Timestamp UTC di all'avvio della condizione. I clienti devono essere in grado di trovare un evento corrispondente nel log operazioni di questo periodo.

Diagnostics

Descrive le condizioni applicabili all'input, all'output o al processo in generale, che garantiscono l'attenzione del cliente.

Nome Tipo Descrizione
conditions

DiagnosticCondition[]

Una raccolta di zero o più condizioni applicabili alla risorsa o al processo in generale, che garantiscono l'attenzione del cliente.

Encoding

Specifica la codifica dei dati in ingresso nel caso di input e la codifica dei dati in uscita nel caso di output.

Nome Tipo Descrizione
UTF8

string

Error

Rappresentazione di errore comune.

Nome Tipo Descrizione
error

Error

Proprietà di definizione degli errori.

ErrorResponse

Descrive l'errore che si è verificato.

Nome Tipo Descrizione
code

string

Codice di errore associato all'errore che si è verificato.

message

string

Descrive in dettaglio l'errore.

EventHubStreamInputDataSource

Descrive un'origine dati di input dell'hub eventi che contiene dati di flusso.

Nome Tipo Valore predefinito Descrizione
authenticationMode

AuthenticationMode

ConnectionString

Modalità di autenticazione.

properties.consumerGroupName

string

Nome di un gruppo di consumer dell'hub eventi da usare per leggere gli eventi dall'hub eventi. Se si specificano nomi di gruppi di consumer distinti per più input, ognuno di questi input può ricevere gli stessi eventi dall'hub eventi. Se non specificato, l'input usa il gruppo di consumer predefinito dell'hub eventi.

properties.eventHubName

string

Nome dell'hub eventi. Obbligatorio nelle richieste PUT (CreateOrReplace).

serviceBusNamespace

string

Spazio dei nomi associato all'hub eventi desiderato, alla coda del bus di servizio, all'argomento del bus di servizio e così via. Obbligatorio nelle richieste PUT (CreateOrReplace).

sharedAccessPolicyKey

string

Chiave dei criteri di accesso condiviso per i criteri di accesso condiviso specificati. Obbligatorio nelle richieste PUT (CreateOrReplace).

sharedAccessPolicyName

string

Nome dei criteri di accesso condiviso per l'hub eventi, la coda del bus di servizio, l'argomento del bus di servizio e così via. Obbligatorio nelle richieste PUT (CreateOrReplace).

type string:

Microsoft.ServiceBus/EventHub

Indica il tipo di origine dati di input contenente i dati del flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

EventHubV2StreamInputDataSource

Descrive un'origine dati di input dell'hub eventi che contiene dati di flusso.

Nome Tipo Valore predefinito Descrizione
authenticationMode

AuthenticationMode

ConnectionString

Modalità di autenticazione.

properties.consumerGroupName

string

Nome di un gruppo di consumer dell'hub eventi da usare per leggere gli eventi dall'hub eventi. Se si specificano nomi di gruppi di consumer distinti per più input, ognuno di questi input può ricevere gli stessi eventi dall'hub eventi. Se non specificato, l'input usa il gruppo di consumer predefinito dell'hub eventi.

properties.eventHubName

string

Nome dell'hub eventi. Obbligatorio nelle richieste PUT (CreateOrReplace).

serviceBusNamespace

string

Spazio dei nomi associato all'hub eventi desiderato, alla coda del bus di servizio, all'argomento del bus di servizio e così via. Obbligatorio nelle richieste PUT (CreateOrReplace).

sharedAccessPolicyKey

string

Chiave dei criteri di accesso condiviso per i criteri di accesso condiviso specificati. Obbligatorio nelle richieste PUT (CreateOrReplace).

sharedAccessPolicyName

string

Nome dei criteri di accesso condiviso per l'hub eventi, la coda del bus di servizio, l'argomento del bus di servizio e così via. Obbligatorio nelle richieste PUT (CreateOrReplace).

type string:

Microsoft.EventHub/EventHub

Indica il tipo di origine dati di input contenente i dati del flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

EventSerializationType

Indica il tipo di serializzazione usato dall'input o dall'output. Obbligatorio nelle richieste PUT (CreateOrReplace).

Nome Tipo Descrizione
Avro

string

Csv

string

Json

string

Parquet

string

FileReferenceInputDataSource

Descrive un'origine dati di input file contenente i dati di riferimento.

Nome Tipo Descrizione
properties.path

string

Percorso del file.

type string:

File

Indica il tipo di origine dati di input contenente i dati di riferimento. Obbligatorio nelle richieste PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Descrive un'origine dati di input BLOB contenente i dati di flusso.

Nome Tipo Descrizione
properties.topic

string

Nome dell'argomento del bus di servizio.

type string:

GatewayMessageBus

Indica il tipo di origine dati di input contenente i dati di flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

Input

Oggetto di input contenente tutte le informazioni associate all'input denominato. Tutti gli input sono contenuti in un processo di streaming.

Nome Tipo Descrizione
id

string

ID risorsa

name

string

Nome risorsa

properties InputProperties:

Proprietà associate a un input. Obbligatorio nelle richieste PUT (CreateOrReplace).

type

string

Tipo di risorsa

IoTHubStreamInputDataSource

Descrive un'origine dati di input hub IoT che contiene dati di flusso.

Nome Tipo Descrizione
properties.consumerGroupName

string

Nome di un gruppo di consumer di hub IoT che deve essere usato per leggere gli eventi dall'hub IoT. Se non specificato, l'input usa il gruppo consumer predefinito di Iot Hub.

properties.endpoint

string

Endpoint hub IoT da connettersi (ad esempio messaggi/eventi, messaggi/operazioniMonitoringEvents e così via).

properties.iotHubNamespace

string

Nome o URI del hub IoT. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

Chiave dei criteri di accesso condiviso per i criteri di accesso condiviso specificati. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

Nome dei criteri di accesso condiviso per il hub IoT. Questo criterio deve contenere almeno l'autorizzazione Di connessione del servizio. Obbligatorio nelle richieste PUT (CreateOrReplace).

type string:

Microsoft.Devices/IotHubs

Indica il tipo di origine dati di input contenente i dati di flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

JsonOutputSerializationFormat

Specifica il formato dell'output JSON in cui verrà scritto. I valori attualmente supportati sono "lineSeparated" che indicano che l'output verrà formattato con ogni oggetto JSON separato da una nuova riga e "array" che indica che l'output verrà formattato come matrice di oggetti JSON.

Nome Tipo Descrizione
Array

string

LineSeparated

string

JsonSerialization

Descrive come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato JSON.

Nome Tipo Descrizione
properties.encoding

Encoding

Specifica la codifica dei dati in ingresso nel caso di input e la codifica dei dati in uscita nel caso di output. Obbligatorio nelle richieste PUT (CreateOrReplace).

properties.format

JsonOutputSerializationFormat

Questa proprietà si applica solo alla serializzazione JSON degli output. Non è applicabile agli input. Questa proprietà specifica il formato dell'output JSON in cui verrà scritto. I valori attualmente supportati sono "lineSeparated" che indicano che l'output verrà formattato con ogni oggetto JSON separato da una nuova riga e "array" che indica che l'output verrà formattato come matrice di oggetti JSON. Il valore predefinito è 'lineSeparated' se è stato lasciato null.

type string:

Json

Indica il tipo di serializzazione usato dall'input o dall'output. Obbligatorio nelle richieste PUT (CreateOrReplace).

ParquetSerialization

Descrive come i dati di un input vengono serializzati o la serializzazione dei dati quando vengono scritti in un output in formato Parquet.

Nome Tipo Descrizione
type string:

Parquet

Indica il tipo di serializzazione usato dall'input o dall'output. Obbligatorio nelle richieste PUT (CreateOrReplace).

ReferenceInputProperties

Proprietà associate a un input contenente dati di riferimento.

Nome Tipo Descrizione
compression

Compression

Descrive il modo in cui i dati di input vengono compressi

datasource ReferenceInputDataSource:

Descrive un'origine dati di input che contiene dati di riferimento. Obbligatorio nelle richieste PUT (CreateOrReplace).

diagnostics

Diagnostics

Descrive le condizioni applicabili all'input, all'output o al processo in generale, che garantiscono l'attenzione del cliente.

etag

string

Tag di entità corrente per l'input. Si tratta di una stringa opaca. È possibile usarlo per rilevare se la risorsa è cambiata tra le richieste. È anche possibile usarlo nelle intestazioni If-Match o If-None-Match per le operazioni di scrittura per la concorrenza ottimistica.

partitionKey

string

partitionKey Descrive una chiave nei dati di input usati per partizionare i dati di input

serialization Serialization:

Viene descritto come serializzare i dati di un input o come serializzare i dati quando vengono scritti in un output. Obbligatorio nelle richieste PUT (CreateOrReplace).

type string:

Reference

Indica se l'input è un'origine di dati di riferimento o di flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

RefreshType

Indica il tipo di opzione di aggiornamento dei dati.

Nome Tipo Descrizione
RefreshPeriodicallyWithDelta

string

RefreshPeriodicallyWithFull

string

Static

string

ResourceTestStatus

Descrive lo stato dell'operazione di test insieme alle informazioni sull'errore, se applicabile.

Nome Tipo Descrizione
error

ErrorResponse

Descrive l'errore che si è verificato.

status

string

Stato dell'operazione di test.

StorageAccount

Proprietà associate a un account di archiviazione di Azure

Nome Tipo Descrizione
accountKey

string

Chiave dell'account per l'account di archiviazione di Azure. Obbligatorio nelle richieste PUT (CreateOrReplace).

accountName

string

il nome dell'account di archiviazione di Azure. Obbligatorio nelle richieste PUT (CreateOrReplace).

StreamInputProperties

Proprietà associate a un input contenente i dati del flusso.

Nome Tipo Descrizione
compression

Compression

Descrive il modo in cui i dati di input vengono compressi

datasource StreamInputDataSource:

Descrive un'origine dati di input che contiene dati di flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).

diagnostics

Diagnostics

Descrive le condizioni applicabili all'input, all'output o al processo in generale, che garantiscono l'attenzione del cliente.

etag

string

Tag di entità corrente per l'input. Si tratta di una stringa opaca. È possibile usarlo per rilevare se la risorsa è cambiata tra le richieste. È anche possibile usarlo nelle intestazioni If-Match o If-None-Match per le operazioni di scrittura per la concorrenza ottimistica.

partitionKey

string

partitionKey Descrive una chiave nei dati di input usati per partizionare i dati di input

serialization Serialization:

Viene descritto come serializzare i dati di un input o come serializzare i dati quando vengono scritti in un output. Obbligatorio nelle richieste PUT (CreateOrReplace).

type string:

Stream

Indica se l'input è un'origine di dati di riferimento o di flusso. Obbligatorio nelle richieste PUT (CreateOrReplace).