az iot ops ns asset custom stream

Note

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

Управление потоками для пользовательских ресурсов с пространством имен в экземпляре Операций Интернета вещей.

Потоки определяют, как потоки данных из пользовательских ресурсов в назначения. Пользовательские потоки позволяют гибко настраивать различные сценарии потоковой передачи данных.

Команды

Имя Описание Тип Состояние
az iot ops ns asset custom stream add

Добавление потока в пользовательский ресурс.

Extension GA
az iot ops ns asset custom stream export

Экспорт потоков в файл.

Extension GA
az iot ops ns asset custom stream import

Импорт потоков из файла.

Extension GA
az iot ops ns asset custom stream list

Вывод списка потоков в пользовательском ресурсе.

Extension GA
az iot ops ns asset custom stream remove

Удаление потока из пользовательского ресурса.

Extension GA
az iot ops ns asset custom stream show

Отображение сведений о потоке в пользовательском ресурсе.

Extension GA
az iot ops ns asset custom stream update

Обновите поток в пользовательском ресурсе.

Extension GA

az iot ops ns asset custom stream add

Добавление потока в пользовательский ресурс.

az iot ops ns asset custom stream add --asset
                                      --instance
                                      --name
                                      --resource-group
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--config]
                                      [--dest --destination]
                                      [--replace {false, true}]
                                      [--tr --type-ref]

Примеры

Добавьте базовый пользовательский поток в ресурс.

az iot ops ns asset custom stream add --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream --config '{"streamType": "sensor-data", "frequency": "1000ms"}'

Добавьте пользовательский поток с назначениями MQTT.

az iot ops ns asset custom stream add --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream --config '{"streamType": "telemetry", "bufferSize": 1024}' --destination topic=/factory/streams/data retain=Keep qos=Qos1

Замените существующий пользовательский поток тем же именем.

az iot ops ns asset custom stream add --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream --config '{"streamType": "updated-config", "version": "2.0"}' --replace

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

--asset -a

Имя ресурса.

--instance -i

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

--name

Имя потока.

--resource-group -g

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

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

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

--acquire-policy-token

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

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

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

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

Настраиваемая конфигурация потока в виде строки JSON или пути к файлу.

--dest --destination

Пары Key=value, представляющие место назначения для потоков. Допустимые аргументы включают: key для BrokerStateStore; path для хранилища или topicretain, qosа также ttl для MQTT. Допустимые значения: и retainKeep допустимые значения Never для qos них Qos0Qos1.

--replace

Замените поток, если другой поток уже присутствует с тем же именем.

Свойство Значение
Default value: False
Допустимые значения: false, true
--tr --type-ref

Идентификатор определения типа или универсальный код ресурса (URI).

Глобальные параметры
--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 ns asset custom stream export

Экспорт потоков в файл.

Экспортируйте все потоки из ресурса в формат JSON или YAML. Назначения удаляются при экспорте и автоматически назначены при импорте.

az iot ops ns asset custom stream export --asset
                                         --instance
                                         --resource-group
                                         [--acquire-policy-token]
                                         [--change-reference]
                                         [--format {json, yaml}]
                                         [--od --output-dir]
                                         [--replace {false, true}]

Примеры

Экспорт потоков в JSON.

az iot ops ns asset custom stream export -a myasset --instance myinstance -g myresourcegroup

Экспорт потоков в YAML в определенном каталоге.

az iot ops ns asset custom stream export -a myasset --instance myinstance -g myresourcegroup -f yaml --od /path/to/output

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

--asset -a

Имя ресурса.

--instance -i

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

--resource-group -g

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

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

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

--acquire-policy-token

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

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

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

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

Экспорт файла (JSON или YAML).

Свойство Значение
Default value: json
Допустимые значения: json, yaml
--od --output-dir

Выходной каталог для экспорта.

Свойство Значение
Default value: .
--replace

Замените поток, если другой поток уже присутствует с тем же именем.

Свойство Значение
Default value: False
Допустимые значения: 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 ns asset custom stream import

Импорт потоков из файла.

Импорт потоков из JSON или YAML-файла. Используйте --replace для слияния с перезаписью. Назначения автоматически назначаются из ресурсов по умолчанию, если они не указаны в файле.

az iot ops ns asset custom stream import --asset
                                         --if --input-file
                                         --instance
                                         --resource-group
                                         [--acquire-policy-token]
                                         [--change-reference]
                                         [--replace {false, true}]

Примеры

Импорт потоков из JSON-файла.

az iot ops ns asset custom stream import -a myasset --instance myinstance -g myresourcegroup --if /path/to/streams.json

Импорт потоков с режимом замены.

az iot ops ns asset custom stream import -a myasset --instance myinstance -g myresourcegroup --if /path/to/streams.json --replace

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

--asset -a

Имя ресурса.

--if --input-file

Путь к импорту файла (JSON или YAML).

--instance -i

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

--resource-group -g

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

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

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

--acquire-policy-token

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

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

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

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

Замените поток, если другой поток уже присутствует с тем же именем.

Свойство Значение
Default value: False
Допустимые значения: 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 ns asset custom stream list

Вывод списка потоков в пользовательском ресурсе.

az iot ops ns asset custom stream list --asset
                                       --instance
                                       --resource-group

Примеры

Вывод списка всех потоков в пользовательском ресурсе.

az iot ops ns asset custom stream list --asset myasset --instance myInstance -g myInstanceResourceGroup

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

--asset -a

Имя ресурса.

--instance -i

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

--resource-group -g

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

Глобальные параметры
--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 ns asset custom stream remove

Удаление потока из пользовательского ресурса.

az iot ops ns asset custom stream remove --asset
                                         --instance
                                         --name
                                         --resource-group
                                         [--acquire-policy-token]
                                         [--change-reference]

Примеры

Удаление потока из пользовательского ресурса.

az iot ops ns asset custom stream remove --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream

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

--asset -a

Имя ресурса.

--instance -i

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

--name

Имя потока.

--resource-group -g

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

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

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

--acquire-policy-token

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

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

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

Свойство Значение
Группа параметров: Global Policy Arguments
Глобальные параметры
--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 ns asset custom stream show

Отображение сведений о потоке в пользовательском ресурсе.

az iot ops ns asset custom stream show --asset
                                       --instance
                                       --name
                                       --resource-group

Примеры

Отображение сведений о определенном потоке.

az iot ops ns asset custom stream show --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream

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

--asset -a

Имя ресурса.

--instance -i

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

--name

Имя потока.

--resource-group -g

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

Глобальные параметры
--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 ns asset custom stream update

Обновите поток в пользовательском ресурсе.

az iot ops ns asset custom stream update --asset
                                         --instance
                                         --name
                                         --resource-group
                                         [--acquire-policy-token]
                                         [--change-reference]
                                         [--config]
                                         [--dest --destination]
                                         [--tr --type-ref]

Примеры

Обновите настраиваемую конфигурацию потока.

az iot ops ns asset custom stream update --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream --config '{"streamType": "updated-sensor-data", "frequency": "500ms"}'

Обновите конфигурацию и назначения.

az iot ops ns asset custom stream update --asset myasset --instance myInstance -g myInstanceResourceGroup --name myStream --config '{"streamType": "hybrid-data", "compression": true}' --destination path=/compressed/data

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

--asset -a

Имя ресурса.

--instance -i

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

--name

Имя потока.

--resource-group -g

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

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

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

--acquire-policy-token

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

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

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

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

Настраиваемая конфигурация потока в виде строки JSON или пути к файлу.

--dest --destination

Пары Key=value, представляющие место назначения для потоков. Допустимые аргументы включают: key для BrokerStateStore; path для хранилища или topicretain, qosа также ttl для MQTT. Допустимые значения: и retainKeep допустимые значения Never для qos них Qos0Qos1.

--tr --type-ref

Идентификатор определения типа или универсальный код ресурса (URI).

Глобальные параметры
--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