az iot ops dataflowgraph

Note

Эта ссылка является частью расширения azure-iot-ops для Azure CLI (версия 2.70.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot ops dataflowgraph . Подробнее о расширениях.

Управление dataflowGraph.

Команды

Имя Описание Тип Состояние
az iot ops dataflowgraph apply

Создайте или замените DataflowGraph, связанную с профилем потока данных.

 Extension GA
az iot ops dataflowgraph delete

Удаление dataflowGraph, связанного с профилем потока данных.

 Extension GA
az iot ops dataflowgraph list

Вывод списка dataflowGraphs, связанных с профилем потока данных.

 Extension GA
az iot ops dataflowgraph show

Отображение сведений о dataflowGraph, связанном с профилем потока данных.

 Extension GA

az iot ops dataflowgraph apply

Создайте или замените DataflowGraph, связанную с профилем потока данных.

Пример формата файла конфигурации выглядит следующим образом:

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

В приведенном выше примере определяется граф с источником MQTT, который проходит через узел обработки Graph, который вентиляторы в место назначения Kafka и назначение OpenTelemetry. Узлы Graph ссылались на артефакт (формат: <name>:<version>) из конечной точки реестра. Приведенный выше пример включает graphSettings.configuration, чтобы иллюстрировать формат, если артефакт требует параметров конфигурации; в этом случае укажите их в виде списка строковых пар {"key", "value"} . Не указывайте graphSettings.configuration полностью, если конфигурация не требуется. Поддерживаемые типы узлов: source, Destination и Graph. Графы потока данных поддерживают только конечные точки MQTT, Kafka и OpenTelemetry. Файл также может быть полной оболочкой ресурсов ARM (свойства извлекаются автоматически). extendedLocation всегда заполняется автоматически из экземпляра и -g и не должен включаться в файл.

При использовании с применением приведенного выше содержимого будет создавать или заменять целевой ресурс DataflowGraph.

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

Примеры

Создайте или замените объект DataflowGraph mygraph, связанный с профилем myprofile, с помощью файла конфигурации.

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

Обязательные параметры

--config-file

Путь к JSON-файлу с свойствами потока данных.

Свойство Значение
Группа параметров: Config Arguments
--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя DataflowGraph.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--profile -p

Имя профиля потока данных. Значение по умолчанию: "default".

Свойство Значение
Default value: default
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot ops dataflowgraph delete

Удаление dataflowGraph, связанного с профилем потока данных.

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

Примеры

Удалите объект DataflowGraph "mygraph", связанный с профилем myprofile.

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

Удалите объект DataflowGraph "mygraph" без запроса подтверждения.

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

Обязательные параметры

--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя DataflowGraph.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--profile -p

Имя профиля потока данных. Значение по умолчанию: "default".

Свойство Значение
Default value: default
--yes -y

Подтвердите [y]es без запроса. Полезно для сценариев CI и автоматизации.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot ops dataflowgraph list

Вывод списка dataflowGraphs, связанных с профилем потока данных.

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

Примеры

Перечисление DataflowGraphs, связанных с профилем myprofile.

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

Обязательные параметры

--instance -i

Имя экземпляра операций Интернета вещей.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--profile -p

Имя профиля потока данных. Значение по умолчанию: "default".

Свойство Значение
Default value: default
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot ops dataflowgraph show

Отображение сведений о dataflowGraph, связанном с профилем потока данных.

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

Примеры

Отображение сведений о объекте DataflowGraph "mygraph", связанном с профилем myprofile.

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

Обязательные параметры

--instance -i

Имя экземпляра операций Интернета вещей.

--name -n

Имя DataflowGraph.

--resource-group -g

Имя группы ресурсов. Вы можете настроить группу по умолчанию с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--profile -p

Имя профиля потока данных. Значение по умолчанию: "default".

Свойство Значение
Default value: default
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False