Outputs - List By Streaming Job

Lista todas as saídas no trabalho de streaming especificado.

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

Parâmetros de URI

Name In Required Type Description
jobName
path True
  • string

O nome do trabalho de streaming.

resourceGroupName
path True
  • string

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

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

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

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

$select
query
  • string

O parâmetro de consulta OData $select. Esta é uma lista separada por vírgulas de propriedades estruturais a serem incluídas na resposta ou "" para incluir todas as propriedades. Por padrão, todas as propriedades são retornadas, exceto o diagnóstico. Atualmente, aceita apenas '' como um valor válido.

Respostas

Name Type Description
200 OK

Listou com êxito as saídas no trabalho de streaming especificado.

Other Status Codes

Erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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"
      }
    }
  ]
}

Definições

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.

AzureDataLakeStoreOutputDataSource

Descreve uma fonte de dados de saída do Azure Data Lake Store.

AzureFunctionOutputDataSource

Define os metadados do AzureFunctionOutputDataSource

AzureSqlDatabaseOutputDataSource

Descreve uma fonte de dados de saída de banco de dados SQL do Azure.

AzureSynapseOutputDataSource

Descreve uma fonte de dados de saída Azure Synapse.

AzureTableOutputDataSource

Descreve uma fonte de dados de saída da Tabela do Azure.

BlobOutputDataSource

Descreve uma fonte de dados de saída de blob.

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 garante a atenção do cliente.

Diagnostics

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

DocumentDbOutputDataSource

Descreve uma fonte de dados de saída do DocumentDB.

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.

EventHubOutputDataSource

Descreve uma fonte de dados de saída do Hub de Eventos.

EventHubV2OutputDataSource

Descreve uma fonte de dados de saída do Hub de Eventos.

EventSerializationType

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

GatewayMessageBusOutputDataSource

Descreve uma fonte de dados de saída do Barramento de Mensagens do Gateway.

JsonOutputSerializationFormat

Especifica o formato do JSON no qual a saída será gravada. Os valores com suporte no momento são 'lineSeparated' indicando que a saída será formatada por meio de 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.

Output

Um objeto de saída que contém todas as informações associadas à saída nomeada. Todas as saídas estão contidas em um trabalho de streaming.

OutputListResult

Objeto que contém uma lista de saídas em um trabalho de streaming.

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.

PowerBIOutputDataSource

Descreve uma fonte de dados de saída do Power BI.

ServiceBusQueueOutputDataSource

Descreve uma fonte de dados de saída da Fila do Barramento de Serviço.

ServiceBusTopicOutputDataSource

Descreve uma fonte de dados de saída do Tópico do Barramento de Serviço.

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

AuthenticationMode

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

Name Type 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 gravados em uma saída no formato Avro.

Name Type Description
type string:
  • Avro

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

AzureDataLakeStoreOutputDataSource

Descreve uma fonte de dados de saída do Azure Data Lake Store.

Name Type Default Value Description
properties.accountName
  • string

O nome da conta do Azure Data Lake Store. Obrigatório em solicitações PUT (CreateOrReplace).

properties.authenticationMode ConnectionString

Modo de autenticação.

properties.dateFormat
  • string

O formato de data. Onde quer que {date} apareça no filePathPrefix, o valor dessa propriedade é usado como o formato de data.

properties.filePathPrefix
  • string

O local do arquivo no qual a saída deve ser gravada. Obrigatório em solicitações PUT (CreateOrReplace).

properties.refreshToken
  • string

Um token de atualização que pode ser usado para obter um token de acesso válido que pode ser usado para autenticar com a fonte de dados. No momento, um token de atualização válido só pode ser obtido por meio do Portal do Azure. É recomendável colocar um valor de cadeia de caracteres fictício aqui ao criar a fonte de dados e, em seguida, ir ao Portal do Azure para autenticar a fonte de dados que atualizará essa propriedade com um token de atualização válido. Obrigatório em solicitações PUT (CreateOrReplace).

properties.tenantId
  • string

A ID de locatário do usuário usada para obter o token de atualização. Obrigatório em solicitações PUT (CreateOrReplace).

properties.timeFormat
  • string

O formato de hora. Onde quer que {time} apareça no filePathPrefix, o valor dessa propriedade é usado como o formato de hora.

properties.tokenUserDisplayName
  • string

O nome de exibição do usuário que foi usado para obter o token de atualização. Use essa propriedade para ajudar a lembrar qual usuário foi usado para obter o token de atualização.

properties.tokenUserPrincipalName
  • string

O UPN (nome de entidade de usuário) do usuário que foi usado para obter o token de atualização. Use essa propriedade para ajudar a lembrar qual usuário foi usado para obter o token de atualização.

type string:
  • Microsoft.DataLake/Accounts

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Define os metadados do AzureFunctionOutputDataSource

Name Type Description
properties.apiKey
  • string

Se você quiser usar um Azure Function de outra assinatura, você pode fazer isso fornecendo a chave para acessar sua função.

properties.functionAppName
  • string

O nome de seu aplicativo do Azure Functions.

properties.functionName
  • string

O nome da função em seu aplicativo do Azure Functions.

properties.maxBatchCount
  • number

Uma propriedade que permite que você especifique o número máximo de eventos em cada que é enviado ao Azure Functions. O valor padrão é 100.

properties.maxBatchSize
  • number

Uma propriedade que permite que você defina o tamanho máximo de cada lote de saída que é enviado para seu Azure Functions. A unidade de entrada é em bytes. Por padrão, esse valor é 262,144 bytes (256 KB).

type string:
  • Microsoft.AzureFunction

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

AzureSqlDatabaseOutputDataSource

Descreve uma fonte de dados de saída de banco de dados SQL do Azure.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de Autenticação.

properties.database
  • string

O nome do banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.maxBatchCount
  • number

Contagem máxima do Lote para gravação no banco de dados Sql, o valor padrão é 10.000. Opcional em solicitações PUT.

properties.maxWriterCount
  • number

No momento, somente 1(gravador único) e 0(com base na partição de consulta) estão disponíveis. Opcional em solicitações PUT.

properties.password
  • string

A senha que será usada para se conectar ao banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.server
  • string

O nome do SQL Server que contém o banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.table
  • string

O nome da tabela no banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.user
  • string

O nome de usuário que será usado para se conectar ao banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/Database

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

AzureSynapseOutputDataSource

Descreve uma fonte de dados de saída Azure Synapse.

Name Type Description
properties.database
  • string

O nome do banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.password
  • string

A senha que será usada para se conectar ao banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.server
  • string

O nome do SQL Server que contém o banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.table
  • string

O nome da tabela no banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.user
  • string

O nome de usuário que será usado para se conectar ao banco de dados SQL do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/DataWarehouse

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

AzureTableOutputDataSource

Descreve uma fonte de dados de saída da Tabela do Azure.

Name Type Description
properties.accountKey
  • string

A chave de conta da conta de Armazenamento do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.accountName
  • string

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

properties.batchSize
  • integer

O número de linhas a serem gravadas na Tabela do Azure por vez.

properties.columnsToRemove
  • string[]

Se especificado, cada item da matriz é o nome de uma coluna a ser removida (se houver) a partir das entidades do evento de saída.

properties.partitionKey
  • string

Esse elemento indica o nome de uma coluna da instrução SELECT na consulta que será usada como a chave de partição para a Tabela do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.rowKey
  • string

Esse elemento indica o nome de uma coluna da instrução SELECT na consulta que será usada como a chave de linha da Tabela do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

properties.table
  • string

O nome da Tabela do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

type string:
  • Microsoft.Storage/Table

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

BlobOutputDataSource

Descreve uma fonte de dados de saída de blob.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de Autenticação.

properties.blobPathPrefix
  • string

Prefixo de caminho de blob.

properties.container
  • string

O nome de um contêiner dentro da conta de Armazenamento associada. Esse contêiner contém os blobs a serem lidos ou gravados. Obrigatório em solicitações PUT (CreateOrReplace).

properties.dateFormat
  • string

O formato de data. Onde quer que {date} apareça no 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 em relação ao qual os nomes de blob serão correspondidos para determinar se eles devem ou não ser incluídos como entrada ou saída para o trabalho. 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.storageAccounts

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

properties.timeFormat
  • string

O formato de hora. Onde quer que {time} apareça no pathPattern, o valor dessa propriedade é usado como o formato de hora.

type string:
  • Microsoft.Storage/Blob

Indica que o tipo de saída da fonte de dados será gravado. Obrigató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.

Name Type Description
properties.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. Obrigatório em solicitações PUT (CreateOrReplace).

properties.fieldDelimiter
  • string

Especifica o delimitador que será usado para separar registros CSV (valor separado 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 com suporte. Obrigatório em solicitações PUT (CreateOrReplace).

type string:
  • Csv

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

DiagnosticCondition

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

Name Type Description
code
  • string

O código de diagnóstico opaco.

message
  • string

A mensagem legível 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 foi iniciada. Os clientes devem ser capazes de encontrar um evento correspondente no log de operações por volta desta hora.

Diagnostics

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

Name Type Description
conditions

Uma coleção de zero ou mais condições aplicáveis ao recurso ou ao trabalho em geral que garantem a atenção do cliente.

DocumentDbOutputDataSource

Descreve uma fonte de dados de saída do DocumentDB.

Name Type Description
properties.accountId
  • string

O nome ou a ID da conta do DocumentDB. Obrigatório em solicitações PUT (CreateOrReplace).

properties.accountKey
  • string

A chave da conta do DocumentDB. Obrigatório em solicitações PUT (CreateOrReplace).

properties.collectionNamePattern
  • string

O padrão de nome da coleção para as coleções a ser usado. O formato de nome da coleção pode ser construído com o token {partição} opcional, em que as partições começam em 0. Consulte a seção DocumentDB para https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output obter mais informações. Obrigatório em solicitações PUT (CreateOrReplace).

properties.database
  • string

O nome do banco de dados DocumentDB. Obrigatório em solicitações PUT (CreateOrReplace).

properties.documentId
  • string

O nome do campo em eventos de saída usado para especificar a chave primária na qual se baseiam as operações de inserção ou atualização.

properties.partitionKey
  • string

O nome do campo nos eventos de saída usado para especificar a chave para o particionamento de saída em várias coleções. Se 'collectionNamePattern' contiver o token {partition}, essa propriedade será necessária para ser especificada.

type string:
  • Microsoft.Storage/DocumentDB

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

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.

Name Type Description
UTF8
  • string

Error

Representação de erro comum.

Name Type Description
error

Propriedades de definição de erro.

EventHubOutputDataSource

Descreve uma fonte de dados de saída do Hub de Eventos.

Name Type Default Value Description
authenticationMode ConnectionString

Modo de Autenticação.

properties.eventHubName
  • string

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

properties.partitionKey
  • string

A chave/coluna usada para determinar para qual partição enviar dados de evento.

properties.propertyColumns
  • string[]

As propriedades associadas a essa saída do Hub de Eventos.

serviceBusNamespace
  • string

O namespace associado ao Hub de Eventos desejado, fila do Barramento de Serviço, Tópico do Barramento de Serviço etc. Obrigatório em solicitações PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

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

sharedAccessPolicyName
  • string

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

type string:
  • Microsoft.ServiceBus/EventHub

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

EventHubV2OutputDataSource

Descreve uma fonte de dados de saída do Hub de Eventos.

Name Type Default Value Description
authenticationMode ConnectionString

Modo de Autenticação.

properties.eventHubName
  • string

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

properties.partitionKey
  • string

A chave/coluna usada para determinar para qual partição enviar dados de evento.

properties.propertyColumns
  • string[]

As propriedades associadas a essa saída do Hub de Eventos.

serviceBusNamespace
  • string

O namespace associado ao Hub de Eventos desejado, fila do Barramento de Serviço, Tópico do Barramento de Serviço etc. Obrigatório em solicitações PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

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

sharedAccessPolicyName
  • string

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

type string:
  • Microsoft.EventHub/EventHub

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

EventSerializationType

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

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

GatewayMessageBusOutputDataSource

Descreve uma fonte de dados de saída do Barramento de Mensagens do Gateway.

Name Type Description
properties.topic
  • string

O nome do tópico do Barramento de Serviço.

type string:
  • GatewayMessageBus

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

JsonOutputSerializationFormat

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

Name Type Description
Array
  • string
LineSeparated
  • string

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 Type Description
properties.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. Obrigatório em solicitações PUT (CreateOrReplace).

properties.format

Essa propriedade só se aplica à serialização JSON de saídas. Não é aplicável a entradas. Essa propriedade especifica o formato do JSON no qual a saída será gravada. Os valores com suporte no momento são 'lineSeparated' indicando que a saída será formatada por meio de 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 será 'lineSeparated' se for nulo à esquerda.

type string:
  • Json

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

Output

Um objeto de saída que contém todas as informações associadas à saída nomeada. Todas as saídas estão contidas em um trabalho de streaming.

Name Type Description
id
  • string

ID do recurso

name
  • string

Nome do recurso

properties.datasource OutputDataSource:

Descreve a fonte de dados na qual a saída será gravada. Obrigatório em solicitações PUT (CreateOrReplace).

properties.diagnostics

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

properties.etag
  • string

A marca de entidade atual para a saída. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detectar 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.

properties.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. Obrigatório em solicitações PUT (CreateOrReplace).

properties.sizeWindow
  • number

A janela de tamanho para a qual restringir uma saída do Stream Analytics.

properties.timeWindow
  • string

O período de tempo para filtrar saídas de trabalho do Stream Analytics.

type
  • string

Tipo de recurso

OutputListResult

Objeto que contém uma lista de saídas em um trabalho de streaming.

Name Type Description
nextLink
  • string

O link (url) para a próxima página de resultados.

value

Uma lista de saídas em um trabalho de streaming. Populado por uma operação 'List'.

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 Type Description
type string:
  • Parquet

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

PowerBIOutputDataSource

Descreve uma fonte de dados de saída do Power BI.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.dataset
  • string

O nome do conjunto de dados do Power BI. Obrigatório em solicitações PUT (CreateOrReplace).

properties.groupId
  • string

A ID do grupo do Power BI.

properties.groupName
  • string

O nome do grupo do Power BI. Use essa propriedade para ajudar a lembrar qual ID específica do grupo do Power BI foi usada.

properties.refreshToken
  • string

Um token de atualização que pode ser usado para obter um token de acesso válido que pode ser usado para autenticar com a fonte de dados. No momento, um token de atualização válido só pode ser obtido por meio do Portal do Azure. É recomendável colocar um valor de cadeia de caracteres fictício aqui ao criar a fonte de dados e, em seguida, ir ao Portal do Azure para autenticar a fonte de dados que atualizará essa propriedade com um token de atualização válido. Obrigatório em solicitações PUT (CreateOrReplace).

properties.table
  • string

O nome da tabela do Power BI no conjunto de dados especificado. Obrigatório em solicitações PUT (CreateOrReplace).

properties.tokenUserDisplayName
  • string

O nome de exibição do usuário que foi usado para obter o token de atualização. Use essa propriedade para ajudar a lembrar qual usuário foi usado para obter o token de atualização.

properties.tokenUserPrincipalName
  • string

O UPN (nome da entidade de usuário) do usuário que foi usado para obter o token de atualização. Use essa propriedade para ajudar a lembrar qual usuário foi usado para obter o token de atualização.

type string:
  • PowerBI

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

ServiceBusQueueOutputDataSource

Descreve uma fonte de dados de saída da Fila do Barramento de Serviço.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.propertyColumns
  • string[]

Uma matriz de cadeia de caracteres dos nomes das colunas de saída a serem anexadas às mensagens do Barramento de Serviço como propriedades personalizadas.

properties.queueName
  • string

O nome da fila do Barramento de Serviço. Obrigatório em solicitações PUT (CreateOrReplace).

properties.serviceBusNamespace
  • string

O namespace associado ao Hub de Eventos desejado, Fila do Barramento de Serviço, Tópico do Barramento de Serviço etc. Obrigató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. Obrigatório em solicitações PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

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

properties.systemPropertyColumns
  • object

As propriedades do sistema associadas à Fila do Barramento de Serviço. As propriedades do sistema a seguir têm suporte: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

type string:
  • Microsoft.ServiceBus/Queue

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

ServiceBusTopicOutputDataSource

Descreve uma fonte de dados de saída do Tópico do Barramento de Serviço.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.propertyColumns
  • string[]

Uma matriz de cadeia de caracteres dos nomes das colunas de saída a serem anexadas às mensagens do Barramento de Serviço como propriedades personalizadas.

properties.serviceBusNamespace
  • string

O namespace associado ao Hub de Eventos desejado, Fila do Barramento de Serviço, Tópico do Barramento de Serviço etc. Obrigató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. Obrigatório em solicitações PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

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

properties.systemPropertyColumns
  • object

As propriedades do sistema associadas à Saída do Tópico do Barramento de Serviço. As propriedades do sistema a seguir têm suporte: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

properties.topicName
  • string

O nome do Tópico do Barramento de Serviço. Obrigatório em solicitações PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/Topic

Indica que o tipo de saída da fonte de dados será gravado. Obrigatório em solicitações PUT (CreateOrReplace).

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

Name Type Description
accountKey
  • string

A chave de conta da conta de Armazenamento do Azure. Obrigatório em solicitações PUT (CreateOrReplace).

accountName
  • string

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