Streaming Jobs - Get

Obtém detalhes sobre o trabalho de streaming especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}?api-version=2020-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}?$expand={$expand}&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.

$expand
query
  • string

O parâmetro de consulta OData $expand. Esta é uma lista separada por vírgulas de propriedades adicionais de trabalho de streaming a serem incluídas na resposta, além do conjunto padrão retornado quando esse parâmetro está ausente. O conjunto padrão é todas as propriedades de trabalho de streaming que não sejam 'entradas', 'transformação', 'saídas' e 'funções'.

Respostas

Name Type Description
200 OK

Recuperou com êxito o trabalho de streaming especificado.

Headers

  • ETag: string
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

Get a streaming job and do not use the $expand OData query parameter
Get a streaming job and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions

Get a streaming job and do not use the $expand OData query parameter

Sample Request

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

Sample Response

ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0"
  }
}

Get a streaming job and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions

Sample Request

GET https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804?$expand=inputs,outputs,transformation,functions&api-version=2020-03-01

Sample Response

ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}

Definições

AggregateFunctionProperties

As propriedades associadas a uma função de agregação.

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

AzureMachineLearningWebServiceFunctionBinding

A associação a um serviço Web do Azure Machine Learning.

AzureMachineLearningWebServiceInputColumn

Descreve uma coluna de entrada para o ponto de extremidade do serviço Web do Azure Machine Learning.

AzureMachineLearningWebServiceInputs

As entradas para o ponto de extremidade do serviço Web do Azure Machine Learning.

AzureMachineLearningWebServiceOutputColumn

Descreve uma coluna de saída para o ponto de extremidade do serviço Web do Azure Machine Learning.

AzureSqlDatabaseOutputDataSource

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

AzureSqlReferenceInputDataSource

Descreve uma fonte de dados de referência 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.

BlobReferenceInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de referência.

BlobStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

ClusterInfo

As propriedades associadas a um cluster do Stream Analytics.

CompatibilityLevel

Controla determinados comportamentos de runtime do trabalho de streaming.

Compression

Descreve como os dados de entrada são compactados

CompressionType

Indica o tipo de compactação que a entrada usa. Obrigatório em solicitações PUT (CreateOrReplace).

ContentStoragePolicy

Os valores válidos são JobStorageAccount e SystemAccount. Se definido como JobStorageAccount, isso requer que o usuário também especifique a propriedade jobStorageAccount. .

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 garantem 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.

EventHubStreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

EventHubV2OutputDataSource

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

EventHubV2StreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

EventSerializationType

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

EventsOutOfOrderPolicy

Indica a política a ser aplicada aos eventos que chegam fora de ordem no fluxo de eventos de entrada.

FileReferenceInputDataSource

Descreve uma fonte de dados de entrada de arquivo que contém dados de referência.

Function

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

FunctionInput

Descreve um parâmetro de entrada de uma função.

FunctionOutput

Descreve a saída de uma função.

GatewayMessageBusOutputDataSource

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

GatewayMessageBusStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Identity

Descreve como a identidade é verificada

Input

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

IoTHubStreamInputDataSource

Descreve uma fonte de dados de entrada Hub IoT que contém dados de fluxo.

JavaScriptFunctionBinding

A associação a uma função JavaScript.

JobStorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure com MSI

JobType

Descreve o tipo do trabalho. Os modos válidos são Cloud e 'Edge'.

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, contendo todas as informações associadas à saída nomeada. Todas as saídas estão contidas em um trabalho de streaming.

OutputErrorPolicy

Indica a política a ser aplicada aos eventos que chegam à saída e não podem ser gravados no armazenamento externo por estarem malformados (faltando valores de coluna, valores de coluna de tipo ou tamanho incorreto).

OutputStartMode

O valor pode ser JobStartTime, CustomTime ou LastOutputEventTime para indicar se o ponto de partida do fluxo de eventos de saída deve ser iniciado sempre que o trabalho for iniciado, iniciar em um carimbo de data/hora do usuário personalizado especificado por meio da propriedade outputStartTime ou iniciar a partir da hora de saída do último evento.

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.

ReferenceInputProperties

As propriedades associadas a uma entrada que contém dados de referência.

RefreshType

Indica o tipo de opção de atualização de dados.

