az iot ops dataflowgraph
Note
Diese Referenz ist Teil der Erweiterung azure-iot-ops für die Azure CLI (Version 2.70.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot ops dataflowgraph-Befehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.
DataflowGraph-Verwaltung.
Befehle
| Name | Beschreibung | Typ | Status |
|---|---|---|---|
| az iot ops dataflowgraph apply |
Erstellen oder ersetzen Sie einen DataflowGraph, der einem Datenflussprofil zugeordnet ist. |
Extension | GA |
| az iot ops dataflowgraph delete |
Löschen Sie einen DataflowGraph, der einem Datenflussprofil zugeordnet ist. |
Extension | GA |
| az iot ops dataflowgraph list |
DataflowGraphs auflisten, die einem Datenflussprofil zugeordnet sind. |
Extension | GA |
| az iot ops dataflowgraph show |
Zeigen Sie Details eines DataflowGraph-Typs an, der einem Datenflussprofil zugeordnet ist. |
Extension | GA |
az iot ops dataflowgraph apply
Erstellen oder ersetzen Sie einen DataflowGraph, der einem Datenflussprofil zugeordnet ist.
Ein Beispiel für das Konfigurationsdateiformat lautet wie folgt:
{
"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" } }
]
}
Im obigen Beispiel wird ein Diagramm mit einer MQTT-Quelle definiert, die über einen Graph-Verarbeitungsknoten fließt, der zu einem Kafka-Ziel und einem OpenTelemetry-Ziel abfließt. Graph-Knoten verweisen auf ein Artefakt (Format: <name>:<version>) von einem Registrierungsendpunkt. Das obige Beispiel enthält nur graphSettings.configuration, um das Format zu veranschaulichen, wenn ein Artefakt Konfigurationsparameter erfordert. geben Sie sie in diesem Fall als Liste von {"key","value"}-Zeichenfolgenpaaren an. Lassen Sie graphSettings.configuration vollständig aus, wenn keine Konfiguration erforderlich ist.
Unterstützte NodeTypes sind: Quelle, Ziel und Graph. Datenflussdiagramme unterstützen nur MQTT-, Kafka- und OpenTelemetry-Endpunkte. Die Datei kann auch der vollständige ARM-Ressourcenwrapper sein (Eigenschaften werden automatisch extrahiert). extendedLocation wird immer automatisch aus --instance und -g aufgefüllt und darf nicht in die Datei eingeschlossen werden.
Bei Verwendung mit anwenden des obigen Inhalts wird eine DataflowGraph-Zielressource erstellt oder ersetzt.
az iot ops dataflowgraph apply --config-file
--instance
--name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--profile]
Beispiele
Erstellen oder ersetzen Sie einen DataflowGraph "mygraph", der einem Profil "myprofile" zugeordnet ist, mithilfe einer Konfigurationsdatei.
az iot ops dataflowgraph apply -n mygraph -p myprofile -i myinstance -g myresourcegroup --config-file /path/to/graph/config.json
Erforderliche Parameter
Pfad zu einer JSON-Datei, die die Dataflowgraph-Eigenschaften enthält.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Config Arguments |
IoT Operations-Instanzname.
DataflowGraph-Name.
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Name des Datenflussprofils. Standard: 'default'.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | default |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot ops dataflowgraph delete
Löschen Sie einen DataflowGraph, der einem Datenflussprofil zugeordnet ist.
az iot ops dataflowgraph delete --instance
--name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--profile]
[--yes {false, true}]
Beispiele
Löschen Sie ein 'mygraph' 'mygraph', das einem Profil 'myprofile' zugeordnet ist.
az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup
Löschen Sie einen DataflowGraph "mygraph" ohne Bestätigungsaufforderung.
az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup -y
Erforderliche Parameter
IoT Operations-Instanzname.
DataflowGraph-Name.
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Automatisches Abrufen eines Azure Policy Tokens für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Die zugehörige Änderungsreferenz-ID für diesen Ressourcenvorgang.
| Eigenschaft | Wert |
|---|---|
| Parametergruppe: | Global Policy Arguments |
Name des Datenflussprofils. Standard: 'default'.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | default |
Bestätigen Sie [y]es ohne Aufforderung. Nützlich für CI- und Automatisierungsszenarien.
| Eigenschaft | Wert |
|---|---|
| Zulässige Werte: | false, true |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot ops dataflowgraph list
DataflowGraphs auflisten, die einem Datenflussprofil zugeordnet sind.
az iot ops dataflowgraph list --instance
--resource-group
[--profile]
Beispiele
Aufzählen von DataflowGraphs, die dem Profil "myprofile" zugeordnet sind.
az iot ops dataflowgraph list -p myprofile -i mycluster-ops-instance -g myresourcegroup
Erforderliche Parameter
IoT Operations-Instanzname.
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Name des Datenflussprofils. Standard: 'default'.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | default |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
az iot ops dataflowgraph show
Zeigen Sie Details eines DataflowGraph-Typs an, der einem Datenflussprofil zugeordnet ist.
az iot ops dataflowgraph show --instance
--name
--resource-group
[--profile]
Beispiele
Zeigen Sie Details zu einem 'Mygraph' des DataflowGraph-Typs an, der einem Profil 'myprofile' zugeordnet ist.
az iot ops dataflowgraph show -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup
Erforderliche Parameter
IoT Operations-Instanzname.
DataflowGraph-Name.
Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.
Optionale Parameter
Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.
Name des Datenflussprofils. Standard: 'default'.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | default |
Globale Parameter
Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Diese Hilfemeldung anzeigen und schließen.
Nur Fehler anzeigen, Warnungen unterdrücken.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |
Ausgabeformat.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | json |
| Zulässige Werte: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.
Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.
| Eigenschaft | Wert |
|---|---|
| Standardwert: | False |