az iot ops dataflowgraph

Note

Essa 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 instalará automaticamente na primeira vez que você executar um comando az iot ops dataflowgraph . Saiba mais sobre extensões.

Gerenciamento do DataflowGraph.

Comandos

Nome Description Tipo Status
az iot ops dataflowgraph apply

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

Extension GA
az iot ops dataflowgraph delete

Exclua um DataflowGraph associado a um perfil de fluxo de dados.

Extension GA
az iot ops dataflowgraph list

Listar DataflowGraphs associados a um perfil de fluxo de dados.

Extension GA
az iot ops dataflowgraph show

Mostrar detalhes de um DataflowGraph associado a um perfil de fluxo de dados.

Extension GA

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 origem MQTT fluindo por meio de um nó de processamento do Graph que se estende para um destino Kafka e um destino OpenTelemetry. Nós de grafo fazem referência a um artefato (formato: <name>:<version>) de um ponto de extremidade do Registro. O exemplo acima inclui graphSettings.configuration apenas para ilustrar o formato quando um artefato requer parâmetros de configuração; nesse caso, forneça-os como uma lista de pares de cadeia de caracteres {"key", "value"}. Omita grafSettings.configuration inteiramente quando nenhuma configuração é necessária. Os nodeTypes com suporte são: Origem, Destino e Grafo. Os grafos de fluxo de dados dão suporte apenas a pontos de extremidade MQTT, Kafka e OpenTelemetry. O arquivo também pode ser o wrapper de recurso arm completo (as propriedades são extraídas automaticamente). extendedLocation é sempre populado automaticamente de --instance e -g e não deve ser incluído no arquivo.

Quando usado com a aplicação, o conteúdo acima criará ou substituirá um recurso dataflowGraph de destino.

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

Exemplos

Crie ou substitua um 'mygraph' do DataflowGraph associado a um perfil 'myprofile' usando um arquivo 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 Exigidos

--config-file

Caminho para um arquivo JSON que contém as propriedades do dataflowgraph.

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

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

--name -n

Nome do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

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

Propriedade Valor
Valor padrão: default
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot ops dataflowgraph delete

Exclua um DataflowGraph associado a um perfil de fluxo de dados.

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

Exemplos

Exclua um 'mygraph' do DataflowGraph associado a um perfil 'myprofile'.

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

Exclua um 'mygraph' do DataflowGraph sem um prompt de confirmação.

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

Parâmetros Exigidos

--instance -i

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

--name -n

Nome do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

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

Propriedade Valor
Valor padrão: default
--yes -y

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

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

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot ops dataflowgraph list

Listar DataflowGraphs associados a um perfil de fluxo de dados.

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

Exemplos

Enumerar DataflowGraphs associados ao perfil 'myprofile'.

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

Parâmetros Exigidos

--instance -i

Nome da instância de operações de 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--profile -p

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

Propriedade Valor
Valor padrão: default
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot ops dataflowgraph show

Mostrar detalhes de um DataflowGraph associado a um perfil de fluxo de dados.

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

Exemplos

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

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

Parâmetros Exigidos

--instance -i

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

--name -n

Nome do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--profile -p

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

Propriedade Valor
Valor padrão: default
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False