ScalarFunctionProperties

As propriedades associadas a uma função escalar.

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.

Sku

As propriedades associadas a uma SKU.

SkuName

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

StorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure

StreamingJob

Um objeto de trabalho de streaming que contém todas as informações associadas ao trabalho de streaming nomeado.

StreamInputProperties

As propriedades associadas a uma entrada que contém dados de fluxo.

Transformation

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

AggregateFunctionProperties

As propriedades associadas a uma função de agregação.

Name Type Description
etag
  • string

A marca de entidade atual para a função. 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.binding FunctionBinding:

A associação física da função. Por exemplo, no caso do serviço Web do Azure Machine Learning, isso descreve o ponto de extremidade.

properties.inputs

Descreve um parâmetro de entrada de uma função.

properties.output

Descreve a saída de uma função.

type string:
  • Aggregate

Indica o tipo de função.

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 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 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:
  • 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).

AzureMachineLearningWebServiceFunctionBinding

A associação a um serviço Web do Azure Machine Learning.

Name Type Description
properties.apiKey
  • string

A chave de API usada para autenticar com Request-Response ponto de extremidade.

properties.batchSize
  • integer

Número entre 1 e 10000 que descreve o número máximo de linhas para cada solicitação de execução do Azure ML RRS. O padrão é 1000.

properties.endpoint
  • string

O Request-Response executar o ponto de extremidade do serviço Web do Azure Machine Learning. Saiba mais aqui: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs

properties.inputs

As entradas para o ponto de extremidade do serviço Web do Azure Machine Learning.

properties.outputs

Uma lista de saídas da execução do ponto de extremidade do serviço Web do Azure Machine Learning.

type string:
  • Microsoft.MachineLearning/WebService

Indica o tipo de associação de função.

AzureMachineLearningWebServiceInputColumn

Descreve uma coluna de entrada para o ponto de extremidade do serviço Web do Azure Machine Learning.

Name Type Description
dataType
  • string

O tipo de dados (com suporte do Azure Machine Learning) da coluna de entrada. Uma lista de tipos de dados válidos do Azure Machine Learning é descrita em https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .

mapTo
  • integer

O índice baseado em zero do parâmetro de função para o qual essa entrada é mapeada.

name
  • string

Nome da coluna de entrada.

AzureMachineLearningWebServiceInputs

As entradas para o ponto de extremidade do serviço Web do Azure Machine Learning.

Name Type Description
columnNames

Uma lista de colunas de entrada para o ponto de extremidade do serviço Web do Azure Machine Learning.

name
  • string

Nome da entrada. Esse é o nome fornecido durante a criação do ponto de extremidade.

AzureMachineLearningWebServiceOutputColumn

Descreve uma coluna de saída para o ponto de extremidade do serviço Web do Azure Machine Learning.

Name Type Description
dataType
  • string

O tipo de dados (com suporte do Azure Machine Learning) da coluna de saída. Uma lista de tipos de dados válidos do Azure Machine Learning é descrita em https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .

name
  • string

Nome da coluna de saída.

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).

AzureSqlReferenceInputDataSource

Descreve uma fonte de dados de referência de banco de dados SQL do Azure.

Name Type Description
properties.database
  • string

Este elemento é associado ao elemento datasource. Esse é o nome do banco de dados no qual a saída será gravada.

properties.deltaSnapshotQuery
  • string

Este elemento é associado ao elemento datasource. Essa consulta é usada para buscar alterações incrementais do banco de dados SQL. Para usar essa opção, recomendamos o uso de tabelas temporais no Banco de Dados SQL do Azure.

properties.fullSnapshotQuery
  • string

Este elemento é associado ao elemento datasource. Essa consulta é usada para buscar dados do banco de dados sql.

properties.password
  • string

Este elemento é associado ao elemento datasource. Essa é a senha que será usada para se conectar à instância do banco de dados SQL.

properties.refreshRate
  • string

Este elemento é associado ao elemento datasource. Isso indica com que frequência os dados serão buscados do banco de dados. É do formato DateTime.

properties.refreshType

Indica o tipo de opção de atualização de dados.

properties.server
  • string

Este elemento é associado ao elemento datasource. Esse é o nome do servidor que contém o banco de dados no qual será gravado.

properties.table
  • string

Este elemento é associado ao elemento datasource. O nome da tabela no banco de dados SQL do Azure..

properties.user
  • string

Este elemento é associado ao elemento datasource. Esse é o nome de usuário que será usado para se conectar à instância do banco de dados SQL.

type string:
  • Microsoft.Sql/Server/Database

Indica o tipo de fonte de dados de entrada que contém dados de referência. 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 da conta do 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 para a 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 do blob. Não é uma expressão regular. Ele representa um padrão no 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. 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 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 tempo.

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).

BlobReferenceInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de referência.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de autenticação.

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 tempo.

type string:
  • Microsoft.Storage/Blob

Indica o tipo de fonte de dados de entrada que contém dados de referência. Obrigatório em solicitações PUT (CreateOrReplace).

BlobStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Name Type Default Value Description
properties.authenticationMode ConnectionString

Modo de Autenticação.

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.sourcePartitionCount
  • integer

A contagem de partições da fonte de dados de entrada de blob. Intervalo 1 a 1024.

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 o tipo de fonte de dados de entrada que contém dados de fluxo. Obrigatório em solicitações PUT (CreateOrReplace).

ClusterInfo

As propriedades associadas a um cluster do Stream Analytics.

Name Type Description
id
  • string

A ID do recurso do cluster.

CompatibilityLevel

Controla determinados comportamentos de runtime do trabalho de streaming.

Name Type Description
1.0
  • string
1.2
  • string

Compression

Descreve como os dados de entrada são compactados

Name Type Default Value Description
type None

Indica o tipo de compactação que a entrada usa. Obrigatório em solicitações PUT (CreateOrReplace).

CompressionType

Indica o tipo de compactação que a entrada usa. Obrigatório em solicitações PUT (CreateOrReplace).

Name Type Description
Deflate
  • string
GZip
  • string
None
  • string

ContentStoragePolicy

Os valores válidos são JobStorageAccount e SystemAccount. Se definido como JobStorageAccount, isso requer que o usuário também especifique a propriedade jobStorageAccount. .

Name Type Description
JobStorageAccount
  • string
SystemAccount
  • string

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

DiagnosticCondition

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

Name Type Description
code
  • string

O código de diagnóstico opaco.

message
  • string

A mensagem legível por humanos 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 deverá 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).

EventHubStreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

Name Type Default Value Description
authenticationMode ConnectionString

Modo de Autenticação.

properties.consumerGroupName
  • string

O nome de um Grupo de Consumidores do Hub de Eventos que deve ser usado para ler eventos do Hub de Eventos. Especificar nomes de grupos de consumidores distintos para várias entradas permite que cada uma dessas entradas receba os mesmos eventos do Hub de Eventos. Se não for especificada, a entrada usará o grupo de consumidores padrão do Hub de Eventos.

properties.eventHubName
  • string

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

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 o tipo de fonte de dados de entrada que contém dados de fluxo. 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).

EventHubV2StreamInputDataSource

Descreve uma fonte de dados de entrada do Hub de Eventos que contém dados de fluxo.

Name Type Default Value Description
authenticationMode ConnectionString

Modo de Autenticação.

properties.consumerGroupName
  • string

O nome de um Grupo de Consumidores do Hub de Eventos que deve ser usado para ler eventos do Hub de Eventos. Especificar nomes de grupos de consumidores distintos para várias entradas permite que cada uma dessas entradas receba os mesmos eventos do Hub de Eventos. Se não for especificada, a entrada usará o grupo de consumidores padrão do Hub de Eventos.

properties.eventHubName
  • string

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

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 o tipo de fonte de dados de entrada que contém dados de fluxo. 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

EventsOutOfOrderPolicy

Indica a política a ser aplicada aos eventos que chegam fora de ordem no fluxo de eventos de entrada.

Name Type Description
Adjust
  • string
Drop
  • string

FileReferenceInputDataSource

Descreve uma fonte de dados de entrada de arquivo que contém dados de referência.

Name Type Description
properties.path
  • string

O caminho do arquivo.

type string:
  • File

Indica o tipo de fonte de dados de entrada que contém dados de referência. Obrigatório em solicitações PUT (CreateOrReplace).

Function

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

Name Type Description
id
  • string

ID do recurso

name
  • string

Nome do recurso

properties FunctionProperties:

As propriedades associadas a uma função.

type
  • string

Tipo de recurso

FunctionInput

Descreve um parâmetro de entrada de uma função.

Name Type Description
dataType
  • string

O tipo de dados (com suporte do Azure Stream Analytics) do parâmetro de entrada da função. Uma lista de tipos de dados válidos do Azure Stream Analytics é descrita em https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

isConfigurationParameter
  • boolean

Um sinalizador que indica se o parâmetro é um parâmetro de configuração. True se esse parâmetro de entrada deve ser uma constante. O padrão é false.

FunctionOutput

Descreve a saída de uma função.

Name Type Description
dataType
  • string

O tipo de dados (com suporte do Azure Stream Analytics) da saída da função. Uma lista de tipos de dados válidos do Azure Stream Analytics é descrita em https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

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).

GatewayMessageBusStreamInputDataSource

Descreve uma fonte de dados de entrada de blob que contém dados de fluxo.

Name Type Description
properties.topic
  • string

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

type string:
  • GatewayMessageBus

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Obrigatório em solicitações PUT (CreateOrReplace).

Identity

Descreve como a identidade é verificada

Name Type Description
principalId
  • string

A ID da entidade de identidade

tenantId
  • string

The identity tenantId

type
  • string

O tipo de identidade

Input

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

Name Type Description
id
  • string

ID do recurso

name
  • string

Nome do recurso

properties InputProperties:

As propriedades associadas a uma entrada. Obrigatório em solicitações PUT (CreateOrReplace).

type
  • string

Tipo de recurso

IoTHubStreamInputDataSource

Descreve uma fonte de dados de entrada Hub IoT que contém dados de fluxo.

Name Type Description
properties.consumerGroupName
  • string

O nome de um grupo de consumidores Hub IoT que deve ser usado para ler eventos do Hub IoT. Se não for especificada, a entrada usará o grupo de consumidores padrão do Hub Iot.

properties.endpoint
  • string

O ponto de extremidade Hub IoT para se conectar (ou seja, mensagens/eventos, mensagens/operationsMonitoringEvents etc.).

properties.iotHubNamespace
  • string

O nome ou o URI do Hub IoT. 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 IoT. Essa política deve conter pelo menos a permissão de conexão de serviço. Obrigatório em solicitações PUT (CreateOrReplace).

type string:
  • Microsoft.Devices/IotHubs

Indica o tipo de fonte de dados de entrada que contém dados de fluxo. Obrigatório em solicitações PUT (CreateOrReplace).

JavaScriptFunctionBinding

A associação a uma função JavaScript.

Name Type Description
properties.script
  • string

O código JavaScript que contém uma única definição de função. Por exemplo: 'function (x, y) { return x + y; }'

type string:
  • Microsoft.StreamAnalytics/JavascriptUdf

Indica o tipo de associação de função.

JobStorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure com MSI

Name Type Default Value Description
accountKey
  • string

A chave da conta do 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).

authenticationMode ConnectionString

Modo de autenticação.

JobType

Descreve o tipo do trabalho. Os modos válidos são Cloud e 'Edge'.

Name Type Description
Cloud
  • string
Edge
  • string

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 em que a saída será gravada. Os valores atualmente compatíveis são 'lineSeparated' indicando que a saída será formatada por ter 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 padrão será 'lineSeparated' se for nulo à esquerda.

type string:
  • Json

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

Output

Um objeto de saída, contendo 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

OutputErrorPolicy

Indica a política a ser aplicada aos eventos que chegam à saída e não podem ser gravados no armazenamento externo por estarem malformados (faltando valores de coluna, valores de coluna de tipo ou tamanho incorreto).

Name Type Description
Drop
  • string
Stop
  • string

OutputStartMode

O valor pode ser JobStartTime, CustomTime ou LastOutputEventTime para indicar se o ponto de partida do fluxo de eventos de saída deve ser iniciado sempre que o trabalho for iniciado, iniciar em um carimbo de data/hora do usuário personalizado especificado por meio da propriedade outputStartTime ou iniciar a partir da hora de saída do último evento.

Name Type Description
CustomTime
  • string
JobStartTime
  • string
LastOutputEventTime
  • string

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 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).

ReferenceInputProperties

As propriedades associadas a uma entrada que contém dados de referência.

Name Type Description
compression

Descreve como os dados de entrada são compactados

datasource ReferenceInputDataSource:

Descreve uma fonte de dados de entrada que contém dados de referência. Obrigatório em solicitações PUT (CreateOrReplace).

diagnostics

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

etag
  • string

A marca de entidade atual para a entrada. 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.

partitionKey
  • string

partitionKey Descreve uma chave nos dados de entrada que é usada para particionar os dados de entrada

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).

type string:
  • Reference

Indica se a entrada é uma fonte de dados de referência ou dados de fluxo. Obrigatório em solicitações PUT (CreateOrReplace).

RefreshType

Indica o tipo de opção de atualização de dados.

Name Type Description
RefreshPeriodicallyWithDelta
  • string
RefreshPeriodicallyWithFull
  • string
Static
  • string

ScalarFunctionProperties

As propriedades associadas a uma função escalar.

Name Type Description
etag
  • string

A marca de entidade atual para a função. 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.binding FunctionBinding:

A associação física da função. Por exemplo, no caso do serviço Web do Azure Machine Learning, isso descreve o ponto de extremidade.

properties.inputs

Descreve um parâmetro de entrada de uma função.

properties.output

Descreve a saída de uma função.

type string:
  • Scalar

Indica o tipo de função.

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 seguintes propriedades do sistema 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 seguintes propriedades do sistema 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).

Sku

As propriedades associadas a uma SKU.

Name Type Description
name

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

SkuName

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

Name Type Description
Standard
  • string

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).

StreamingJob

Um objeto de trabalho de streaming que contém todas as informações associadas ao trabalho de streaming nomeado.

Name Type Description
id
  • string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Descreve a identidade gerenciada atribuída pelo sistema atribuída a esse trabalho que pode ser usada para autenticar com entradas e saídas.

location
  • string

A localização geográfica em que o recurso reside

name
  • string

O nome do recurso

properties.cluster

O cluster no qual os trabalhos de streaming serão executados.

properties.compatibilityLevel

Controla determinados comportamentos de runtime do trabalho de streaming.

properties.contentStoragePolicy

Os valores válidos são JobStorageAccount e SystemAccount. Se definido como JobStorageAccount, isso requer que o usuário também especifique a propriedade jobStorageAccount. .

properties.createdDate
  • string

O valor é um carimbo de data/hora UTC formatado iso-8601 que indica quando o trabalho de streaming foi criado.

properties.dataLocale
  • string

A localidade de dados do trabalho do Stream Analytics. O valor deve ser o nome de uma cultura .NET com suporte do conjunto https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Se nenhuma for especificada, o padrão será 'en-US'.

properties.etag
  • string

A marca de entidade atual para o trabalho de streaming. 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.eventsLateArrivalMaxDelayInSeconds
  • integer

O atraso máximo tolerável em segundos em que os eventos que chegam atrasados podem ser incluídos. O intervalo com suporte é de -1 a 1814399 (20.23:59:59 dias) e -1 é usado para especificar a espera indefinidamente. Se a propriedade estiver ausente, ela será interpretada como tendo um valor de -1.

properties.eventsOutOfOrderMaxDelayInSeconds
  • integer

O atraso máximo tolerável em segundos em que os eventos fora de ordem podem ser ajustados para voltar à ordem.

properties.eventsOutOfOrderPolicy

Indica a política a ser aplicada aos eventos que chegam fora de ordem no fluxo de eventos de entrada.

properties.functions

Uma lista de uma ou mais funções para o trabalho de streaming. A propriedade name para cada função é necessária ao especificar essa propriedade em uma solicitação PUT. Essa propriedade não pode ser modificada por meio de uma operação PATCH. Você deve usar a API PATCH disponível para a transformação individual.

properties.inputs

Uma lista de uma ou mais entradas para o trabalho de streaming. A propriedade name para cada entrada é necessária ao especificar essa propriedade em uma solicitação PUT. Essa propriedade não pode ser modificada por meio de uma operação PATCH. Você deve usar a API PATCH disponível para a entrada individual.

properties.jobId
  • string

Um GUID que identifica exclusivamente o trabalho de streaming. Esse GUID é gerado após a criação do trabalho de streaming.

properties.jobState
  • string

Descreve o estado do trabalho de streaming.

properties.jobStorageAccount

As propriedades associadas a uma conta de Armazenamento do Azure com MSI

properties.jobType

Descreve o tipo do trabalho. Os modos válidos são Cloud e 'Edge'.

properties.lastOutputEventTime
  • string

O valor é um carimbo de data/hora formatado ISO-8601 que indica a hora do último evento de saída do trabalho de streaming ou nulo indicando que a saída ainda não foi produzida. No caso de várias saídas ou vários fluxos, isso mostra o valor mais recente nesse conjunto.

properties.outputErrorPolicy

Indica a política a ser aplicada aos eventos que chegam à saída e não podem ser gravados no armazenamento externo por estarem malformados (faltando valores de coluna, valores de coluna de tipo ou tamanho incorreto).

properties.outputStartMode

Essa propriedade só deve ser utilizada quando desejar que o trabalho seja iniciado imediatamente após a criação. O valor pode ser JobStartTime, CustomTime ou LastOutputEventTime para indicar se o ponto de partida do fluxo de eventos de saída deve ser iniciado sempre que o trabalho for iniciado, iniciar em um carimbo de data/hora do usuário personalizado especificado por meio da propriedade outputStartTime ou iniciar a partir da hora de saída do último evento.

properties.outputStartTime
  • string

O valor é um carimbo de hora formatados com o ISO 8601 que indica o ponto de partida do fluxo de eventos de saída ou nulo para indicar que o fluxo de eventos de saída será iniciado sempre que o trabalho de streaming for iniciado. Essa propriedade deve ter um valor se outputStartMode estiver definido como CustomTime.

properties.outputs

Uma lista de uma ou mais saídas para o trabalho de streaming. A propriedade name para cada saída é necessária ao especificar essa propriedade em uma solicitação PUT. Essa propriedade não pode ser modificada por meio de uma operação PATCH. Você deve usar a API PATCH disponível para a saída individual.

properties.provisioningState
  • string

Descreve o status de provisionamento do trabalho de streaming.

properties.sku

Descreve a SKU do trabalho de streaming. Obrigatório em solicitações PUT (CreateOrReplace).

properties.transformation

Indica a consulta e o número de unidades de streaming a serem usadas para o trabalho de streaming. A propriedade name da transformação é necessária ao especificar essa propriedade em uma solicitação PUT. Essa propriedade não pode ser modificada por meio de uma operação PATCH. Você deve usar a API PATCH disponível para a transformação individual.

tags
  • object

Marcas de recurso.

type
  • string

Tipo do recurso. Ex- Microsoft.Compute/virtualMachines ou Microsoft.Storage/storageAccounts.

StreamInputProperties

As propriedades associadas a uma entrada que contém dados de fluxo.

Name Type Description
compression

Descreve como os dados de entrada são compactados

datasource StreamInputDataSource:

Descreve uma fonte de dados de entrada que contém dados de fluxo. Obrigatório em solicitações PUT (CreateOrReplace).

diagnostics

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

etag
  • string

A marca de entidade atual para a entrada. 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.

partitionKey
  • string

partitionKey Descreve uma chave nos dados de entrada que é usada para particionar os dados de entrada

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).

type string:
  • Stream

Indica se a entrada é uma fonte de dados de referência ou dados de fluxo. Obrigatório em solicitações PUT (CreateOrReplace).

Transformation

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

Name Type Default Value Description
id
  • string

ID do recurso

name
  • string

Nome do recurso

properties.etag
  • string

A marca de entidade atual para a transformação. 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.query
  • string

Especifica a consulta que será executada no trabalho de streaming. Você pode saber mais sobre a SAQL (Linguagem de Consulta do Stream Analytics) aqui: https://msdn.microsoft.com/library/azure/dn834998 . Obrigatório em solicitações PUT (CreateOrReplace).

properties.streamingUnits
  • integer
3

Especifica o número de unidades de streaming que usa o trabalho de streaming.

properties.validStreamingUnits
  • integer[]

Especifica as unidades de streaming válidas para as quais um trabalho de streaming pode ser dimensionado.

type
  • string

Tipo de recurso