az iot ops dataflowgraph

Note

Cette référence fait partie de l’extension azure-iot-ops pour la Azure CLI (version 2.70.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az iot ops dataflowgraph . Apprenez-en davantage sur les extensions.

Gestion de DataflowGraph.

Commandes

Nom Description Type État
az iot ops dataflowgraph apply

Créez ou remplacez un DataflowGraph associé à un profil de flux de données.

Extension GA
az iot ops dataflowgraph delete

Supprimez un DataflowGraph associé à un profil de flux de données.

Extension GA
az iot ops dataflowgraph list

Répertorier les dataflowGraphs associés à un profil de flux de données.

Extension GA
az iot ops dataflowgraph show

Afficher les détails d’un DataflowGraph associé à un profil de flux de données.

Extension GA

az iot ops dataflowgraph apply

Créez ou remplacez un DataflowGraph associé à un profil de flux de données.

Voici un exemple de format de fichier de configuration :

{
  "mode": "Enabled",
  "nodes": [
    {
      "name": "source-mqtt",
      "nodeType": "Source",
      "sourceSettings": {
        "endpointRef": "default-broker",
        "dataSources": ["sensors/temperature/#"]
      }
    },
    {
      "name": "dest-broker",
      "nodeType": "Destination",
      "destinationSettings": {
        "endpointRef": "my-kafka-endpoint",
        "dataDestination": "telemetry/temperature"
      }
    },
    {
      "name": "dest-otel",
      "nodeType": "Destination",
      "destinationSettings": {
        "endpointRef": "my-otel-endpoint",
        "dataDestination": "telemetry/all"
      }
    },
    {
      "name": "graph-processor",
      "nodeType": "Graph",
      "graphSettings": {
        "registryEndpointRef": "my-registry-endpoint",
        "artifact": "my-processing-module:1.0.0",
        "configuration": [
          { "key": "paramName", "value": "paramValue" },
          { "key": "anotherParam", "value": "anotherValue" }
        ]
      }
    }
  ],
  "nodeConnections": [
    { "from": { "name": "source-mqtt" }, "to": { "name": "graph-processor" } },
    { "from": { "name": "graph-processor" }, "to": { "name": "dest-broker" } },
    { "from": { "name": "graph-processor" }, "to": { "name": "dest-otel" } }
  ]
}

L’exemple ci-dessus définit un graphique avec une source MQTT qui transite par un nœud de traitement Graph qui se déplace vers une destination Kafka et une destination OpenTelemetry. Les nœuds de graphique font référence à un artefact (format : <name>:<version>) à partir d’un point de terminaison de Registre. L’exemple ci-dessus inclut graphSettings.configuration uniquement pour illustrer le format lorsqu’un artefact nécessite des paramètres de configuration ; dans ce cas, fournissez-les sous la forme d’une liste de paires de chaînes {"key », « value"}. Omettez entièrement graphSettings.configuration quand aucune configuration n’est nécessaire. Les nodeTypes pris en charge sont : Source, Destination et Graph. Les graphiques de flux de données prennent uniquement en charge les points de terminaison MQTT, Kafka et OpenTelemetry. Le fichier peut également être le wrapper de ressources ARM complet (les propriétés sont extraites automatiquement). extendedLocation est toujours renseigné automatiquement à partir de --instance et -g et ne doit pas être inclus dans le fichier.

Lorsqu’elle est utilisée avec l’application du contenu ci-dessus, crée ou remplace une ressource DataflowGraph cible.

az iot ops dataflowgraph apply --config-file
                               --instance
                               --name
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]
                               [--profile]

Exemples

Créez ou remplacez un DataflowGraph « mygraph » associé à un profil « myprofile » à l’aide d’un fichier config.

az iot ops dataflowgraph apply -n mygraph -p myprofile -i myinstance -g myresourcegroup --config-file /path/to/graph/config.json

Paramètres obligatoires

--config-file

Chemin d’accès à un fichier JSON contenant les propriétés du dataflowgraph.

Propriété Valeur
Groupe de paramètres: Config Arguments
--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom dataflowGraph.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--profile -p

Nom du profil de flux de données. Valeur par défaut : « default ».

Propriété Valeur
Valeur par défaut: default
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot ops dataflowgraph delete

Supprimez un DataflowGraph associé à un profil de flux de données.

az iot ops dataflowgraph delete --instance
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--profile]
                                [--yes {false, true}]

Exemples

Supprimez un DataflowGraph « mygraph » associé à un profil « myprofile ».

az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup

Supprimez un dataflowGraph « mygraph » sans invite de confirmation.

az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup -y

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom dataflowGraph.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--acquire-policy-token

Acquisition automatique d’un jeton Azure Policy pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--change-reference

ID de référence de modification associé pour cette opération de ressource.

Propriété Valeur
Groupe de paramètres: Global Policy Arguments
--profile -p

Nom du profil de flux de données. Valeur par défaut : « default ».

Propriété Valeur
Valeur par défaut: default
--yes -y

Confirmez [y]es sans invite. Utile pour les scénarios CI et Automation.

Propriété Valeur
Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot ops dataflowgraph list

Répertorier les dataflowGraphs associés à un profil de flux de données.

az iot ops dataflowgraph list --instance
                              --resource-group
                              [--profile]

Exemples

Énumérez les dataflowGraphs associés au profil « myprofile ».

az iot ops dataflowgraph list -p myprofile -i mycluster-ops-instance -g myresourcegroup

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--profile -p

Nom du profil de flux de données. Valeur par défaut : « default ».

Propriété Valeur
Valeur par défaut: default
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot ops dataflowgraph show

Afficher les détails d’un DataflowGraph associé à un profil de flux de données.

az iot ops dataflowgraph show --instance
                              --name
                              --resource-group
                              [--profile]

Exemples

Affichez les détails d’un DataflowGraph « mygraph » associé à un profil « myprofile ».

az iot ops dataflowgraph show -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup

Paramètres obligatoires

--instance -i

Nom de l’instance Des opérations IoT.

--name -n

Nom dataflowGraph.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--profile -p

Nom du profil de flux de données. Valeur par défaut : « default ».

Propriété Valeur
Valeur par défaut: default
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False