Outputs - List By Streaming Job

Listas todas as saídas na tarefa de transmissão em fluxo especificada.

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 do URI

Name Em Necessário Tipo Description
jobName
path True

string

O nome da tarefa de transmissão em fluxo.

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

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

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

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

$select
query

string

O parâmetro de consulta OData $select. Esta é uma lista separada por vírgulas de propriedades estruturais a incluir na resposta ou "" para incluir todas as propriedades. Por predefinição, todas as propriedades são devolvidas, exceto os diagnósticos. Atualmente, só aceita "" como um valor válido.

Respostas

Name Tipo Description
200 OK

OutputListResult

Listou com êxito as saídas na tarefa de transmissão em fluxo especificada.

Other Status Codes

Error

Error.

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 a sua conta de utilizador

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

Name Description
AuthenticationMode

Modo de Autenticação. Os modos válidos são ConnectionStringe Msi "UserToken".

AvroSerialization

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

AzureDataLakeStoreOutputDataSource

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

AzureFunctionOutputDataSource

Define os metadados de AzureFunctionOutputDataSource

AzureSqlDatabaseOutputDataSource

Descreve uma origem de dados de saída da base de dados SQL do Azure.

AzureSynapseOutputDataSource

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

AzureTableOutputDataSource

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

BlobOutputDataSource

Descreve uma origem de dados de saída de blobs.

CsvSerialization

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

DiagnosticCondition

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

Diagnostics

Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente.

DocumentDbOutputDataSource

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

Encoding

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

Error

Representação comum de erros.

EventHubOutputDataSource

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

EventHubV2OutputDataSource

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

EventSerializationType

Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).

GatewayMessageBusOutputDataSource

Descreve uma origem de dados de saída do Gateway Message Bus.

JsonOutputSerializationFormat

Especifica o formato do JSON no qual a saída será escrita. Os valores atualmente suportados são "lineSeparated" que indica que a saída será formatada ao separar cada objeto JSON por uma nova linha e "matriz", que indica que a saída será formatada como uma matriz de objetos JSON.

JsonSerialization

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

Output

Um objeto de saída, que contém todas as informações associadas à saída nomeada. Todas as saídas estão contidas numa tarefa de transmissão em fluxo.

OutputListResult

Objeto que contém uma lista de saídas numa tarefa de transmissão em fluxo.

ParquetSerialization

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

PowerBIOutputDataSource

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

ServiceBusQueueOutputDataSource

Descreve uma origem de dados de saída da Fila do Service Bus.

ServiceBusTopicOutputDataSource

Descreve uma origem de dados de saída do Tópico do Service Bus.

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

AuthenticationMode

Modo de Autenticação. Os modos válidos são ConnectionStringe Msi "UserToken".

Name Tipo Description
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

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

Name Tipo Description
type string:

Avro

Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).

AzureDataLakeStoreOutputDataSource

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

Name Tipo Valor Predefinido Description
properties.accountName

string

O nome da conta do Azure Data Lake Store. Necessário em pedidos PUT (CreateOrReplace).

properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.dateFormat

string

O formato de data. Sempre que {date} aparecer em filePathPrefix, o valor desta propriedade é utilizado como o formato de data.

properties.filePathPrefix

string

A localização do ficheiro no qual a saída deve ser escrita. Necessário em pedidos PUT (CreateOrReplace).

properties.refreshToken

string

Um token de atualização que pode ser utilizado para obter um token de acesso válido que pode ser utilizado para autenticar com a origem de dados. Atualmente, um token de atualização válido só pode ser obtido através do portal do Azure. Recomenda-se colocar aqui um valor de cadeia fictício ao criar a origem de dados e, em seguida, aceder ao Portal do Azure para autenticar a origem de dados que irá atualizar esta propriedade com um token de atualização válido. Necessário em pedidos PUT (CreateOrReplace).

properties.tenantId

string

O ID de inquilino do utilizador utilizado para obter o token de atualização. Necessário em pedidos PUT (CreateOrReplace).

properties.timeFormat

string

O formato de hora. Onde {time} aparecer em filePathPrefix, o valor desta propriedade é utilizado como o formato de hora.

properties.tokenUserDisplayName

string

O nome a apresentar do utilizador que foi utilizado para obter o token de atualização. Utilize esta propriedade para ajudar a lembrar que utilizador foi utilizado para obter o token de atualização.

properties.tokenUserPrincipalName

string

O nome principal de utilizador (UPN) do utilizador que foi utilizado para obter o token de atualização. Utilize esta propriedade para ajudar a lembrar que utilizador foi utilizado para obter o token de atualização.

type string:

Microsoft.DataLake/Accounts

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Define os metadados de AzureFunctionOutputDataSource

Name Tipo Description
properties.apiKey

string

Se quiser utilizar uma Função do Azure a partir de outra subscrição, pode fazê-lo ao fornecer a chave para aceder à sua função.

properties.functionAppName

string

O nome da sua aplicação Funções do Azure.

properties.functionName

string

O nome da função na sua aplicação Funções do Azure.

properties.maxBatchCount

number

Uma propriedade que lhe permite especificar o número máximo de eventos em cada lote que é enviado para Funções do Azure. O valor predefinido é 100.

properties.maxBatchSize

number

Uma propriedade que lhe permite definir o tamanho máximo para cada lote de saída que é enviado para a função do Azure. A unidade de entrada está em bytes. Por predefinição, este valor é de 262 144 bytes (256 KB).

type string:

Microsoft.AzureFunction

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

AzureSqlDatabaseOutputDataSource

Descreve uma origem de dados de saída da base de dados SQL do Azure.

Name Tipo Valor Predefinido Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.database

string

O nome da base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.maxBatchCount

number

Contagem máxima do Batch para escrita na base de dados Sql, o valor predefinido é 10 000. Opcional em pedidos PUT.

properties.maxWriterCount

number

A contagem máxima de escritores, atualmente, apenas 1 (escritor único) e 0 (com base na partição de consulta) estão disponíveis. Opcional em pedidos PUT.

properties.password

string

A palavra-passe que será utilizada para ligar à base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.server

string

O nome do servidor SQL que contém a base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.table

string

O nome da tabela na base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.user

string

O nome de utilizador que será utilizado para ligar à base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

type string:

Microsoft.Sql/Server/Database

Indica que o tipo de saída da origem de dados será escrito. Necessário em pedidos PUT (CreateOrReplace).

AzureSynapseOutputDataSource

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

Name Tipo Description
properties.database

string

O nome da base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.password

string

A palavra-passe que será utilizada para ligar à base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.server

string

O nome do servidor SQL que contém a base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.table

string

O nome da tabela na base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.user

string

O nome de utilizador que será utilizado para ligar à base de dados SQL do Azure. Necessário em pedidos PUT (CreateOrReplace).

type string:

Microsoft.Sql/Server/DataWarehouse

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

AzureTableOutputDataSource

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

Name Tipo Description
properties.accountKey

string

A chave de conta da conta de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.accountName

string

O nome da conta de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.batchSize

integer

O número de linhas a escrever na Tabela do Azure de cada vez.

properties.columnsToRemove

string[]

Se especificado, cada item na matriz é o nome de uma coluna a remover (se estiver presente) das entidades de eventos de saída.

properties.partitionKey

string

Este elemento indica o nome de uma coluna da instrução SELECT na consulta que será utilizada como a chave de partição da Tabela do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.rowKey

string

Este elemento indica o nome de uma coluna da instrução SELECT na consulta que será utilizada como a chave de linha da Tabela do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.table

string

O nome da Tabela do Azure. Necessário em pedidos PUT (CreateOrReplace).

type string:

Microsoft.Storage/Table

Indica que o tipo de saída da origem de dados será escrito. Necessário em pedidos PUT (CreateOrReplace).

BlobOutputDataSource

Descreve uma origem de dados de saída de blobs.

Name Tipo Valor Predefinido Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.blobPathPrefix

string

Prefixo do caminho do blob.

properties.container

string

O nome de um contentor na conta de Armazenamento associada. Este contentor contém os blob(s) a serem lidos ou escritos em. Necessário em pedidos PUT (CreateOrReplace).

properties.dateFormat

string

O formato de data. Onde quer que {date} apareça no pathPattern, o valor desta propriedade é utilizado como o formato de data.

properties.pathPattern

string

O padrão do caminho do blob. Não é uma expressão normal. Representa um padrão em relação ao qual os nomes de blobs serão correspondidos para determinar se devem ou não ser incluídos como entrada ou saída para a tarefa. Veja https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input ou https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obter uma explicação e um exemplo mais detalhados.

properties.storageAccounts

StorageAccount[]

Uma lista de uma ou mais contas de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace).

properties.timeFormat

string

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

type string:

Microsoft.Storage/Blob

Indica que o tipo de saída da origem de dados será escrito. Necessário em pedidos PUT (CreateOrReplace).

CsvSerialization

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

Name Tipo Description
properties.encoding

Encoding

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

properties.fieldDelimiter

string

Especifica o delimitador que será utilizado para separar registos de valores separados por vírgulas (CSV). Veja https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input ou https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output para obter uma lista de valores suportados. Necessário em pedidos PUT (CreateOrReplace).

type string:

Csv

Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).

DiagnosticCondition

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

Name Tipo Description
code

