az iot ops dataflowgraph

Note

Esta referência faz parte da extensão azure-iot-ops para o CLI do Azure (versão 2.70.0 ou superior). A extensão instala-se automaticamente na primeira vez que executares um comando do azot ops dataflowgraph . Saiba mais sobre extensões.

Gestão do DataflowGraph.

Comandos

Name Description Tipo Status
az iot ops dataflowgraph apply

Crie ou substitua um DataflowGraph associado a um perfil de fluxo de dados.

Extension disponibilidade geral
az iot ops dataflowgraph delete

Elimine um DataflowGraph associado a um perfil de dataflow.

Extension disponibilidade geral
az iot ops dataflowgraph list

Liste DataflowGraphs associados a um perfil de dataflow.

Extension disponibilidade geral
az iot ops dataflowgraph show

Mostrar detalhes de um DataflowGraph associado a um perfil de dataflow.

Extension disponibilidade geral

az iot ops dataflowgraph apply

Crie ou substitua um DataflowGraph associado a um perfil de fluxo de dados.

Um exemplo do formato de arquivo de configuração é o seguinte:

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

O exemplo acima define um grafo com uma fonte MQTT a fluir através de um nó de processamento de grafo que se espalha para um destino Kafka e um destino OpenTelemetry. Os nós grafo referenciam um artefacto (formato: <name>:<version>) a partir de um ponto final do registo. O exemplo acima inclui graphSettings.configuration apenas para ilustrar o formato quando um artefacto requer parâmetros de configuração; Nesse caso, forneça-as como uma lista de pares de string {"chave", "valor"}. Omite graphSettings.configuration completamente quando não for necessária configuração. Os tipos de nó suportados são: Fonte, Destino e Grafo. Os grafos de fluxo de dados suportam apenas endpoints MQTT, Kafka e OpenTelemetry. O ficheiro pode também ser o wrapper completo do recurso ARM (as propriedades são extraídas automaticamente). extendedLocation é sempre preenchido automaticamente a partir de --instance e -g e não deve ser incluído no ficheiro.

Quando usado com aplicação, o conteúdo acima criará ou substituirá um recurso DataflowGraph alvo.

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

Exemplos

Crie ou substitua um DataflowGraph 'mygraph' associado a um perfil 'myprofile' usando um ficheiro de configuração.

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

Parâmetros Obrigatórios

--config-file

Caminho para um ficheiro JSON contendo as propriedades do dataflowgraph.

Propriedade Valor
Grupo de parâmetros: Config Arguments
--instance -i

Nome da instância de Operações IoT.

--name -n

Nome DataflowGraph.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--profile -p

Nome do perfil de fluxo de dados. Padrão: 'padrão'.

Propriedade Valor
Default value: default
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot ops dataflowgraph delete

Elimine um DataflowGraph associado a um perfil de dataflow.

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

Exemplos

Elimine um DataflowGraph 'mygraph' associado a um perfil 'myprofile'.

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

Apague um 'mygraph' do DataflowGraph sem um pedido de confirmação.

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

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome DataflowGraph.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--profile -p

Nome do perfil de fluxo de dados. Padrão: 'padrão'.

Propriedade Valor
Default value: default
--yes -y

Confirme [s]es sem um prompt. Útil para cenários de CI e automação.

Propriedade Valor
Valores aceites: false, true
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot ops dataflowgraph list

Liste DataflowGraphs associados a um perfil de dataflow.

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

Exemplos

Enumere DataflowGraphs associados ao perfil 'myprofile'.

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

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--profile -p

Nome do perfil de fluxo de dados. Padrão: 'padrão'.

Propriedade Valor
Default value: default
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot ops dataflowgraph show

Mostrar detalhes de um DataflowGraph associado a um perfil de dataflow.

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

Exemplos

Mostrar detalhes de um DataflowGraph 'mygraph' associado a um perfil 'myprofile'.

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

Parâmetros Obrigatórios

--instance -i

Nome da instância de Operações IoT.

--name -n

Nome DataflowGraph.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--profile -p

Nome do perfil de fluxo de dados. Padrão: 'padrão'.

Propriedade Valor
Default value: default
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID de assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False