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 instalará automaticamente a primeira vez que você executar um comando função az stream-analytics comando. Saiba mais sobre extensões.
Gerenciar função com análise de fluxo.
Comandos
| Nome | 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 | GA |
| az stream-analytics function delete |
Exclua uma função do trabalho de streaming. |
Extension | GA |
| az stream-analytics function inspect |
Recupere a definição padrão de uma função com base nos parâmetros especificados. |
Extension | GA |
| az stream-analytics function list |
Liste todas as funções no trabalho de streaming especificado. |
Extension | GA |
| az stream-analytics function show |
Obtenha detalhes sobre a função especificada. |
Extension | GA |
| az stream-analytics function test |
Teste se as informações fornecidas para uma função são válidas. Isso pode variar de testar a conexão com o serviço Web subjacente por trás da função ou certificar-se de que o código de função fornecido esteja sintaticamente correto. |
Extension | GA |
| 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 restante da definição de função ou trabalho. |
Extension | GA |
| 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 | GA |
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 Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
A ETag da função. Omita esse valor para sempre substituir a função atual. Especifique o valor de ETag visto pela última vez para impedir 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 de pré-condição 412.
As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 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
Excluir uma função
az stream-analytics function delete --name "function8197" --job-name "sj8653" --resource-group "sjrg1637"
Parâmetros Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 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 Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
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 de execução: 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/stream-analytics/machine-learning-udf.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | FunctionRetrieveDefaultDefinitionParameters Arguments |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 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 Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
O parâmetro de consulta OData $select. Esta é uma lista separada por vírgulas de propriedades estruturais a serem incluídas na resposta ou "" para incluir todas as propriedades. Por padrão, todas as propriedades são retornadas, exceto o diagnóstico. Atualmente, aceita apenas '' como um valor válido.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 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 Exigidos
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 Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az stream-analytics function test
Teste se as informações fornecidas para uma função são válidas. Isso pode variar de testar a conexão com o serviço Web subjacente por trás da função ou certificar-se de que o código de função fornecido esteja 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 Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
Não aguarde a conclusão da operação de execução prolongada.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
As propriedades associadas a uma função. Valor esperado: json-string/json-file/@json-file.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 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 restante da definição de função ou trabalho.
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 Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
A ETag da função. Omita esse valor para sempre substituir a função atual. Especifique o valor de ETag visto pela última vez para impedir 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 Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | 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 de script da 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 Exigidos
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 se tornar obrigatórios para que o comando seja executado com sucesso.
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
Aguarde até que a condição atenda 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 |
| Valor padrão: | False |
Aguarde até que o recurso exista.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
Intervalo de sondagem em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | 30 |
Espera máxima em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | 3600 |
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Valor padrão: | False |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |