az stream-analytics function

Note

This reference is part of the stream-analytics extension for the Azure CLI (version 2.15.0 or higher). La extensión instalará automáticamente la primera vez que ejecute un comando az stream-analytics function. Learn more about extensions.

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.	Extension	GA
az stream-analytics function delete	Elimine una función del trabajo de streaming.	Extension	GA
az stream-analytics function inspect	Recupere la definición predeterminada de una función en función de los parámetros especificados.	Extension	GA
az stream-analytics function list	Enumere todas las funciones en el trabajo de streaming especificado.	Extension	GA
az stream-analytics function show	Obtenga detalles sobre la función especificada.	Extension	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.	Extension	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.	Extension	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.	Extension	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 --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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az stream-analytics function delete

Elimine una función del trabajo de streaming.

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

Ejemplos

Eliminar una función

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

Parámetros requeridos

--function-name --name -n

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

No solicita confirmación.

Propiedad	Valor
Valor predeterminado:	False

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

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 --name
                                     --job-name
                                     --resource-group
                                     [--ml-properties]

Parámetros requeridos

--function-name --name -n

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 Request-Response ejecutar el punto de conexión 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.

Propiedad	Valor
Parameter group:	FunctionRetrieveDefaultDefinitionParameters Arguments

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az stream-analytics function show

Obtenga detalles sobre la función especificada.

az stream-analytics function show --function-name --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

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 del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Propiedad	Valor
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 del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

--properties

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

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	False

--custom

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

Propiedad	Valor
Parameter group:	Wait Condition Arguments

--deleted

Espere hasta que se elimine.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	False

--exists

Espere hasta que exista el recurso.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	False

--interval

Intervalo de sondeo en segundos.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	30

--timeout

Espera máxima en segundos.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	3600

--updated

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

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	False

Parámetros globales

--debug

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

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Output format.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--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 del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

Compartir vía

az stream-analytics function

Comandos

az stream-analytics function create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az stream-analytics function delete

Ejemplos

Parámetros requeridos

Parámetros opcionales

az stream-analytics function inspect

Parámetros requeridos

Parámetros opcionales

az stream-analytics function list

Ejemplos

Parámetros requeridos

Parámetros opcionales

az stream-analytics function show

Ejemplos

Parámetros requeridos

az stream-analytics function test

Ejemplos

Parámetros requeridos

Parámetros opcionales

az stream-analytics function update

Ejemplos

Parámetros requeridos

Parámetros opcionales

az stream-analytics function wait

Ejemplos

Parámetros requeridos

Parámetros opcionales

Comentarios