Share via

az stream-analytics function

  • Referencia

Nota:

Esta referencia forma parte de la extensión stream-analytics para la CLI de Azure (versión 2.15.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az stream-analytics function . Obtenga más información sobre las extensiones.

Administración de la función con Stream Analytics.

Comandos

Nombre Description Tipo Estado
az stream-analytics function create

Cree una función o reemplace una función ya existente en un trabajo de streaming existente.

 Extensión GA
az stream-analytics function delete

Elimine una función del trabajo de streaming.

 Extensión GA
az stream-analytics function inspect

Recupere la definición predeterminada de una función en función de los parámetros especificados.

 Extensión GA
az stream-analytics function list

Enumere todas las funciones en el trabajo de streaming especificado.

 Extensión GA
az stream-analytics function show

Obtenga detalles sobre la función especificada.

 Extensión GA
az stream-analytics function test

Pruebe si la información proporcionada para una función es válida. Esto puede variar desde probar la conexión al servicio web subyacente detrás de la función o asegurarse de que el código de función proporcionado es sintácticamente correcto.

 Extensión GA
az stream-analytics function update

Actualice una función existente en un trabajo de streaming existente. Esto se puede usar para actualizar parcialmente (es decir, actualizar una o dos propiedades) una función sin afectar al resto de la definición de trabajo o función.

 Extensión GA
az stream-analytics function wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de la función stream-analytics.

 Extensión GA

az stream-analytics function create

Cree una función o reemplace una función ya existente en un trabajo de streaming existente.

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

Ejemplos

Creación de una función de 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"

Creación de una función de 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 requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--if-match

ETag de la función. Omita este valor para sobrescribir siempre la función actual. Especifique el valor de ETag visto por última vez para evitar que se sobrescriba accidentalmente los cambios simultáneos.

--if-none-match

Establézcalo en "*" para permitir que se cree una nueva función, pero para evitar la actualización de una función existente. Otros valores darán como resultado una respuesta con error de condición previa 412.

--properties

Propiedades asociadas a una función. Valor esperado: json-string/json-file/@json-file.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function delete

Elimine una función del trabajo de streaming.

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

Ejemplos

Eliminación de una función

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

Parámetros requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function inspect

Recupere la definición predeterminada de una función en función de los parámetros especificados.

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

Parámetros requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--ml-properties

Los parámetros necesarios para recuperar la definición de función predeterminada para una función de servicio web de Azure Machine Learning.

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

execute-endpoint: el punto de conexión de ejecución Request-Response del servicio web de Azure Machine Learning. Obtenga más información aquí: https://docs.microsoft.com/en-us/azure/stream-analytics/machine-learning-udf.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function list

Enumere todas las funciones en el trabajo de streaming especificado.

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

Ejemplos

Enumeración de todas las funciones de un trabajo de streaming

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

Parámetros requeridos

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--select

Parámetro de consulta $select OData. Se trata de una lista separada por comas de propiedades estructurales que se van a incluir en la respuesta o "" para incluir todas las propiedades. De forma predeterminada, se devuelven todas las propiedades excepto los diagnósticos. Actualmente solo acepta '' como un valor válido.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function show

Obtenga detalles sobre la función especificada.

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

Ejemplos

Obtención de una función de JavaScript

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

Obtención de una función de Azure ML

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

Parámetros requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function test

Pruebe si la información proporcionada para una función es válida. Esto puede variar desde probar la conexión al servicio web subyacente detrás de la función o asegurarse de que el código de función proporcionado es sintácticamente correcto.

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

Ejemplos

Prueba de la conexión de una función de JavaScript

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

Prueba de la conexión de una función de Azure ML

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

Parámetros requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valor predeterminado: False
--properties

Propiedades asociadas a una función. Valor esperado: json-string/json-file/@json-file.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function update

Actualice una función existente en un trabajo de streaming existente. Esto se puede usar para actualizar parcialmente (es decir, actualizar una o dos propiedades) una función sin afectar al resto de la definición de trabajo o función.

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

Ejemplos

Actualización de una función de 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"

Actualización de una función de 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 requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--if-match

ETag de la función. Omita este valor para sobrescribir siempre la función actual. Especifique el valor de ETag visto por última vez para evitar que se sobrescriba accidentalmente los cambios simultáneos.

--properties

Propiedades asociadas a una función. Valor esperado: json-string/json-file/@json-file.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az stream-analytics function wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de la función stream-analytics.

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

Ejemplos

Pause la ejecución de la siguiente línea de script de la CLI hasta que se cree correctamente la función stream-analytics.

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

Parámetros requeridos

--function-name --name -n

El nombre de la función.

--job-name

nombre del trabajo de streaming.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

valor predeterminado: False
--exists

Espere hasta que exista el recurso.

valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--timeout

Espera máxima en segundos.

valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.