Outputs - List By Streaming Job

Répertorie toutes les sorties sous le travail de streaming spécifié.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs?api-version=2020-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs?$select={$select}&api-version=2020-03-01

Paramètres URI

Name In Required Type Description
jobName
path True
  • string

Nom du travail de diffusion en continu.

resourceGroupName
path True
  • string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

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

subscriptionId
path True
  • string

ID de l’abonnement cible.

api-version
query True
  • string

Version de l’API à utiliser pour cette opération.

$select
query
  • string

Paramètre de requête OData $select. Il s’agit d’une liste séparée par des virgules des propriétés structurelles à inclure dans la réponse ou « » pour inclure toutes les propriétés. Par défaut, toutes les propriétés sont retournées à l’exception des diagnostics. Actuellement, il accepte uniquement « » comme valeur valide.

Réponses

Name Type Description
200 OK

Liste correctement les sorties sous le travail de diffusion en continu spécifié.

Other Status Codes

Erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation emprunt d’identité de votre compte d’utilisateur

Exemples

List all outputs in a streaming job

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs?api-version=2020-03-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755",
      "name": "output1755",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Sql/Server/Database",
          "properties": {
            "server": "someServer",
            "database": "someDatabase",
            "table": "differentTable",
            "user": "someUser"
          }
        },
        "etag": "f489d6f3-fcd5-4bcb-b642-81e987ee16d6"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output958",
      "name": "output958",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Storage/Table",
          "properties": {
            "accountName": "someAccountName",
            "table": "samples",
            "partitionKey": "differentPartitionKey",
            "rowKey": "rowKey",
            "columnsToRemove": [
              "column1",
              "column2"
            ],
            "batchSize": 25
          }
        },
        "etag": "ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1623",
      "name": "output1623",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Storage/Blob",
          "properties": {
            "storageAccounts": [
              {
                "accountName": "someAccountName"
              }
            ],
            "container": "differentContainer",
            "pathPattern": "{date}/{time}",
            "dateFormat": "yyyy/MM/dd",
            "timeFormat": "HH"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "3a1b2023-79a9-4b33-93e8-f49fc3e573fe"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3022",
      "name": "output3022",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.Storage/DocumentDB",
          "properties": {
            "accountId": "someAccountId",
            "database": "db01",
            "collectionNamePattern": "collection",
            "partitionKey": "differentPartitionKey",
            "documentId": "documentId"
          }
        },
        "etag": "7849c132-e995-4631-91c3-931606eec432"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5195",
      "name": "output5195",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.ServiceBus/EventHub",
          "properties": {
            "eventHubName": "sdkeventhub",
            "partitionKey": "differentPartitionKey",
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8",
            "format": "LineSeparated"
          }
        },
        "etag": "5020de6b-5bb3-4b88-8606-f11fb3c46185"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3456",
      "name": "output3456",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.ServiceBus/Queue",
          "properties": {
            "queueName": "differentQueueName",
            "propertyColumns": [
              "column1",
              "column2"
            ],
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8",
            "format": "LineSeparated"
          }
        },
        "etag": "429adaec-a777-4750-8a39-8d0c931d801c"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output7886",
      "name": "output7886",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.ServiceBus/Topic",
          "properties": {
            "topicName": "differentTopicName",
            "propertyColumns": [
              "column1",
              "column2"
            ],
            "serviceBusNamespace": "sdktest",
            "sharedAccessPolicyName": "RootManageSharedAccessKey"
          }
        },
        "serialization": {
          "type": "Csv",
          "properties": {
            "fieldDelimiter": "|",
            "encoding": "UTF8"
          }
        },
        "etag": "c1c2007f-45b2-419a-ae7d-4d2148998460"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3021",
      "name": "output3021",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "PowerBI",
          "properties": {
            "dataset": "differentDataset",
            "table": "someTable",
            "tokenUserPrincipalName": "bobsmith@contoso.com",
            "tokenUserDisplayName": "Bob Smith",
            "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
            "groupName": "MyPowerBIGroup"
          }
        },
        "etag": "4a492191-9672-4178-be10-043b9dbd4b9f"
      }
    },
    {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5196",
      "name": "output5196",
      "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
      "properties": {
        "datasource": {
          "type": "Microsoft.DataLake/Accounts",
          "properties": {
            "accountName": "differentaccount",
            "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd",
            "tokenUserPrincipalName": "bobsmith@contoso.com",
            "tokenUserDisplayName": "Bob Smith",
            "filePathPrefix": "{date}/{time}",
            "dateFormat": "yyyy/MM/dd",
            "timeFormat": "HH"
          }
        },
        "serialization": {
          "type": "Json",
          "properties": {
            "encoding": "UTF8",
            "format": "LineSeparated"
          }
        },
        "etag": "39ab7642-8c1e-48ed-85eb-949068d68002"
      }
    }
  ]
}

Définitions

AuthenticationMode

Mode d’authentification. Les modes valides sont ConnectionStringet Msi « UserToken ».

AvroSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lors de l’écriture dans une sortie au format Avro.

AzureDataLakeStoreOutputDataSource

Décrit une source de données de sortie Azure Data Lake Store.

AzureFunctionOutputDataSource

Définit les métadonnées d’AzureFunctionOutputDataSource

AzureSqlDatabaseOutputDataSource

Décrit une source de données de sortie de base de données Azure SQL.

AzureSynapseOutputDataSource

Décrit une source de données de sortie Azure Synapse.

AzureTableOutputDataSource

Décrit une source de données de sortie de table Azure.

BlobOutputDataSource

Décrit une source de données de sortie d’objet blob.

CsvSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lorsqu’elles sont écrites dans une sortie au format CSV.

DiagnosticCondition

Condition applicable à la ressource, ou au travail global, qui justifient l’attention du client.

Diagnostics

Décrit les conditions applicables à l’entrée, à la sortie ou à l’ensemble du travail, qui justifient l’attention du client.

DocumentDbOutputDataSource

Décrit une source de données de sortie DocumentDB.

Encoding

Spécifie l’encodage des données entrantes dans le cas d’entrée et l’encodage des données sortantes dans le cas de la sortie.

Error

Représentation d’erreur courante.

EventHubOutputDataSource

Décrit une source de données de sortie Event Hub.

EventHubV2OutputDataSource

Décrit une source de données de sortie Event Hub.

EventSerializationType

Indique le type de sérialisation utilisé par l’entrée ou la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

GatewayMessageBusOutputDataSource

Décrit une source de données de sortie Message Bus de passerelle.

JsonOutputSerializationFormat

Spécifie le format du JSON dans lequel la sortie est écrite. Les valeurs actuellement prises en charge sont « lineSeparated » indiquant que la sortie sera mise en forme en ayant chaque objet JSON séparé par une nouvelle ligne et « array » indiquant que la sortie sera mise en forme comme tableau d’objets JSON.

JsonSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lors de l’écriture dans une sortie au format JSON.

Output

Objet de sortie contenant toutes les informations associées à la sortie nommée. Toutes les sorties sont contenues dans un travail de streaming.

OutputListResult

Objet contenant une liste de sorties sous un travail de streaming.

ParquetSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lors de l’écriture dans une sortie au format Parquet.

PowerBIOutputDataSource

Décrit une source de données de sortie Power BI.

ServiceBusQueueOutputDataSource

Décrit une source de données de sortie de file d’attente Service Bus.

ServiceBusTopicOutputDataSource

Décrit une source de données de sortie de rubrique Service Bus.

StorageAccount

Propriétés associées à un compte de stockage Azure

AuthenticationMode

Mode d’authentification. Les modes valides sont ConnectionStringet Msi « UserToken ».

Name Type Description
ConnectionString
  • string
Msi
  • string
UserToken
  • string

AvroSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lors de l’écriture dans une sortie au format Avro.

Name Type Description
type string:
  • Avro

Indique le type de sérialisation utilisé par l’entrée ou la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

AzureDataLakeStoreOutputDataSource

Décrit une source de données de sortie Azure Data Lake Store.

Name Type Default Value Description
properties.accountName
  • string

Nom du compte Azure Data Lake Store. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.authenticationMode ConnectionString

Mode d’authentification.

properties.dateFormat
  • string

Format de date. Où que {date} apparaisse dans filePathPrefix, la valeur de cette propriété est utilisée comme format de date à la place.

properties.filePathPrefix
  • string

Emplacement du fichier dans lequel la sortie doit être écrite. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.refreshToken
  • string

Jeton d’actualisation qui peut être utilisé pour obtenir un jeton d’accès valide qui peut ensuite être utilisé pour s’authentifier auprès de la source de données. Un jeton d’actualisation valide est actuellement disponible uniquement via le portail Azure. Il est recommandé de placer ici une valeur de chaîne factice lors de la création de la source de données, puis d’aller au portail Azure pour authentifier la source de données qui met à jour cette propriété avec un jeton d’actualisation valide. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.tenantId
  • string

ID de locataire de l’utilisateur utilisé pour obtenir le jeton d’actualisation. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.timeFormat
  • string

Format horaire. Où que {time} apparaisse dans filePathPrefix, la valeur de cette propriété est utilisée comme format d’heure à la place.

properties.tokenUserDisplayName
  • string

Nom d’affichage de l’utilisateur utilisé pour obtenir le jeton d’actualisation. Utilisez cette propriété pour vous aider à mémoriser l’utilisateur utilisé pour obtenir le jeton d’actualisation.

properties.tokenUserPrincipalName
  • string

Nom d’utilisateur principal (UPN) de l’utilisateur utilisé pour obtenir le jeton d’actualisation. Utilisez cette propriété pour vous aider à mémoriser l’utilisateur utilisé pour obtenir le jeton d’actualisation.

type string:
  • Microsoft.DataLake/Accounts

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Définit les métadonnées d’AzureFunctionOutputDataSource

Name Type Description
properties.apiKey
  • string

Si vous souhaitez utiliser une fonction Azure à partir d’un autre abonnement, vous pouvez le faire en fournissant la clé permettant d’accéder à votre fonction.

properties.functionAppName
  • string

Nom de votre application Azure Functions.

properties.functionName
  • string

Nom de la fonction dans votre application Azure Functions.

properties.maxBatchCount
  • number

Propriété qui vous permet de spécifier le nombre maximal d’événements dans chaque lot envoyé à Azure Functions. La valeur par défaut est 100.

properties.maxBatchSize
  • number

Propriété qui peut être utilisée pour définir la taille maximale de chaque lot de sortie qui est envoyé à votre fonction Azure. L’unité d’entrée est exprimée en octets. Par défaut, cette valeur est définie sur 262 144 Ko (256 Ko).

type string:
  • Microsoft.AzureFunction

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

AzureSqlDatabaseOutputDataSource

Décrit une source de données de sortie de base de données Azure SQL.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Mode d’authentification.

properties.database
  • string

Nom de la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.maxBatchCount
  • number

Nombre maximal de lots pour l’écriture dans la base de données Sql, la valeur par défaut est de 10 000. Facultatif sur les demandes PUT.

properties.maxWriterCount
  • number

Nombre maximal d’enregistreurs, actuellement seulement 1(enregistreur unique) et 0(en fonction de la partition de requête) sont disponibles. Facultatif sur les demandes PUT.

properties.password
  • string

Mot de passe utilisé pour se connecter à la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.server
  • string

Nom du serveur SQL contenant la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.table
  • string

Nom de la table dans la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.user
  • string

Nom d’utilisateur qui sera utilisé pour se connecter à la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/Database

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

AzureSynapseOutputDataSource

Décrit une source de données de sortie Azure Synapse.

Name Type Description
properties.database
  • string

Nom de la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.password
  • string

Mot de passe utilisé pour se connecter à la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.server
  • string

Nom du serveur SQL contenant la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.table
  • string

Nom de la table dans la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.user
  • string

Nom d’utilisateur qui sera utilisé pour se connecter à la base de données Azure SQL. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/DataWarehouse

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

AzureTableOutputDataSource

Décrit une source de données de sortie de table Azure.

Name Type Description
properties.accountKey
  • string

Clé de compte pour le compte stockage Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.accountName
  • string

Nom du compte Stockage Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.batchSize
  • integer

Nombre de lignes à écrire dans la table Azure à la fois.

properties.columnsToRemove
  • string[]

En cas de spécification, chaque élément du tableau est le nom d'une colonne à supprimer (le cas échéant) des entités d'événement de sortie.

properties.partitionKey
  • string

Cet élément indique le nom d’une colonne à partir de l’instruction SELECT dans la requête qui sera utilisée comme clé de partition pour la table Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.rowKey
  • string

Cet élément indique le nom d’une colonne à partir de l’instruction SELECT dans la requête qui sera utilisée comme clé de ligne pour la table Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.table
  • string

Nom de la table Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Microsoft.Storage/Table

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

BlobOutputDataSource

Décrit une source de données de sortie d’objet blob.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Mode d’authentification.

properties.blobPathPrefix
  • string

Préfixe du chemin d’accès d’objet blob.

properties.container
  • string

Nom d’un conteneur dans le compte de stockage associé. Ce conteneur contient le ou les objets blob à lire ou à écrire. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.dateFormat
  • string

Format de date. Où que {date} apparaisse dans pathPattern, la valeur de cette propriété est utilisée comme format de date à la place.

properties.pathPattern
  • string

Modèle de chemin d’accès d’objet blob. Pas une expression régulière. Il représente un modèle par rapport auquel les noms d’objets blob seront mis en correspondance pour déterminer s’ils doivent être inclus en tant qu’entrée ou sortie dans le travail. Consultez 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 pour obtenir une explication plus détaillée et un exemple.

properties.storageAccounts

Liste d’un ou plusieurs comptes de stockage Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.timeFormat
  • string

Format horaire. Où que {time} apparaisse dans pathPattern, la valeur de cette propriété est utilisée comme format d’heure à la place.

type string:
  • Microsoft.Storage/Blob

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

CsvSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lorsqu’elles sont écrites dans une sortie au format CSV.

Name Type Description
properties.encoding

Spécifie l’encodage des données entrantes dans le cas d’entrée et l’encodage des données sortantes dans le cas de la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.fieldDelimiter
  • string

Spécifie le délimiteur qui sera utilisé pour séparer les enregistrements CSV (comma-separated value). Consultez 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 pour obtenir la liste des valeurs prises en charge. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Csv

Indique le type de sérialisation utilisé par l’entrée ou la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

DiagnosticCondition

Condition applicable à la ressource, ou au travail global, qui justifient l’attention du client.

Name Type Description
code
  • string

Code de diagnostic opaque.

message
  • string

Message lisible par l’homme décrivant en détail la condition. Localisé dans le Accept-Language de la demande cliente.

since
  • string

Horodatage UTC du démarrage de la condition. Les clients doivent être en mesure de trouver un événement correspondant dans le journal des opérations autour de cette heure.

Diagnostics

Décrit les conditions applicables à l’entrée, à la sortie ou à l’ensemble du travail, qui justifient l’attention du client.

Name Type Description
conditions

Collection de zéro ou plus de conditions applicables à la ressource, ou à l’ensemble du travail, qui justifient l’attention du client.

DocumentDbOutputDataSource

Décrit une source de données de sortie DocumentDB.

Name Type Description
properties.accountId
  • string

Nom ou ID du compte DocumentDB. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.accountKey
  • string

Clé de compte pour le compte DocumentDB. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.collectionNamePattern
  • string

Modèle de nom de collection des collections à utiliser. Le format de nom de collection peut être construit à l’aide du jeton facultatif {partition}, où les partitions commencent à 0. Pour plus d’informations, consultez la section https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output DocumentDB. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.database
  • string

Nom de la base de données DocumentDB. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.documentId
  • string

Nom du champ dans les événements de sortie utilisé pour spécifier la clé primaire sur laquelle sont basées les opérations d’insertion ou de mise à jour.

properties.partitionKey
  • string

Nom du champ dans les événements de sortie utilisé pour spécifier la clé de partitionnement de sortie sur les collections. Si 'collectionNamePattern' contient le jeton {partition}, cette propriété doit être spécifiée.

type string:
  • Microsoft.Storage/DocumentDB

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

Encoding

Spécifie l’encodage des données entrantes dans le cas d’entrée et l’encodage des données sortantes dans le cas de la sortie.

Name Type Description
UTF8
  • string

Error

Représentation d’erreur courante.

Name Type Description
error

Propriétés de définition d’erreur.

EventHubOutputDataSource

Décrit une source de données de sortie Event Hub.

Name Type Default Value Description
authenticationMode ConnectionString

Mode d’authentification.

properties.eventHubName
  • string

Nom du hub d’événements. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.partitionKey
  • string

Clé/colonne utilisée pour déterminer la partition à envoyer des données d’événement.

properties.propertyColumns
  • string[]

Propriétés associées à cette sortie Event Hub.

serviceBusNamespace
  • string

Espace de noms associé au hub d’événements souhaité, à la file d’attente Service Bus, à la rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

Clé de stratégie d’accès partagé pour la stratégie d’accès partagé spécifiée. Obligatoire sur les requêtes PUT (CreateOrReplace).

sharedAccessPolicyName
  • string

Nom de la stratégie d’accès partagé pour Event Hub, File d’attente Service Bus, Rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/EventHub

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

EventHubV2OutputDataSource

Décrit une source de données de sortie Event Hub.

Name Type Default Value Description
authenticationMode ConnectionString

Mode d’authentification.

properties.eventHubName
  • string

Nom du hub d’événements. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.partitionKey
  • string

Clé/colonne utilisée pour déterminer la partition à envoyer des données d’événement.

properties.propertyColumns
  • string[]

Propriétés associées à cette sortie Event Hub.

serviceBusNamespace
  • string

Espace de noms associé au hub d’événements souhaité, à la file d’attente Service Bus, à la rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

Clé de stratégie d’accès partagé pour la stratégie d’accès partagé spécifiée. Obligatoire sur les requêtes PUT (CreateOrReplace).

sharedAccessPolicyName
  • string

Nom de la stratégie d’accès partagé pour Event Hub, File d’attente Service Bus, Rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Microsoft.EventHub/EventHub

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

EventSerializationType

Indique le type de sérialisation utilisé par l’entrée ou la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

Name Type Description
Avro
  • string
Csv
  • string
Json
  • string
Parquet
  • string

GatewayMessageBusOutputDataSource

Décrit une source de données de sortie Message Bus de passerelle.

Name Type Description
properties.topic
  • string

Nom de la rubrique Service Bus.

type string:
  • GatewayMessageBus

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

JsonOutputSerializationFormat

Spécifie le format du JSON dans lequel la sortie est écrite. Les valeurs actuellement prises en charge sont « lineSeparated » indiquant que la sortie sera mise en forme en ayant chaque objet JSON séparé par une nouvelle ligne et « array » indiquant que la sortie sera mise en forme comme tableau d’objets JSON.

Name Type Description
Array
  • string
LineSeparated
  • string

JsonSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lors de l’écriture dans une sortie au format JSON.

Name Type Description
properties.encoding

Spécifie l’encodage des données entrantes dans le cas d’entrée et l’encodage des données sortantes dans le cas de la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.format

Cette propriété s’applique uniquement à la sérialisation JSON des sorties uniquement. Il n’est pas applicable aux entrées. Cette propriété spécifie le format du JSON dans lequel la sortie est écrite. Les valeurs actuellement prises en charge sont « lineSeparated » indiquant que la sortie sera mise en forme en ayant chaque objet JSON séparé par une nouvelle ligne et « array » indiquant que la sortie sera mise en forme comme tableau d’objets JSON. La valeur par défaut est « lineSeparated » si la valeur null est gauche.

type string:
  • Json

Indique le type de sérialisation utilisé par l’entrée ou la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

Output

Objet de sortie contenant toutes les informations associées à la sortie nommée. Toutes les sorties sont contenues dans un travail de streaming.

Name Type Description
id
  • string

ID de ressource

name
  • string

Nom de la ressource

properties.datasource OutputDataSource:

Décrit la source de données dans laquelle la sortie sera écrite. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.diagnostics

Décrit les conditions applicables à l’entrée, à la sortie ou à l’ensemble du travail, qui justifient l’attention du client.

properties.etag
  • string

Balise d’entité actuelle pour la sortie. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si la ressource a changé entre les requêtes. Vous pouvez également l’utiliser dans les en-têtes If-Match ou If-None-Match pour les opérations d’écriture pour l’accès concurrentiel optimiste.

properties.serialization Serialization:

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lorsqu’elles sont écrites dans une sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.sizeWindow
  • number

Fenêtre de taille pour limiter une sortie Stream Analytics à.

properties.timeWindow
  • string

Délai de filtrage des sorties de travail Stream Analytics.

type
  • string

Type de ressource

OutputListResult

Objet contenant une liste de sorties sous un travail de streaming.

Name Type Description
nextLink
  • string

Lien (URL) vers la page suivante des résultats.

value

Liste des sorties sous un travail de diffusion en continu. Renseignée par une opération « Liste ».

ParquetSerialization

Décrit comment les données d’une entrée sont sérialisées ou comment les données sont sérialisées lors de l’écriture dans une sortie au format Parquet.

Name Type Description
type string:
  • Parquet

Indique le type de sérialisation utilisé par l’entrée ou la sortie. Obligatoire sur les requêtes PUT (CreateOrReplace).

PowerBIOutputDataSource

Décrit une source de données de sortie Power BI.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Mode d’authentification.

properties.dataset
  • string

Nom du jeu de données Power BI. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.groupId
  • string

ID du groupe Power BI.

properties.groupName
  • string

Nom du groupe Power BI. Utilisez cette propriété pour vous aider à mémoriser l’ID de groupe Power BI spécifique utilisé.

properties.refreshToken
  • string

Jeton d’actualisation qui peut être utilisé pour obtenir un jeton d’accès valide qui peut ensuite être utilisé pour s’authentifier auprès de la source de données. Un jeton d’actualisation valide est actuellement disponible uniquement via le portail Azure. Il est recommandé de placer ici une valeur de chaîne factice lors de la création de la source de données, puis d’aller au portail Azure pour authentifier la source de données qui met à jour cette propriété avec un jeton d’actualisation valide. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.table
  • string

Nom de la table Power BI sous le jeu de données spécifié. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.tokenUserDisplayName
  • string

Nom d’affichage de l’utilisateur utilisé pour obtenir le jeton d’actualisation. Utilisez cette propriété pour vous aider à mémoriser l’utilisateur utilisé pour obtenir le jeton d’actualisation.

properties.tokenUserPrincipalName
  • string

Nom d’utilisateur principal (UPN) de l’utilisateur utilisé pour obtenir le jeton d’actualisation. Utilisez cette propriété pour vous aider à mémoriser l’utilisateur utilisé pour obtenir le jeton d’actualisation.

type string:
  • PowerBI

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

ServiceBusQueueOutputDataSource

Décrit une source de données de sortie de file d’attente Service Bus.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Mode d’authentification.

properties.propertyColumns
  • string[]

Tableau de chaînes des noms des colonnes de sortie à attacher aux messages Service Bus en tant que propriétés personnalisées.

properties.queueName
  • string

Nom de la file d’attente Service Bus. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.serviceBusNamespace
  • string

Espace de noms associé au hub d’événements souhaité, à la file d’attente Service Bus, à la rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.sharedAccessPolicyKey
  • string

Clé de stratégie d’accès partagé pour la stratégie d’accès partagé spécifiée. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

Nom de la stratégie d’accès partagé pour Event Hub, File d’attente Service Bus, Rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.systemPropertyColumns
  • object

Propriétés système associées à la file d’attente Service Bus. Les propriétés système suivantes sont prises en charge : ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

type string:
  • Microsoft.ServiceBus/Queue

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

ServiceBusTopicOutputDataSource

Décrit une source de données de sortie de rubrique Service Bus.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Mode d’authentification.

properties.propertyColumns
  • string[]

Tableau de chaînes des noms des colonnes de sortie à attacher aux messages Service Bus en tant que propriétés personnalisées.

properties.serviceBusNamespace
  • string

Espace de noms associé au hub d’événements souhaité, à la file d’attente Service Bus, à la rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.sharedAccessPolicyKey
  • string

Clé de stratégie d’accès partagé pour la stratégie d’accès partagé spécifiée. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

Nom de la stratégie d’accès partagé pour Event Hub, File d’attente Service Bus, Rubrique Service Bus, etc. Obligatoire sur les requêtes PUT (CreateOrReplace).

properties.systemPropertyColumns
  • object

Propriétés système associées à la sortie de rubrique Service Bus. Les propriétés système suivantes sont prises en charge : ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

properties.topicName
  • string

Nom de la rubrique Service Bus. Obligatoire sur les requêtes PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/Topic

Indique que le type de sortie de source de données est écrit. Obligatoire sur les requêtes PUT (CreateOrReplace).

StorageAccount

Propriétés associées à un compte de stockage Azure

Name Type Description
accountKey
  • string

Clé de compte pour le compte stockage Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).

accountName
  • string

Nom du compte Stockage Azure. Obligatoire sur les requêtes PUT (CreateOrReplace).