Outputs - Update

Atualizações uma produção existente no âmbito de um trabalho de streaming existente. Isto pode ser usado para atualizar parcialmente (ou seja, atualizar uma ou duas propriedades) uma saída sem afetar o resto da definição de trabalho ou saída.

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

Parâmetros do URI

Name In Required Type Description
jobName
path True
  • string

O nome do trabalho de streaming.

outputName
path True
  • string

O nome da saída.

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

A identificação da assinatura do alvo.

api-version
query True
  • string

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

Cabeçalho do Pedido

Name Required Type Description
If-Match
  • string

O ETag da saída. Omita este valor para substituir sempre a produção atual. Especifique o valor ETag visto pela última vez para evitar alterações simultâneas acidentalmente.

Corpo do Pedido

Name Type Description
name
  • string

Nome do recurso

properties.datasource OutputDataSource:

Descreve a fonte de dados para a qual a saída será escrita. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.serialization Serialization:

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando escritos para uma saída. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.sizeWindow
  • number

A janela de tamanho para conter uma saída stream Analytics para.

properties.timeWindow
  • string

O prazo para filtrar as saídas de trabalho do Stream Analytics.

Respostas

Name Type Description
200 OK

A saída foi atualizada com sucesso.

Headers

  • ETag: string
Other Status Codes

Error.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Update a blob output with CSV serialization
Update a DocumentDB output
Update a Power BI output
Update a Service Bus Queue output with Avro serialization
Update a Service Bus Topic output with CSV serialization
Update an Azure Data Lake Store output with JSON serialization
Update an Azure Data Warehouse output
Update an Azure Function output
Update an Azure SQL database output
Update an Azure Table output
Update an Event Hub output with JSON serialization

Update a blob output with CSV serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Blob",
      "properties": {
        "container": "differentContainer"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": "|",
        "encoding": "UTF8"
      }
    }
  }
}

Sample Response

ETag: 3a1b2023-79a9-4b33-93e8-f49fc3e573fe
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/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"
      }
    }
  }
}

Update a DocumentDB output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/DocumentDB",
      "properties": {
        "partitionKey": "differentPartitionKey"
      }
    }
  }
}

Sample Response

ETag: 7849c132-e995-4631-91c3-931606eec432
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/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"
      }
    }
  }
}

Update a Power BI output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "PowerBI",
      "properties": {
        "dataset": "differentDataset"
      }
    }
  }
}

Sample Response

ETag: 7849c132-e995-4631-91c3-931606eec432
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "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"
      }
    }
  }
}

Update a Service Bus Queue output with Avro serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Queue",
      "properties": {
        "queueName": "differentQueueName"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Sample Response

ETag: 429adaec-a777-4750-8a39-8d0c931d801c
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/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"
      }
    }
  }
}

Update a Service Bus Topic output with CSV serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Topic",
      "properties": {
        "topicName": "differentTopicName"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": "|",
        "encoding": "UTF8"
      }
    }
  }
}

Sample Response

ETag: c1c2007f-45b2-419a-ae7d-4d2148998460
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/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"
      }
    }
  }
}

Update an Azure Data Lake Store output with JSON serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.DataLake/Accounts",
      "properties": {
        "accountName": "differentaccount"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Sample Response

ETag: 5020de6b-5bb3-4b88-8606-f11fb3c46185
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "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"
      }
    }
  }
}

Update an Azure Data Warehouse output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/Database",
      "properties": {
        "table": "differentTable"
      }
    }
  }
}

Sample Response

ETag: f489d6f3-fcd5-4bcb-b642-81e987ee16d6
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/dwOutput",
  "name": "dwOutput",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/DataWarehouse",
      "properties": {
        "table": "differentTable",
        "server": "asatestserver",
        "database": "zhayaSQLpool",
        "user": "tolladmin"
      }
    }
  }
}

Update an Azure Function output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionName": "differentFunctionName"
      }
    }
  }
}

Sample Response

ETag: f489d6f3-fcd5-4bcb-b642-81e987ee16d6
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/azureFunction1",
  "name": "azureFunction1",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionAppName": "functionappforasaautomation",
        "functionName": "differentFunctionName",
        "apiKey": null,
        "maxBatchSize": 256,
        "maxBatchCount": 100
      }
    }
  }
}

Update an Azure SQL database output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/Database",
      "properties": {
        "table": "differentTable"
      }
    }
  }
}

Sample Response

ETag: f489d6f3-fcd5-4bcb-b642-81e987ee16d6
{
  "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"
      }
    }
  }
}

Update an Azure Table output

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Table",
      "properties": {
        "partitionKey": "differentPartitionKey"
      }
    }
  }
}

Sample Response

ETag: ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/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
      }
    }
  }
}

Update an Event Hub output with JSON serialization

Sample Request

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

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "partitionKey": "differentPartitionKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Sample Response

ETag: 5020de6b-5bb3-4b88-8606-f11fb3c46185
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/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"
      }
    }
  }
}

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 escritos para uma saída no formato Avro.

AzureDataLakeStoreOutputDataSource

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

AzureFunctionOutputDataSource

Define os metadados do AzureFunctionOutputDataSource

AzureSqlDatabaseOutputDataSource

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

AzureSynapseOutputDataSource

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

AzureTableOutputDataSource

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

BlobOutputDataSource

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

CsvSerialization

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

DiagnosticCondition

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

Diagnostics

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

DocumentDbOutputDataSource

Descreve uma fonte de dados de saída documentDB.

Encoding

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

Error

Representação de erro comum.

EventHubOutputDataSource

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

EventHubV2OutputDataSource

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

EventSerializationType

Indica o tipo de serialização que a entrada ou saída utiliza. Requerido nos pedidos DE PUT (CreateOrReplace).

GatewayMessageBusOutputDataSource

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

JsonOutputSerializationFormat

Especifica o formato do JSON em que a saída será escrita. Os valores atualmente suportados são 'lineSeparated' indicando que a saída será formatada por cada objeto JSON separado por uma nova linha e 'matriz' 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 escritos para uma saída no formato JSON.

Output

Um objeto de saída, contendo todas as informações associadas à saída nomeada. Todas as saídas estão contidas num trabalho de streaming.

ParquetSerialization

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

PowerBIOutputDataSource

Descreve uma fonte de dados de saída power BI.

ServiceBusQueueOutputDataSource

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

ServiceBusTopicOutputDataSource

Descreve uma fonte de dados de saída de ônibus de serviço.

StorageAccount

As propriedades associadas a uma conta de Armazenamento 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 escritos para uma saída no formato Avro.

Name Type Description
type string:
  • Avro

Indica o tipo de serialização que a entrada ou saída utiliza. Requerido nos pedidos DE PUT (CreateOrReplace).

AzureDataLakeStoreOutputDataSource

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

Name Type Default Value Description
properties.accountName
  • string

O nome da conta Azure Data Lake Store. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.authenticationMode ConnectionString

Modo de autenticação.

properties.dateFormat
  • string

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

properties.filePathPrefix
  • string

A localização do ficheiro para o qual a saída deve ser escrita. Requerido nos pedidos DE 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. Atualmente, apenas é obtida uma ficha de atualização válida através do Portal Azure. Recomenda-se colocar aqui um valor de cadeia falso ao criar a fonte de dados e depois ir ao Portal Azure autenticar a fonte de dados que irá atualizar esta propriedade com um token de atualização válido. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.tenantId
  • string

A identificação do inquilino do utilizador usou para obter o token de atualização. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.timeFormat
  • string

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

properties.tokenUserDisplayName
  • string

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

properties.tokenUserPrincipalName
  • string

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

type string:
  • Microsoft.DataLake/Accounts

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Define os metadados do AzureFunctionOutputDataSource

Name Type Description
properties.apiKey
  • string

Se pretender utilizar uma Função Azure a partir de outra subscrição, pode fazê-lo fornecendo 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 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 permite definir o tamanho máximo para cada lote de saída que é enviado para a sua função Azure. A unidade de entrada está em bytes. Por padrão, este valor é de 262.144 bytes (256 KB).

type string:
  • Microsoft.AzureFunction

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

AzureSqlDatabaseOutputDataSource

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

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.database
  • string

O nome da base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.maxBatchCount
  • number

Max Batch conta para escrever na base de dados sql, o valor padrão é de 10.000. Opcional em pedidos PUT.

properties.maxWriterCount
  • number

Max Writer conta, atualmente apenas 1 (escritor único) e 0 (baseado na partição de consultas) 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. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.server
  • string

O nome do servidor SQL que contém a base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.table
  • string

O nome da tabela na base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.user
  • string

O nome de utilizador que será utilizado para ligar à base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/Database

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

AzureSynapseOutputDataSource

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

Name Type Description
properties.database
  • string

O nome da base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.password
  • string

A palavra-passe que será utilizada para ligar à base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.server
  • string

O nome do servidor SQL que contém a base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.table
  • string

O nome da tabela na base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.user
  • string

O nome de utilizador que será utilizado para ligar à base de dados SQL do Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Microsoft.Sql/Server/DataWarehouse

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

AzureTableOutputDataSource

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

Name Type Description
properties.accountKey
  • string

A chave da conta para a conta de Armazenamento Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.accountName
  • string

O nome da conta de armazenamento Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.batchSize
  • integer

O número de filas para escrever à Mesa Azure de cada vez.

properties.columnsToRemove
  • string[]

Se especificado, cada item na matriz é o nome de uma coluna para remover (se presente) de entidades de evento de saída.

properties.partitionKey
  • string

Este elemento indica o nome de uma coluna da declaração SELECT na consulta que será usada como chave de partição para a Tabela Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.rowKey
  • string

Este elemento indica o nome de uma coluna da declaração SELECT na consulta que será utilizada como chave de linha para a Tabela Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.table
  • string

O nome da Mesa Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Microsoft.Storage/Table

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

BlobOutputDataSource

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

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.blobPathPrefix
  • string

Prefixo do caminho da bolha.

properties.container
  • string

O nome de um contentor na conta de Armazenamento associada. Este recipiente contém o (s) blob(s) a ser lido ou escrito para. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.dateFormat
  • string

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

properties.pathPattern
  • string

O padrão do caminho da bolha. Não é uma expressão normal. Representa um padrão contra o qual os nomes blob serão combinados para determinar se devem ou não ser incluídos como entrada ou saída para o trabalho. 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 uma explicação e exemplo mais detalhadas.

properties.storageAccounts

Uma lista de uma ou mais contas de Armazenamento Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.timeFormat
  • string

O formato do tempo. Onde quer que {time} apareça no pathPattern, o valor desta propriedade é usado como formato de tempo em vez disso.

type string:
  • Microsoft.Storage/Blob

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

CsvSerialization

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

Name Type Description
properties.encoding

Especifica a codificação dos dados recebidos em caso de entrada e codificação de dados de saída em caso de saída. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.fieldDelimiter
  • string

Especifica o delimiter que será usado para separar registos de valor separados por vírgula (CSV). 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 suportados. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Csv

Indica o tipo de serialização que a entrada ou saída utiliza. Requerido nos pedidos DE PUT (CreateOrReplace).

DiagnosticCondition

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

Name Type Description
code
  • string

O código de diagnóstico opaco.

message
  • string

A mensagem legível pelo homem descrevendo a condição em detalhe. Localizado no Accept-Language do pedido do cliente.

since
  • string

O tempo de tempo UTC de quando a condição começou. Os clientes devem ser capazes de encontrar um evento correspondente no login de operações por esta altura.

Diagnostics

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

Name Type Description
conditions

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

DocumentDbOutputDataSource

Descreve uma fonte de dados de saída documentDB.

Name Type Description
properties.accountId
  • string

O nome da conta documentDB ou ID. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.accountKey
  • string

A chave de conta para a conta DocumentDB. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.collectionNamePattern
  • string

O padrão de nome de coleção para as coleções a serem usadas. O formato do nome de coleção pode ser construído usando o token opcional {partition}, onde as divisórias começam a partir de 0. Consulte a secção DocumentDB para https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output obter mais informações. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.database
  • string

O nome da base de dados DocumentDB. Requerido nos pedidos DE 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 são baseadas.

properties.partitionKey
  • string

O nome do campo em eventos de saída usados para especificar a chave para a divisão da saída através das coleções. Se 'collectionNamePattern' contiver o token {partition}, esta propriedade é necessária para ser especificada.

type string:
  • Microsoft.Storage/DocumentDB

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

Encoding

Especifica a codificação dos dados recebidos em caso de entrada e codificação de dados de saída em 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 Event Hub.

Name Type Default Value Description
authenticationMode ConnectionString

Modo de autenticação.

properties.eventHubName
  • string

O nome do Centro de Eventos. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.partitionKey
  • string

A chave/coluna que é usada para determinar para que partição enviar dados do evento.

properties.propertyColumns
  • string[]

As propriedades associadas a esta saída do Event Hub.

serviceBusNamespace
  • string

O espaço de nome que está associado ao desejado Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

A chave da política de acesso partilhado para a política de acesso partilhado especificada. Requerido nos pedidos DE PUT (CreateOrReplace).

sharedAccessPolicyName
  • string

O nome da política de acesso compartilhado para o Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/EventHub

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

EventHubV2OutputDataSource

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

Name Type Default Value Description
authenticationMode ConnectionString

Modo de autenticação.

properties.eventHubName
  • string

O nome do Centro de Eventos. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.partitionKey
  • string

A chave/coluna que é usada para determinar para que partição enviar dados do evento.

properties.propertyColumns
  • string[]

As propriedades associadas a esta saída do Event Hub.

serviceBusNamespace
  • string

O espaço de nome que está associado ao desejado Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

sharedAccessPolicyKey
  • string

A chave da política de acesso partilhado para a política de acesso partilhado especificada. Requerido nos pedidos DE PUT (CreateOrReplace).

sharedAccessPolicyName
  • string

O nome da política de acesso compartilhado para o Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Microsoft.EventHub/EventHub

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

EventSerializationType

Indica o tipo de serialização que a entrada ou saída utiliza. Requerido nos pedidos DE PUT (CreateOrReplace).

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

GatewayMessageBusOutputDataSource

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

Name Type Description
properties.topic
  • string

O nome do tema do Autocarro de Serviço.

type string:
  • GatewayMessageBus

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

JsonOutputSerializationFormat

Especifica o formato do JSON em que a saída será escrita. Os valores atualmente suportados são 'lineSeparated' indicando que a saída será formatada por cada objeto JSON separado por uma nova linha e 'matriz' 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 escritos para uma saída no formato JSON.

Name Type Description
properties.encoding

Especifica a codificação dos dados recebidos em caso de entrada e codificação de dados de saída em caso de saída. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.format

Esta propriedade aplica-se apenas à serialização JSON de saídas. Não é aplicável às entradas. Esta propriedade especifica o formato do JSON em que a saída será escrita. Os valores atualmente suportados são 'lineSeparated' indicando que a saída será formatada por cada objeto JSON separado por uma nova linha e 'matriz' indicando que a saída será formatada como uma matriz de objetos JSON. O valor predefinido é 'lineSeparated' se deixar nulo.

type string:
  • Json

Indica o tipo de serialização que a entrada ou saída utiliza. Requerido nos pedidos DE PUT (CreateOrReplace).

Output

Um objeto de saída, contendo todas as informações associadas à saída nomeada. Todas as saídas estão contidas num trabalho de streaming.

Name Type Description
id
  • string

ID de recursos

name
  • string

Nome do recurso

properties.datasource OutputDataSource:

Descreve a fonte de dados para a qual a saída será escrita. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.diagnostics

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

properties.etag
  • string

A etiqueta da entidade atual para a saída. Esta é uma corda opaca. Pode usá-lo para detetar se o recurso mudou entre pedidos. Também pode usá-lo nos cabeçalhos If-Match ou Se-Nenhum-Match para escrever operações para conúnquidade otimista.

properties.serialization Serialization:

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando escritos para uma saída. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.sizeWindow
  • number

A janela de tamanho para conter uma saída stream Analytics para.

properties.timeWindow
  • string

O prazo para filtrar as saídas de trabalho do Stream Analytics.

type
  • string

Tipo de recurso

ParquetSerialization

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

Name Type Description
type string:
  • Parquet

Indica o tipo de serialização que a entrada ou saída utiliza. Requerido nos pedidos DE PUT (CreateOrReplace).

PowerBIOutputDataSource

Descreve uma fonte de dados de saída power BI.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.dataset
  • string

O nome do conjunto de dados Power BI. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.groupId
  • string

A identificação do grupo Power BI.

properties.groupName
  • string

O nome do grupo Power BI. Utilize esta propriedade para ajudar a lembrar que id do grupo Power BI específico foi usado.

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. Atualmente, apenas é obtida uma ficha de atualização válida através do Portal Azure. Recomenda-se colocar aqui um valor de cadeia falso ao criar a fonte de dados e depois ir ao Portal Azure autenticar a fonte de dados que irá atualizar esta propriedade com um token de atualização válido. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.table
  • string

O nome da tabela Power BI no conjunto de dados especificado. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.tokenUserDisplayName
  • string

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

properties.tokenUserPrincipalName
  • string

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

type string:
  • PowerBI

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

ServiceBusQueueOutputDataSource

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

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.propertyColumns
  • string[]

Um conjunto de cordas dos nomes das colunas de saída a serem anexadas às mensagens de Service Bus como propriedades personalizadas.

properties.queueName
  • string

O nome da fila do autocarro de serviço. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.serviceBusNamespace
  • string

O espaço de nome que está associado ao desejado Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.sharedAccessPolicyKey
  • string

A chave da política de acesso partilhado para a política de acesso partilhado especificada. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

O nome da política de acesso compartilhado para o Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.systemPropertyColumns
  • object

As propriedades do sistema associadas à fila de autocarros de serviço. As seguintes propriedades do sistema são suportadas: AnswerToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, AnswerTo, Label, ScheduledEnqueueTimeUtc.

type string:
  • Microsoft.ServiceBus/Queue

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

ServiceBusTopicOutputDataSource

Descreve uma fonte de dados de saída de ônibus de serviço.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

properties.propertyColumns
  • string[]

Um conjunto de cordas dos nomes das colunas de saída a serem anexadas às mensagens de Service Bus como propriedades personalizadas.

properties.serviceBusNamespace
  • string

O espaço de nome que está associado ao desejado Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.sharedAccessPolicyKey
  • string

A chave da política de acesso partilhado para a política de acesso partilhado especificada. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.sharedAccessPolicyName
  • string

O nome da política de acesso compartilhado para o Event Hub, Service Bus Queue, Service Bus Topic, etc. Requerido nos pedidos DE PUT (CreateOrReplace).

properties.systemPropertyColumns
  • object

As propriedades do sistema associadas à produção de tópicos de serviço. As seguintes propriedades do sistema são suportadas: AnswerToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, AnswerTo, Label, ScheduledEnqueueTimeUtc.

properties.topicName
  • string

O nome do Tópico do Autocarro de Serviço. Requerido nos pedidos DE PUT (CreateOrReplace).

type string:
  • Microsoft.ServiceBus/Topic

Indica que o tipo de saída de fonte de dados será escrito. Requerido nos pedidos DE PUT (CreateOrReplace).

StorageAccount

As propriedades associadas a uma conta de Armazenamento Azure

Name Type Description
accountKey
  • string

A chave da conta para a conta de Armazenamento Azure. Requerido nos pedidos DE PUT (CreateOrReplace).

accountName
  • string

O nome da conta de armazenamento Azure. Requerido nos pedidos DE PUT (CreateOrReplace).