az iot ops dataflowgraph

Note

Deze verwijzing maakt deel uit van de extensie azure-iot-ops voor de Azure CLI (versie 2.70.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az iot ops dataflowgraph-opdracht uitvoert. Meer informatie over uitbreidingen.

DataflowGraph-beheer.

Opdracht

Name Description Type Status
az iot ops dataflowgraph apply

Maak of vervang een DataflowGraph die is gekoppeld aan een gegevensstroomprofiel.

Extension GA
az iot ops dataflowgraph delete

Verwijder een DataflowGraph die is gekoppeld aan een gegevensstroomprofiel.

Extension GA
az iot ops dataflowgraph list

Een lijst weergeven met DataflowGraphs die zijn gekoppeld aan een gegevensstroomprofiel.

Extension GA
az iot ops dataflowgraph show

Details weergeven van een DataflowGraph die is gekoppeld aan een gegevensstroomprofiel.

Extension GA

az iot ops dataflowgraph apply

Maak of vervang een DataflowGraph die is gekoppeld aan een gegevensstroomprofiel.

Een voorbeeld van de configuratiebestandsindeling is als volgt:

{
  "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" } }
  ]
}

In het bovenstaande voorbeeld wordt een grafiek gedefinieerd met een MQTT-bron die door een Graph-verwerkingsknooppunt stroomt dat naar een Kafka-bestemming en een OpenTelemetry-doel uitloopt. Graph-knooppunten verwijzen naar een artefact (indeling: <name>:<version>) vanuit een registereindpunt. Het bovenstaande voorbeeld bevat alleen graphSettings.configuration om de indeling te illustreren wanneer een artefact configuratieparameters vereist; Geef deze in dat geval op als een lijst met tekenreeksparen {"key", "value"}. Laat graphSettings.configuration volledig weg wanneer er geen configuratie nodig is. Ondersteunde nodeTypes zijn: Bron, Doel en Grafiek. Gegevensstroomgrafieken ondersteunen alleen MQTT-, Kafka- en OpenTelemetry-eindpunten. Het bestand kan ook de volledige ARM-resource-wrapper zijn (eigenschappen worden automatisch geëxtraheerd). extendedLocation wordt altijd automatisch ingevuld vanuit --instance en -g en mag niet worden opgenomen in het bestand.

Wanneer deze wordt gebruikt met het toepassen van de bovenstaande inhoud, wordt een doel-DataflowGraph-resource gemaakt of vervangen.

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

Voorbeelden

Maak of vervang een DataflowGraph 'mygraph' die is gekoppeld aan een profiel 'myprofile' met behulp van een configuratiebestand.

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

Vereiste parameters

--config-file

Pad naar een JSON-bestand met de eigenschappen van de gegevensstroomgraaf.

Eigenschap Waarde
Parametergroep: Config Arguments
--instance -i

Naam ioT Operations-exemplaar.

--name -n

DataflowGraph-naam.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--profile -p

Naam van gegevensstroomprofiel. Standaard: 'standaard'.

Eigenschap Waarde
Default value: default
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot ops dataflowgraph delete

Verwijder een DataflowGraph die is gekoppeld aan een gegevensstroomprofiel.

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

Voorbeelden

Verwijder een DataflowGraph 'mygraph' die is gekoppeld aan een profiel 'myprofile'.

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

Verwijder een DataflowGraph 'mygraph' zonder bevestigingsprompt.

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

Vereiste parameters

--instance -i

Naam ioT Operations-exemplaar.

--name -n

DataflowGraph-naam.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--profile -p

Naam van gegevensstroomprofiel. Standaard: 'standaard'.

Eigenschap Waarde
Default value: default
--yes -y

Bevestig [y]s zonder prompt. Handig voor CI- en automatiseringsscenario's.

Eigenschap Waarde
Geaccepteerde waarden: false, true
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot ops dataflowgraph list

Een lijst weergeven met DataflowGraphs die zijn gekoppeld aan een gegevensstroomprofiel.

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

Voorbeelden

DataflowGraphs opsommen die zijn gekoppeld aan het profiel 'myprofile'.

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

Vereiste parameters

--instance -i

Naam ioT Operations-exemplaar.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--profile -p

Naam van gegevensstroomprofiel. Standaard: 'standaard'.

Eigenschap Waarde
Default value: default
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az iot ops dataflowgraph show

Details weergeven van een DataflowGraph die is gekoppeld aan een gegevensstroomprofiel.

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

Voorbeelden

Details weergeven van een DataflowGraph 'mygraph' die is gekoppeld aan een profiel 'myprofile'.

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

Vereiste parameters

--instance -i

Naam ioT Operations-exemplaar.

--name -n

DataflowGraph-naam.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--profile -p

Naam van gegevensstroomprofiel. Standaard: 'standaard'.

Eigenschap Waarde
Default value: default
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False