az stream-analytics function
Note
Essa referência faz parte da extensão de análise de fluxo para a CLI do Azure (versão 2.75.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar uma função az stream-analytics. Saiba mais sobre extensões.
Gerencie a função com análise de fluxo.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az stream-analytics function create |
Crie uma função ou substitua uma função já existente em um trabalho de streaming existente. |
Extension | disponibilidade geral |
| az stream-analytics function delete |
Exclua uma função do trabalho de streaming. |
Extension | disponibilidade geral |
| az stream-analytics function inspect |
Recupere a definição padrão de uma função com base nos parâmetros especificados. |
Extension | disponibilidade geral |
| az stream-analytics function list |
Liste todas as funções no trabalho de streaming especificado. |
Extension | disponibilidade geral |
| az stream-analytics function show |
Obtenha detalhes sobre a função especificada. |
Extension | 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. |
Extension | 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. |
Extension | 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. |
Extension | 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 --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
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
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.
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.
As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az stream-analytics function delete
Exclua uma função do trabalho de streaming.
az stream-analytics function delete --function-name --name
--job-name
--resource-group
[--yes]
Exemplos
Eliminar uma função
az stream-analytics function delete --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
Parâmetros Obrigatórios
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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 --name
--job-name
--resource-group
[--ml-properties]
Parâmetros Obrigatórios
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
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
ponto de extremidade execute: o ponto de extremidade Request-Response execute do serviço Web do Azure Machine Learning. Saiba mais aqui: https://docs.microsoft.com/en-us/azure/stream-analytics/machine-learning-udf.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | FunctionRetrieveDefaultDefinitionParameters Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
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
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az stream-analytics function show
Obtenha detalhes sobre a função especificada.
az stream-analytics function show --function-name --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
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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 --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
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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 --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
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
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.
As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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 --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
O nome da função.
O nome do trabalho de streaming.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
Aguarde até ser excluído.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Aguarde até que o recurso exista.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Intervalo de sondagem em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | 30 |
Espera máxima em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | 3600 |
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |