az iot ops dataflowgraph

Note

Questo riferimento fa parte dell'estensione azure-iot-ops per l'interfaccia della riga di comando di Azure (versione 2.70.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot ops dataflowgraph . Altre informazioni sulle estensioni.

Gestione di DataflowGraph.

Comandi

Nome Descrizione Tipo Status
az iot ops dataflowgraph apply

Creare o sostituire un dataflowGraph associato a un profilo del flusso di dati.

Estensione GA
az iot ops dataflowgraph delete

Eliminare un dataflowGraph associato a un profilo del flusso di dati.

Estensione GA
az iot ops dataflowgraph list

Elencare dataflowGraphs associati a un profilo del flusso di dati.

Estensione GA
az iot ops dataflowgraph show

Mostra i dettagli di un dataflowGraph associato a un profilo del flusso di dati.

Estensione GA

az iot ops dataflowgraph apply

Creare o sostituire un dataflowGraph associato a un profilo del flusso di dati.

Di seguito è riportato un esempio del formato di file di configurazione:

{
  "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'esempio precedente definisce un grafo con un'origine MQTT che scorre attraverso un nodo di elaborazione Graph che consente di visualizzare una destinazione Kafka e una destinazione OpenTelemetry. I nodi del grafo fanno riferimento a un artefatto (formato: <name>:<version>) da un endpoint del Registro di sistema. L'esempio precedente include graphSettings.configuration solo per illustrare il formato quando un artefatto richiede parametri di configurazione; in tal caso, specificarli come elenco di coppie di stringhe {"key", "value"}. Omettere completamente graphSettings.configuration quando non è necessaria alcuna configurazione. I nodeType supportati sono: Origine, Destinazione e Grafico. I grafici del flusso di dati supportano solo endpoint MQTT, Kafka e OpenTelemetry. Il file può anche essere il wrapper completo delle risorse ARM (le proprietà vengono estratte automaticamente). extendedLocation viene sempre popolato automaticamente da --instance e -g e non deve essere incluso nel file.

Se usato con applica il contenuto precedente, verrà creata o sostituita una risorsa DataflowGraph di destinazione.

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

Esempio

Creare o sostituire un dataflowGraph 'mygraph' associato a un profilo 'myprofile' usando un file di configurazione.

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

Parametri necessari

--config-file

Percorso di un file JSON contenente le proprietà del dataflowgraph.

Proprietà Valore
Gruppo di parametri: Config Arguments
--instance -i

Nome dell'istanza di IoT Operations.

--name -n

Nome dataflowGraph.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--profile -p

Nome del profilo del flusso di dati. Impostazione predefinita: 'default'.

Proprietà Valore
Valore predefinito: default
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops dataflowgraph delete

Eliminare un dataflowGraph associato a un profilo del flusso di dati.

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

Esempio

Eliminare un dataflowGraph 'mygraph' associato a un profilo 'myprofile'.

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

Eliminare un dataflowGraph 'mygraph' senza una richiesta di conferma.

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

Parametri necessari

--instance -i

Nome dell'istanza di IoT Operations.

--name -n

Nome dataflowGraph.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--profile -p

Nome del profilo del flusso di dati. Impostazione predefinita: 'default'.

Proprietà Valore
Valore predefinito: default
--yes -y

Confermare [y]es senza una richiesta. Utile per scenari di integrazione continua e automazione.

Proprietà Valore
Valori accettati: false, true
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops dataflowgraph list

Elencare dataflowGraphs associati a un profilo del flusso di dati.

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

Esempio

Enumerare dataflowGraphs associati al profilo "myprofile".

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

Parametri necessari

--instance -i

Nome dell'istanza di IoT Operations.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--profile -p

Nome del profilo del flusso di dati. Impostazione predefinita: 'default'.

Proprietà Valore
Valore predefinito: default
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops dataflowgraph show

Mostra i dettagli di un dataflowGraph associato a un profilo del flusso di dati.

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

Esempio

Mostra i dettagli di un dataflowGraph 'mygraph' associato a un profilo 'myprofile'.

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

Parametri necessari

--instance -i

Nome dell'istanza di IoT Operations.

--name -n

Nome dataflowGraph.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--profile -p

Nome del profilo del flusso di dati. Impostazione predefinita: 'default'.

Proprietà Valore
Valore predefinito: default
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False