Partilhar via

az stream-analytics output

  • Referência

Nota

Essa referência faz parte da extensão de análise de fluxo para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando de saída az stream-analytics. Saiba mais sobre extensões.

Gerencie a saída com análise de fluxo.

Comandos

Name Description Tipo Status
az stream-analytics output create

Crie uma saída ou substitua uma saída já existente em um trabalho de streaming existente.

 Extensão Disponibilidade Geral
az stream-analytics output delete

Exclua uma saída do trabalho de streaming.

 Extensão Disponibilidade Geral
az stream-analytics output list

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

 Extensão Disponibilidade Geral
az stream-analytics output show

Obtenha detalhes sobre a saída especificada.

 Extensão Disponibilidade Geral
az stream-analytics output test

Teste se a fonte de dados de uma saída é acessível e utilizável pelo serviço Azure Stream Analytics.

 Extensão Disponibilidade Geral
az stream-analytics output update

Atualize uma saída existente em um trabalho de streaming existente. Isso pode ser usado para atualizar parcialmente (ou seja, atualizar uma ou duas propriedades) uma saída sem afetar o restante do trabalho ou a definição de saída.

 Extensão Disponibilidade Geral
az stream-analytics output wait

Coloque a CLI em um estado de espera até que uma condição da saída do stream-analytics seja atendida.

 Extensão Disponibilidade Geral

az stream-analytics output create

Crie uma saída ou substitua uma saída já existente em um trabalho de streaming existente.

az stream-analytics output create --job-name
                                  --name
                                  --resource-group
                                  [--datasource]
                                  [--if-match]
                                  [--if-none-match]
                                  [--serialization]
                                  [--size-window]
                                  [--time-window]

Exemplos

Criar uma saída do Banco de Dados de Documentos

az stream-analytics output create --job-name "sj2331" --datasource "{\"type\":\"Microsoft.Storage/DocumentDB\",\"properties\":{\"accountId\":\"someAccountId\",\"accountKey\":\"accountKey==\",\"collectionNamePattern\":\"collection\",\"database\":\"db01\",\"documentId\":\"documentId\",\"partitionKey\":\"key\"}}" --output-name "output3022" --resource-group "sjrg7983"

Criar uma saída do Power BI

az stream-analytics output create --job-name "sj2331" --datasource "{\"type\":\"PowerBI\",\"properties\":{\"dataset\":\"someDataset\",\"groupId\":\"ac40305e-3e8d-43ac-8161-c33799f43e95\",\"groupName\":\"MyPowerBIGroup\",\"refreshToken\":\"someRefreshToken==\",\"table\":\"someTable\",\"tokenUserDisplayName\":\"Bob Smith\",\"tokenUserPrincipalName\":\"bobsmith@contoso.com\"}}" --output-name "output3022" --resource-group "sjrg7983"

Criar uma saída de fila do Service Bus com serialização Avro

az stream-analytics output create --job-name "sj5095" --datasource "{\"type\":\"Microsoft.ServiceBus/Queue\",\"properties\":{\"propertyColumns\":[\"column1\",\"column2\"],\"queueName\":\"sdkqueue\",\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\",\"systemPropertyColumns\":{\"MessageId\":\"col3\",\"PartitionKey\":\"col4\"}}}" --serialization "{\"type\":\"Avro\"}" --output-name "output3456" --resource-group "sjrg3410"

Criar uma saída de tópico do Service Bus com serialização CSV

az stream-analytics output create --job-name "sj7094" --datasource "{\"type\":\"Microsoft.ServiceBus/Topic\",\"properties\":{\"propertyColumns\":[\"column1\",\"column2\"],\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\",\"topicName\":\"sdktopic\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\",\"}}" --output-name "output7886" --resource-group "sjrg6450"

Criar uma saída de blob com serialização CSV

az stream-analytics output create --job-name "sj900" --datasource "{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"state\",\"dateFormat\":\"yyyy/MM/dd\",\"pathPattern\":\"{date}/{time}\",\"storageAccounts\":[{\"accountKey\":\"accountKey==\",\"accountName\":\"someAccountName\"}],\"timeFormat\":\"HH\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\",\"}}" --output-name "output1623" --resource-group "sjrg5023"

Criar uma saída do Repositório Azure Data Lake com serialização JSON

az stream-analytics output create --job-name "sj3310" --datasource "{\"type\":\"Microsoft.DataLake/Accounts\",\"properties\":{\"accountName\":\"someaccount\",\"dateFormat\":\"yyyy/MM/dd\",\"filePathPrefix\":\"{date}/{time}\",\"refreshToken\":\"someRefreshToken==\",\"tenantId\":\"cea4e98b-c798-49e7-8c40-4a2b3beb47dd\",\"timeFormat\":\"HH\",\"tokenUserDisplayName\":\"Bob Smith\",\"tokenUserPrincipalName\":\"bobsmith@contoso.com\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"Array\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

Criar uma saída do banco de dados SQL do Azure

az stream-analytics output create --job-name "sj6458" --datasource "{\"type\":\"Microsoft.Sql/Server/Database\",\"properties\":{\"database\":\"someDatabase\",\"password\":\"somePassword\",\"server\":\"someServer\",\"table\":\"someTable\",\"user\":\"<user>\"}}" --output-name "output1755" --resource-group "sjrg2157"

Criar uma saída da Tabela do Azure

az stream-analytics output create --job-name "sj2790" --datasource "{\"type\":\"Microsoft.Storage/Table\",\"properties\":{\"accountKey\":\"accountKey==\",\"accountName\":\"someAccountName\",\"batchSize\":25,\"columnsToRemove\":[\"column1\",\"column2\"],\"partitionKey\":\"partitionKey\",\"rowKey\":\"rowKey\",\"table\":\"samples\"}}" --output-name "output958" --resource-group "sjrg5176"

Criar uma saída do Hub de Eventos com serialização JSON

az stream-analytics output create --job-name "sj3310" --datasource "{\"type\":\"Microsoft.ServiceBus/EventHub\",\"properties\":{\"eventHubName\":\"sdkeventhub\",\"partitionKey\":\"partitionKey\",\"serviceBusNamespace\":\"sdktest\",\"sharedAccessPolicyKey\":\"sharedAccessPolicyKey=\",\"sharedAccessPolicyName\":\"RootManageSharedAccessKey\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"Array\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--name --output-name -n

O nome da saída.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--datasource

Descreve a fonte de dados na qual a saída será gravada. Necessário em solicitações PUT (CreateOrReplace). Valor esperado: json-string/json-file/@json-file.

--if-match

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

--if-none-match

Defina como '*' para permitir que uma nova saída seja criada, mas para impedir a atualização de uma saída existente. Outros valores resultarão em uma resposta com falha na pré-condição 412.

--serialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída. Necessário em solicitações PUT (CreateOrReplace). Valor esperado: json-string/json-file/@json-file.

--size-window

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

--time-window

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az stream-analytics output delete

Exclua uma saída do trabalho de streaming.

az stream-analytics output delete --job-name
                                  --name
                                  --resource-group
                                  [--yes]

Exemplos

Excluir uma saída

az stream-analytics output delete --job-name "sj6458" --name "output1755" --resource-group "sjrg2157"

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--name --output-name -n

O nome da saída.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--yes -y

Não solicite confirmação.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az stream-analytics output list

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

az stream-analytics output list --job-name
                                --resource-group
                                [--select]

Exemplos

Listar todas as saídas em um trabalho de streaming

az stream-analytics output list --job-name "sj6458" --resource-group "sjrg2157"

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--select

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az stream-analytics output show

Obtenha detalhes sobre a saída especificada.

az stream-analytics output show --job-name
                                --name
                                --resource-group

Exemplos

Obter uma saída do Banco de Dados de Documentos

az stream-analytics output show --job-name "sj2331" --output-name "output3022" --resource-group "sjrg7983"

Obter uma saída do Power BI

az stream-analytics output show --job-name "sj2331" --output-name "output3022" --resource-group "sjrg7983"

Obter uma saída de fila do Service Bus com serialização Avro

az stream-analytics output show --job-name "sj5095" --output-name "output3456" --resource-group "sjrg3410"

Obter uma saída de tópico do Service Bus com serialização CSV

az stream-analytics output show --job-name "sj7094" --output-name "output7886" --resource-group "sjrg6450"

Obter uma saída de blob com serialização CSV

az stream-analytics output show --job-name "sj900" --output-name "output1623" --resource-group "sjrg5023"

Obter uma saída do Repositório Azure Data Lake com serialização JSON

az stream-analytics output show --job-name "sj3310" --output-name "output5195" --resource-group "sjrg6912"

Obter uma saída do Azure Data Warehouse

az stream-analytics output show --job-name "sjName" --output-name "output958" --resource-group "sjrg"

Obter uma saída do banco de dados SQL do Azure

az stream-analytics output show --job-name "sj6458" --output-name "output1755" --resource-group "sjrg2157"

Obter uma saída da Tabela do Azure

az stream-analytics output show --job-name "sj2790" --output-name "output958" --resource-group "sjrg5176"

Obter uma saída do Hub de Eventos com serialização JSON

az stream-analytics output show --job-name "sj3310" --output-name "output5195" --resource-group "sjrg6912"

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--name --output-name -n

O nome da saída.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az stream-analytics output test

Teste se a fonte de dados de uma saída é acessível e utilizável pelo serviço Azure Stream Analytics.

az stream-analytics output test --job-name
                                --name
                                --resource-group
                                [--datasource]
                                [--no-wait]
                                [--serialization]
                                [--size-window]
                                [--time-window]

Exemplos

Testar a conexão para uma saída

az stream-analytics output test --job-name "sj6458" --output-name "output1755" --resource-group "sjrg2157"

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--name --output-name -n

O nome da saída.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--datasource

Descreve a fonte de dados na qual a saída será gravada. Necessário em solicitações PUT (CreateOrReplace). Valor esperado: json-string/json-file/@json-file.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--serialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída. Necessário em solicitações PUT (CreateOrReplace). Valor esperado: json-string/json-file/@json-file.

--size-window

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

--time-window

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az stream-analytics output update

Atualize uma saída existente em um trabalho de streaming existente. Isso pode ser usado para atualizar parcialmente (ou seja, atualizar uma ou duas propriedades) uma saída sem afetar o restante do trabalho ou a definição de saída.

az stream-analytics output update --job-name
                                  --name
                                  --resource-group
                                  [--datasource]
                                  [--if-match]
                                  [--serialization]
                                  [--size-window]
                                  [--time-window]

Exemplos

Atualizar uma saída do Banco de Dados de Documentos

az stream-analytics output update --job-name "sj2331" --datasource "{\"type\":\"Microsoft.Storage/DocumentDB\",\"properties\":{\"partitionKey\":\"differentPartitionKey\"}}" --output-name "output3022" --resource-group "sjrg7983"

Atualizar uma saída do Power BI

az stream-analytics output update --job-name "sj2331" --datasource "{\"type\":\"PowerBI\",\"properties\":{\"dataset\":\"differentDataset\"}}" --output-name "output3022" --resource-group "sjrg7983"

Atualizar uma saída de fila do Service Bus com serialização Avro

az stream-analytics output update --job-name "sj5095" --datasource "{\"type\":\"Microsoft.ServiceBus/Queue\",\"properties\":{\"queueName\":\"differentQueueName\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"LineSeparated\",\"encoding\":\"UTF8\"}}" --output-name "output3456" --resource-group "sjrg3410"

Atualizar uma saída de Tópico do Service Bus com serialização CSV

az stream-analytics output update --job-name "sj7094" --datasource "{\"type\":\"Microsoft.ServiceBus/Topic\",\"properties\":{\"topicName\":\"differentTopicName\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}" --output-name "output7886" --resource-group "sjrg6450"

Atualizar uma saída de blob com serialização CSV

az stream-analytics output update --job-name "sj900" --datasource "{\"type\":\"Microsoft.Storage/Blob\",\"properties\":{\"container\":\"differentContainer\"}}" --serialization "{\"type\":\"Csv\",\"properties\":{\"encoding\":\"UTF8\",\"fieldDelimiter\":\"|\"}}" --output-name "output1623" --resource-group "sjrg5023"

Atualizar uma saída do Repositório Azure Data Lake com serialização JSON

az stream-analytics output update --job-name "sj3310" --datasource "{\"type\":\"Microsoft.DataLake/Accounts\",\"properties\":{\"accountName\":\"differentaccount\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"LineSeparated\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

Atualizar uma saída do banco de dados SQL do Azure

az stream-analytics output update --job-name "sj6458" --datasource "{\"type\":\"Microsoft.Sql/Server/Database\",\"properties\":{\"table\":\"differentTable\"}}" --output-name "output1755" --resource-group "sjrg2157"

Atualizar uma saída da Tabela do Azure

az stream-analytics output update --job-name "sj2790" --datasource "{\"type\":\"Microsoft.Storage/Table\",\"properties\":{\"partitionKey\":\"differentPartitionKey\"}}" --output-name "output958" --resource-group "sjrg5176"

Atualizar uma saída do Hub de Eventos com serialização JSON

az stream-analytics output update --job-name "sj3310" --datasource "{\"type\":\"Microsoft.ServiceBus/EventHub\",\"properties\":{\"partitionKey\":\"differentPartitionKey\"}}" --serialization "{\"type\":\"Json\",\"properties\":{\"format\":\"LineSeparated\",\"encoding\":\"UTF8\"}}" --output-name "output5195" --resource-group "sjrg6912"

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--name --output-name -n

O nome da saída.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--datasource

Descreve a fonte de dados na qual a saída será gravada. Necessário em solicitações PUT (CreateOrReplace). Valor esperado: json-string/json-file/@json-file.

--if-match

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

--serialization

Descreve como os dados de uma entrada são serializados ou como os dados são serializados quando gravados em uma saída. Necessário em solicitações PUT (CreateOrReplace). Valor esperado: json-string/json-file/@json-file.

--size-window

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

--time-window

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az stream-analytics output wait

Coloque a CLI em um estado de espera até que uma condição da saída do stream-analytics seja atendida.

az stream-analytics output wait --job-name
                                --name
                                --resource-group
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--interval]
                                [--timeout]
                                [--updated]

Exemplos

Pause a execução da próxima linha do script CLI até que a saída do stream-analytics seja criada com êxito.

az stream-analytics output wait --job-name "sj3310" --output-name "output5195" --resource-group "sjrg6912" --created

Parâmetros Obrigatórios

--job-name

O nome do trabalho de streaming.

--name --output-name -n

O nome da saída.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Default value: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Default value: False
--exists

Aguarde até que o recurso exista.

Default value: False
--interval

Intervalo de sondagem em segundos.

Default value: 30
--timeout

Espera máxima em segundos.

Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.