az iot ops dataflowgraph
Note
Den här referensen är en del av tillägget azure-iot-ops för Azure CLI (version 2.70.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot ops dataflowgraph-kommando . Läs mer om tillägg.
DataflowGraph-hantering.
Kommandon
| Name | Description | Typ | Status |
|---|---|---|---|
| az iot ops dataflowgraph apply |
Skapa eller ersätt en DataflowGraph som är associerad med en dataflödesprofil. |
Extension | GA |
| az iot ops dataflowgraph delete |
Ta bort en DataflowGraph som är associerad med en dataflödesprofil. |
Extension | GA |
| az iot ops dataflowgraph list |
Visa en lista över dataflödesgrafer som är associerade med en dataflödesprofil. |
Extension | GA |
| az iot ops dataflowgraph show |
Visa information om en DataflowGraph som är associerad med en dataflödesprofil. |
Extension | GA |
az iot ops dataflowgraph apply
Skapa eller ersätt en DataflowGraph som är associerad med en dataflödesprofil.
Ett exempel på konfigurationsfilformatet är följande:
{
"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" } }
]
}
Exemplet ovan definierar ett diagram med en MQTT-källa som flödar genom en Graph-bearbetningsnod som fläktar ut till ett Kafka-mål och ett OpenTelemetry-mål. Grafnoder refererar till en artefakt (format: <name>:<version>) från en registerslutpunkt. Exemplet ovan innehåller graphSettings.configuration endast för att illustrera formatet när en artefakt kräver konfigurationsparametrar. I så fall anger du dem som en lista över {"key", "value"} strängpar. Utelämna graphSettings.configuration helt när ingen konfiguration behövs.
NodeTypes som stöds är: Källa, Mål och Graph. Dataflödesdiagram stöder endast MQTT-, Kafka- och OpenTelemetry-slutpunkter. Filen kan också vara den fullständiga ARM-resursomslutningen (egenskaperna extraheras automatiskt). extendedLocation fylls alltid i automatiskt från --instance och -g och får inte ingå i filen.
När det används med använd ovanstående innehåll skapas eller ersätts en DataflowGraph-målresurs.
az iot ops dataflowgraph apply --config-file
--instance
--name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--profile]
Exempel
Skapa eller ersätt en DataflowGraph -mygraph som är associerad med en profil "myprofile" med hjälp av en konfigurationsfil.
az iot ops dataflowgraph apply -n mygraph -p myprofile -i myinstance -g myresourcegroup --config-file /path/to/graph/config.json
Obligatoriska parametrar
Sökväg till en JSON-fil som innehåller egenskaperna för dataflödesgrafen.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Config Arguments |
IoT Operations-instansens namn.
DataflowGraph-namn.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Hämtar en Azure Policy token automatiskt för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Det relaterade ändringsreferens-ID:t för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Namn på dataflödesprofil. Standard: "default".
| Egenskap | Värde |
|---|---|
| Standardvärde: | default |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot ops dataflowgraph delete
Ta bort en DataflowGraph som är associerad med en dataflödesprofil.
az iot ops dataflowgraph delete --instance
--name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--profile]
[--yes {false, true}]
Exempel
Ta bort en DataflowGraph -mygraph som är associerad med en profil "myprofile".
az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup
Ta bort en DataflowGraph "mygraph" utan en bekräftelsefråga.
az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup -y
Obligatoriska parametrar
IoT Operations-instansens namn.
DataflowGraph-namn.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Hämtar en Azure Policy token automatiskt för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Det relaterade ändringsreferens-ID:t för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Namn på dataflödesprofil. Standard: "default".
| Egenskap | Värde |
|---|---|
| Standardvärde: | default |
Bekräfta [y]es utan att fråga. Användbart för CI- och automationsscenarier.
| Egenskap | Värde |
|---|---|
| Godkända värden: | false, true |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot ops dataflowgraph list
Visa en lista över dataflödesgrafer som är associerade med en dataflödesprofil.
az iot ops dataflowgraph list --instance
--resource-group
[--profile]
Exempel
Räkna upp DataflowGraphs som är associerade med profilen "myprofile".
az iot ops dataflowgraph list -p myprofile -i mycluster-ops-instance -g myresourcegroup
Obligatoriska parametrar
IoT Operations-instansens namn.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namn på dataflödesprofil. Standard: "default".
| Egenskap | Värde |
|---|---|
| Standardvärde: | default |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az iot ops dataflowgraph show
Visa information om en DataflowGraph som är associerad med en dataflödesprofil.
az iot ops dataflowgraph show --instance
--name
--resource-group
[--profile]
Exempel
Visa information om en DataflowGraph "mygraph" som är associerad med en profil "myprofile".
az iot ops dataflowgraph show -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup
Obligatoriska parametrar
IoT Operations-instansens namn.
DataflowGraph-namn.
Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Valfria parametrar
Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.
Namn på dataflödesprofil. Standard: "default".
| Egenskap | Värde |
|---|---|
| Standardvärde: | default |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |