az stream-analytics function

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 az stream-analytics function . Saiba mais sobre extensões.

Gerencie a função com análise de fluxo.

Comandos

Name	Description	Tipo	Estado
az stream-analytics function create	Crie uma função ou substitua uma função já existente em um trabalho de streaming existente.	Extensão	Disponibilidade Geral
az stream-analytics function delete	Exclua uma função do trabalho de streaming.	Extensão	Disponibilidade Geral
az stream-analytics function inspect	Recupere a definição padrão de uma função com base nos parâmetros especificados.	Extensão	Disponibilidade Geral
az stream-analytics function list	Liste todas as funções no trabalho de streaming especificado.	Extensão	Disponibilidade Geral
az stream-analytics function show	Obtenha detalhes sobre a função especificada.	Extensão	Disponibilidade Geral
az stream-analytics function test	Teste se as informações fornecidas para uma função são válidas. Isso pode variar desde testar a conexão com o serviço Web subjacente por trás da função ou certificar-se de que o código da função fornecido está sintaticamente correto.	Extensão	Disponibilidade Geral
az stream-analytics function update	Atualize uma função existente em um trabalho de streaming existente. Isso pode ser usado para atualizar parcialmente (ou seja, atualizar uma ou duas propriedades) uma função sem afetar o resto da definição de trabalho ou função.	Extensão	Disponibilidade Geral
az stream-analytics function wait	Coloque a CLI em um estado de espera até que uma condição da função de análise de fluxo seja atendida.	Extensão	Disponibilidade Geral

az stream-analytics function create

Crie uma função ou substitua uma função já existente em um trabalho de streaming existente.

az stream-analytics function create --function-name
                                    --job-name
                                    --resource-group
                                    [--if-match]
                                    [--if-none-match]
                                    [--properties]

Exemplos

Criar uma função JavaScript

az stream-analytics function create --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.StreamAnalytics/JavascriptUdf\",\"properties\":{\"script\":\"function (x, y) { return x + y; }\"}},\"inputs\":[{\"dataType\":\"Any\"}],\"output\":{\"dataType\":\"Any\"}}}" --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

Criar uma função do Azure ML

az stream-analytics function create --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.MachineLearning/WebService\",\"properties\":{\"apiKey\":\"someApiKey==\",\"batchSize\":1000,\"endpoint\":\"someAzureMLEndpointURL\",\"inputs\":{\"name\":\"input1\",\"columnNames\":[{\"name\":\"tweet\",\"dataType\":\"string\",\"mapTo\":0}]},\"outputs\":[{\"name\":\"Sentiment\",\"dataType\":\"string\"}]}},\"inputs\":[{\"dataType\":\"nvarchar(max)\"}],\"output\":{\"dataType\":\"nvarchar(max)\"}}}" --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

--if-match

O ETag da função. Omita esse valor para sempre substituir a função 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 função seja criada, mas para impedir a atualização de uma função existente. Outros valores resultarão em uma resposta com falha na pré-condição 412.

--properties

As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.

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

valor predefinido: 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 function delete

Exclua uma função do trabalho de streaming.

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

Exemplos

Excluir uma função

az stream-analytics function delete --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

--yes -y

Não solicite confirmação.

valor predefinido: 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

valor predefinido: 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 function inspect

Recupere a definição padrão de uma função com base nos parâmetros especificados.

az stream-analytics function inspect --function-name
                                     --job-name
                                     --resource-group
                                     [--ml-properties]

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

--ml-properties

Os parâmetros necessários para recuperar a definição de função padrão para uma função de serviço Web do Azure Machine Learning.

Uso: --ml-properties execute-endpoint=XX

execute-endpoint: O ponto de extremidade de execução Request-Response do serviço Web do Azure Machine Learning. Saiba mais aqui: https://docs.microsoft.com/en-us/azure/stream-analytics/machine-learning-udf.

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

valor predefinido: 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 function list

Liste todas as funções no trabalho de streaming especificado.

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

Exemplos

Listar todas as funções em um trabalho de streaming

az stream-analytics function list --job-name "sj8653" --resource-group "sjrg1637"

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

valor predefinido: 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 function show

Obtenha detalhes sobre a função especificada.

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

Exemplos

Obter uma função JavaScript

az stream-analytics function show --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

Obter uma função do Azure ML

az stream-analytics function show --name "function588" --job-name "sj9093" --resource-group "sjrg7"

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

valor predefinido: 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 function test

Teste se as informações fornecidas para uma função são válidas. Isso pode variar desde testar a conexão com o serviço Web subjacente por trás da função ou certificar-se de que o código da função fornecido está sintaticamente correto.

az stream-analytics function test --function-name
                                  --job-name
                                  --resource-group
                                  [--no-wait]
                                  [--properties]

Exemplos

Testar a conexão para uma função JavaScript

az stream-analytics function test --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

Testar a conexão para uma função do Azure ML

az stream-analytics function test --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

--no-wait

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

valor predefinido: False

--properties

As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.

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

valor predefinido: 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 function update

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

az stream-analytics function update --function-name
                                    --job-name
                                    --resource-group
                                    [--if-match]
                                    [--properties]

Exemplos

Atualizar uma função JavaScript

az stream-analytics function update --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.StreamAnalytics/JavascriptUdf\",\"properties\":{\"script\":\"function (a, b) { return a * b; }\"}}}}" --function-name "function8197" --job-name "sj8653" --resource-group "sjrg1637"

Atualizar uma função do Azure ML

az stream-analytics function update --properties "{\"type\":\"Scalar\",\"properties\":{\"binding\":{\"type\":\"Microsoft.MachineLearning/WebService\",\"properties\":{\"batchSize\":5000}}}}" --function-name "function588" --job-name "sj9093" --resource-group "sjrg7"

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

--if-match

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

--properties

As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.

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

valor predefinido: 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 function wait

Coloque a CLI em um estado de espera até que uma condição da função de análise de fluxo seja atendida.

az stream-analytics function wait --function-name
                                  --job-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 função stream-analytics seja criada com êxito.

az stream-analytics function wait --name "function588" --job-name "sj9093" --resource-group "sjrg7" --created

Parâmetros Obrigatórios

--function-name --name -n

O nome da função.

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

--created

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

valor predefinido: 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.

valor predefinido: False

--exists

Aguarde até que o recurso exista.

valor predefinido: False

--interval

Intervalo de sondagem em segundos.

valor predefinido: 30

--timeout

Espera máxima em segundos.

valor predefinido: 3600

--updated

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

valor predefinido: 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

valor predefinido: 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.