string

O código de diagnóstico opaco.

message

string

A mensagem legível por humanos que descreve a condição em detalhe. Localizado na Accept-Language do pedido de cliente.

since

string

O carimbo de data/hora UTC de quando a condição começou. Os clientes devem conseguir encontrar um evento correspondente no registo de operações por esta altura.

Diagnostics

Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente.

Name Tipo Description
conditions

DiagnosticCondition[]

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

DocumentDbOutputDataSource

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

Name Tipo Description
properties.accountId

string

O nome ou ID da conta do DocumentDB. Necessário em pedidos PUT (CreateOrReplace).

properties.accountKey

string

A chave da conta do DocumentDB. Necessário em pedidos PUT (CreateOrReplace).

properties.collectionNamePattern

string

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

properties.database

string

O nome da base de dados do DocumentDB. Necessário em pedidos PUT (CreateOrReplace).

properties.documentId

string

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

properties.partitionKey

string

O nome do campo em eventos de saída utilizados para especificar a chave para a criação de partições de saída entre coleções. Se "collectionNamePattern" contiver o token {partition}, esta propriedade tem de ser especificada.

type string:

Microsoft.Storage/DocumentDB

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

Encoding

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

Name Tipo Description
UTF8

string

Error

Representação comum de erros.

Name Tipo Description
error

Error

Propriedades de definição de erro.

EventHubOutputDataSource

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

Name Tipo Valor Predefinido Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.eventHubName

string

O nome do Hub de Eventos. Necessário em pedidos PUT (CreateOrReplace).

properties.partitionKey

string

A chave/coluna que é utilizada para determinar a partição para enviar dados de eventos.

properties.propertyColumns

string[]

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

serviceBusNamespace

string

O espaço de nomes associado ao Hub de Eventos pretendido, à Fila do Service Bus, ao Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace).

sharedAccessPolicyKey

string

A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace).

sharedAccessPolicyName

string

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

type string:

Microsoft.ServiceBus/EventHub

Indica que o tipo de saída da origem de dados será escrito. Necessário em pedidos PUT (CreateOrReplace).

EventHubV2OutputDataSource

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

Name Tipo Valor Predefinido Description
authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.eventHubName

string

O nome do Hub de Eventos. Necessário em pedidos PUT (CreateOrReplace).

properties.partitionKey

string

A chave/coluna que é utilizada para determinar a partição para enviar dados de eventos.

properties.propertyColumns

string[]

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

serviceBusNamespace

string

O espaço de nomes associado ao Hub de Eventos pretendido, à Fila do Service Bus, ao Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace).

sharedAccessPolicyKey

string

A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace).

sharedAccessPolicyName

string

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

type string:

Microsoft.EventHub/EventHub

Indica que o tipo de saída da origem de dados será escrito. Necessário em pedidos PUT (CreateOrReplace).

EventSerializationType

Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).

Name Tipo Description
Avro

string

Csv

string

Json

string

Parquet

string

GatewayMessageBusOutputDataSource

Descreve uma origem de dados de saída do Gateway Message Bus.

Name Tipo Description
properties.topic

string

O nome do tópico do Service Bus.

type string:

GatewayMessageBus

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

JsonOutputSerializationFormat

Especifica o formato do JSON no qual a saída será escrita. Os valores atualmente suportados são "lineSeparated" que indica que a saída será formatada ao separar cada objeto JSON por uma nova linha e "matriz", que indica que a saída será formatada como uma matriz de objetos JSON.

Name Tipo Description
Array

string

LineSeparated

string

JsonSerialization

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

Name Tipo Description
properties.encoding

Encoding

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

properties.format

JsonOutputSerializationFormat

Esta propriedade aplica-se apenas à serialização JSON de saídas. Não é aplicável a entradas. Esta propriedade especifica o formato do JSON no qual a saída será escrita. Os valores atualmente suportados são "lineSeparated" que indica que a saída será formatada ao separar cada objeto JSON por uma nova linha e "matriz", que indica que a saída será formatada como uma matriz de objetos JSON. O valor predefinido é "lineSeparated" se for deixado nulo.

type string:

Json

Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).

Output

Um objeto de saída, que contém todas as informações associadas à saída nomeada. Todas as saídas estão contidas numa tarefa de transmissão em fluxo.

Name Tipo Description
id

string

ID do Recurso

name

string

Nome do recurso

properties.datasource OutputDataSource:

Descreve a origem de dados na qual a saída será escrita. Necessário em pedidos PUT (CreateOrReplace).

properties.diagnostics

Diagnostics

Descreve as condições aplicáveis à Entrada, Saída ou à tarefa em geral, que garantem a atenção do cliente.

properties.etag

string

A etiqueta de entidade atual para o resultado. Esta é uma cadeia opaca. Pode utilizá-lo para detetar se o recurso mudou entre pedidos. Também pode utilizá-lo nos cabeçalhos If-Match ou If-None-Match para operações de escrita para simultaneidade otimista.

properties.serialization Serialization:

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando escritos numa saída. Necessário em pedidos PUT (CreateOrReplace).

properties.sizeWindow

integer

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

properties.timeWindow

string

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

type

string

Tipo de recurso

OutputListResult

Objeto que contém uma lista de saídas numa tarefa de transmissão em fluxo.

Name Tipo Description
nextLink

string

A ligação (URL) para a página seguinte dos resultados.

value

Output[]

Uma lista de saídas numa tarefa de transmissão em fluxo. Preenchido por uma operação "Lista".

ParquetSerialization

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

Name Tipo Description
type string:

Parquet

Indica o tipo de serialização que a entrada ou saída utiliza. Necessário em pedidos PUT (CreateOrReplace).

PowerBIOutputDataSource

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

Name Tipo Valor Predefinido Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.dataset

string

O nome do conjunto de dados do Power BI. Necessário em pedidos PUT (CreateOrReplace).

properties.groupId

string

O ID do grupo do Power BI.

properties.groupName

string

O nome do grupo do Power BI. Utilize esta propriedade para ajudar a lembrar que ID de grupo específico do Power BI foi utilizado.

properties.refreshToken

string

Um token de atualização que pode ser utilizado para obter um token de acesso válido que pode ser utilizado para autenticar com a origem de dados. Atualmente, um token de atualização válido só pode ser obtido através do portal do Azure. Recomenda-se colocar aqui um valor de cadeia fictício ao criar a origem de dados e, em seguida, aceder ao Portal do Azure para autenticar a origem de dados que irá atualizar esta propriedade com um token de atualização válido. Necessário em pedidos PUT (CreateOrReplace).

properties.table

string

O nome da tabela do Power BI no conjunto de dados especificado. Necessário em pedidos PUT (CreateOrReplace).

properties.tokenUserDisplayName

string

O nome a apresentar do utilizador que foi utilizado para obter o token de atualização. Utilize esta propriedade para ajudar a lembrar que utilizador foi utilizado para obter o token de atualização.

properties.tokenUserPrincipalName

string

O nome principal de utilizador (UPN) do utilizador que foi utilizado para obter o token de atualização. Utilize esta propriedade para ajudar a lembrar que utilizador foi utilizado para obter o token de atualização.

type string:

PowerBI

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

ServiceBusQueueOutputDataSource

Descreve uma origem de dados de saída da Fila do Service Bus.

Name Tipo Valor Predefinido Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.propertyColumns

string[]

Uma matriz de cadeia dos nomes das colunas de saída a anexar às mensagens do Service Bus como propriedades personalizadas.

properties.queueName

string

O nome da Fila do Service Bus. Necessário em pedidos PUT (CreateOrReplace).

properties.serviceBusNamespace

string

O espaço de nomes associado ao Hub de Eventos pretendido, à Fila do Service Bus, ao Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

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

properties.systemPropertyColumns

object

As propriedades do sistema associadas à Fila do Service Bus. As seguintes propriedades do sistema são suportadas: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

type string:

Microsoft.ServiceBus/Queue

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

ServiceBusTopicOutputDataSource

Descreve uma origem de dados de saída do Tópico do Service Bus.

Name Tipo Valor Predefinido Description
properties.authenticationMode

AuthenticationMode

ConnectionString

Modo de Autenticação.

properties.propertyColumns

string[]

Uma matriz de cadeia dos nomes das colunas de saída a anexar às mensagens do Service Bus como propriedades personalizadas.

properties.serviceBusNamespace

string

O espaço de nomes associado ao Hub de Eventos pretendido, à Fila do Service Bus, ao Tópico do Service Bus, etc. Necessário em pedidos PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

A chave de política de acesso partilhado para a política de acesso partilhado especificada. Necessário em pedidos PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

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

properties.systemPropertyColumns

object

As propriedades do sistema associadas à Saída do Tópico do Service Bus. As seguintes propriedades do sistema são suportadas: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.

properties.topicName

string

O nome do Tópico do Service Bus. Necessário em pedidos PUT (CreateOrReplace).

type string:

Microsoft.ServiceBus/Topic

Indica o tipo de saída da origem de dados em que será escrito. Necessário em pedidos PUT (CreateOrReplace).

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

Name Tipo Description
accountKey

string

A chave de conta da conta de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace).

accountName

string

O nome da conta de Armazenamento do Azure. Necessário em pedidos PUT (CreateOrReplace).