az stream-analytics function

Remarque

Cette référence fait partie de l’extension Stream-Analytics pour Azure CLI (version 2.15.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az stream-analytics function . En savoir plus sur les extensions.

Gérer la fonction avec Stream Analytics.

Commandes

Nom	Description	Type	Statut
az stream-analytics function create	Créez une fonction ou remplace une fonction déjà existante sous un travail de streaming existant.	Extension	GA
az stream-analytics function delete	Supprimez une fonction du travail de streaming.	Extension	GA
az stream-analytics function inspect	Récupérez la définition par défaut d’une fonction en fonction des paramètres spécifiés.	Extension	GA
az stream-analytics function list	Répertorier toutes les fonctions sous le travail de diffusion en continu spécifié.	Extension	GA
az stream-analytics function show	Obtenez des détails sur la fonction spécifiée.	Extension	GA
az stream-analytics function test	Testez si les informations fournies pour une fonction sont valides. Cela peut aller du test de la connexion au service web sous-jacent derrière la fonction ou de s’assurer que le code de fonction fourni est correctement synchronisé.	Extension	GA
az stream-analytics function update	Mettez à jour une fonction existante sous un travail de streaming existant. Cela peut être utilisé pour mettre à jour partiellement (par exemple, mettre à jour une ou deux propriétés) une fonction sans affecter le reste de la définition du travail ou de la fonction.	Extension	GA
az stream-analytics function wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de la fonction stream-analytics soit remplie.	Extension	GA

az stream-analytics function create

Créez une fonction ou remplace une fonction déjà existante sous un travail de streaming existant.

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

Exemples

Créer une fonction 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"

Créer une fonction 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"

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--if-match

ETag de la fonction. Omettez cette valeur pour toujours remplacer la fonction actuelle. Spécifiez la dernière valeur ETag vue pour empêcher le remplacement accidentel des modifications simultanées.

--if-none-match

Définissez la valeur « * » pour permettre la création d’une nouvelle fonction, mais pour empêcher la mise à jour d’une fonction existante. D’autres valeurs entraînent une réponse 412 en cas d’échec de la condition.

--properties

Propriétés associées à une fonction. Valeur attendue : json-string/json-file/@json-file.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function delete

Supprimez une fonction du travail de streaming.

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

Exemples

Supprimer une fonction

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

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function inspect

Récupérez la définition par défaut d’une fonction en fonction des paramètres spécifiés.

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

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--ml-properties

Paramètres nécessaires pour récupérer la définition de fonction par défaut pour une fonction de service web Azure Machine Learning.

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

execute-endpoint : point de terminaison d’exécution demande-réponse du service web Azure Machine Learning. En savoir plus ici : https://docs.microsoft.com/en-us/azure/stream-analytics/machine-learning-udf.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function list

Répertorier toutes les fonctions sous le travail de diffusion en continu spécifié.

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

Exemples

Répertorier toutes les fonctions d’un travail de streaming

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

Paramètres obligatoires

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--select

Paramètre de requête OData $select. Il s’agit d’une liste séparée par des virgules des propriétés structurelles à inclure dans la réponse, ou « » pour inclure toutes les propriétés. Par défaut, toutes les propriétés sont retournées à l’exception des diagnostics. Actuellement, seule la valeur « » est acceptée.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function show

Obtenez des détails sur la fonction spécifiée.

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

Exemples

Obtenir une fonction JavaScript

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

Obtenir une fonction Azure ML

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

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function test

Testez si les informations fournies pour une fonction sont valides. Cela peut aller du test de la connexion au service web sous-jacent derrière la fonction ou de s’assurer que le code de fonction fourni est correctement synchronisé.

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

Exemples

Tester la connexion pour une fonction JavaScript

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

Tester la connexion pour une fonction Azure ML

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

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False

--properties

Propriétés associées à une fonction. Valeur attendue : json-string/json-file/@json-file.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function update

Mettez à jour une fonction existante sous un travail de streaming existant. Cela peut être utilisé pour mettre à jour partiellement (par exemple, mettre à jour une ou deux propriétés) une fonction sans affecter le reste de la définition du travail ou de la fonction.

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

Exemples

Mettre à jour une fonction 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"

Mettre à jour une fonction 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"

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--if-match

ETag de la fonction. Omettez cette valeur pour toujours remplacer la fonction actuelle. Spécifiez la dernière valeur ETag vue pour empêcher le remplacement accidentel des modifications simultanées.

--properties

Propriétés associées à une fonction. Valeur attendue : json-string/json-file/@json-file.

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az stream-analytics function wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de la fonction stream-analytics soit remplie.

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

Exemples

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que la fonction stream-analytics soit créée.

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

Paramètres obligatoires

--function-name --name -n

Nom de la fonction.

--job-name

Nom de la tâche de streaming.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False

--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False

--exists

Attendez que la ressource existe.

valeur par défaut: False

--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30

--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600

--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

valeur par défaut: False

Paramètres globaux

--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc

valeur par défaut: json

--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.