az iot ops dataflowgraph

Note

Esta referencia forma parte de la extensión azure-iot-ops para el CLI de Azure (versión 2.70.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot ops dataflowgraph . Obtenga más información sobre las extensiones.

Administración de DataflowGraph.

Comandos

Nombre	Description	Tipo	Estado
az iot ops dataflowgraph apply	Cree o reemplace un DataflowGraph asociado a un perfil de flujo de datos.	Extension	GA
az iot ops dataflowgraph delete	Elimine un dataflowGraph asociado a un perfil de flujo de datos.	Extension	GA
az iot ops dataflowgraph list	Enumerar DataflowGraphs asociados a un perfil de flujo de datos.	Extension	GA
az iot ops dataflowgraph show	Muestra los detalles de un dataflowGraph asociado a un perfil de flujo de datos.	Extension	GA

az iot ops dataflowgraph apply

Cree o reemplace un DataflowGraph asociado a un perfil de flujo de datos.

Un ejemplo del formato de archivo de configuración es el siguiente:

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

En el ejemplo anterior se define un gráfico con un origen MQTT que fluye a través de un nodo de procesamiento de grafos que se desplaza a un destino de Kafka y un destino de OpenTelemetry. Los nodos de grafos hacen referencia a un artefacto (formato: <name>:<version>) desde un punto de conexión del Registro. El ejemplo anterior incluye graphSettings.configuration solo para ilustrar el formato cuando un artefacto requiere parámetros de configuración; en ese caso, proporcionelos como una lista de {"key", "value"} pares de cadenas. Omita graphSettings.configuration completamente cuando no se necesite ninguna configuración. NodeTypes admitidos son: Source, Destination y Graph. Los gráficos de flujo de datos solo admiten puntos de conexión MQTT, Kafka y OpenTelemetry. El archivo también puede ser el contenedor de recursos arm completo (las propiedades se extraen automáticamente). extendedLocation siempre se rellena automáticamente desde --instance y -g y no debe incluirse en el archivo.

Cuando se usa con aplicar el contenido anterior, creará o reemplazará un recurso dataflowGraph de destino.

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

Ejemplos

Cree o reemplace un dataflowGraph "mygraph" asociado a un perfil "myprofile" mediante un archivo de configuración.

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

Parámetros requeridos

--config-file

Ruta de acceso a un archivo JSON que contiene las propiedades del dataflowgraph.

Propiedad	Valor
Grupo de parámetros:	Config Arguments

--instance -i

Nombre de instancia de IoT Operations.

--name -n

Nombre de DataflowGraph.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--profile -p

Nombre del perfil de flujo de datos. Valor predeterminado: 'default'.

Propiedad	Valor
Valor predeterminado:	default

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az iot ops dataflowgraph delete

Elimine un dataflowGraph asociado a un perfil de flujo de datos.

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

Ejemplos

Elimine un dataflowGraph "mygraph" asociado a un perfil "myprofile".

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

Elimine un dataflowGraph "mygraph" sin un mensaje de confirmación.

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

Parámetros requeridos

--instance -i

Nombre de instancia de IoT Operations.

--name -n

Nombre de DataflowGraph.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad	Valor
Grupo de parámetros:	Global Policy Arguments

--profile -p

Nombre del perfil de flujo de datos. Valor predeterminado: 'default'.

Propiedad	Valor
Valor predeterminado:	default

--yes -y

Confirme [y]es sin un mensaje. Útil para escenarios de CI y automatización.

Propiedad	Valor
Valores aceptados:	false, true

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az iot ops dataflowgraph list

Enumerar DataflowGraphs asociados a un perfil de flujo de datos.

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

Ejemplos

Enumerar DataflowGraphs asociado al perfil "myprofile".

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

Parámetros requeridos

--instance -i

Nombre de instancia de IoT Operations.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--profile -p

Nombre del perfil de flujo de datos. Valor predeterminado: 'default'.

Propiedad	Valor
Valor predeterminado:	default

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az iot ops dataflowgraph show

Muestra los detalles de un dataflowGraph asociado a un perfil de flujo de datos.

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

Ejemplos

Muestra los detalles de un dataflowGraph "mygraph" asociado a un perfil "myprofile".

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

Parámetros requeridos

--instance -i

Nombre de instancia de IoT Operations.

--name -n

Nombre de DataflowGraph.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--profile -p

Nombre del perfil de flujo de datos. Valor predeterminado: 'default'.

Propiedad	Valor
Valor predeterminado:	default

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False