az iot central export

Примечание.

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

Эта группа команд находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Управление экспортом и настройкой экспорта данных IoT Central.

Команды

Имя	Описание	Тип	Состояние
az iot central export create	Создайте экспорт для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export delete	Удаление экспорта для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export destination	Управление и настройка назначений экспорта IoT Central.	Расширение	Предварительный просмотр
az iot central export destination create	Создайте назначение экспорта для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export destination delete	Удаление назначения экспорта для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export destination list	Получите полный список направлений экспорта для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export destination show	Получение сведений о назначении экспорта.	Расширение	Предварительный просмотр
az iot central export destination update	Обновите назначение экспорта для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export list	Получите полный список экспорта для приложения IoT Central.	Расширение	Предварительный просмотр
az iot central export show	Получение сведений о экспорте.	Расширение	Предварительный просмотр
az iot central export update	Обновите экспорт для приложения IoT Central.	Расширение	Предварительный просмотр

az iot central export create

Предварительный просмотр

Группа команд iot central export находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Создайте экспорт для приложения IoT Central.

az iot central export create --app-id
                             --destinations
                             --display-name
                             --export-id
                             --source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--en]
                             [--enabled {false, true}]
                             [--filter]
                             [--token]

Примеры

Создание экспорта с помощью фильтра, обогащений, назначений

az iot central export create --app-id {appid} --export-id {exportid} --enabled {enabled} --display-name {displayname} --source {source} --filter "SELECT * FROM devices WHERE $displayName != "abc" AND $id = "a"" --enrichments '{
  "simulated": {
    "path": "$simulated"
  }
}' --destinations '[
  {
    "id": "{destinationid}",
    "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }"
  }
]'

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--destinations --dests

Список назначений с преобразованием.

--display-name --name

Отображаемое имя экспорта данных.

--export-id --id

Уникальный идентификатор экспорта.

--source -s

Источник экспорта данных.

Допустимые значения: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

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

--api-version --av

Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Допустимые значения: 2022-06-30-preview

Default value: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com

--en --enrichments

Обогащение экспорта данных.

--enabled -e

Состояние включено для экспорта данных, True или False.

Допустимые значения: false, true

Default value: True

--filter -f

Фильтр на основе языка запросов IoT Central, дополнительные сведения см. в aka.ms/iotcquery.

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central export delete

Предварительный просмотр

Группа команд iot central export находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Удаление экспорта для приложения IoT Central.

az iot central export delete --app-id
                             --export-id
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--token]

Примеры

Удаление экспорта

az iot central export delete --app-id {appid} --export-id {exportid}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--export-id --id

Уникальный идентификатор экспорта.

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

--api-version --av

Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Допустимые значения: 2022-06-30-preview

Default value: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central export list

Предварительный просмотр

Группа команд iot central export находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Получите полный список экспорта для приложения IoT Central.

az iot central export list --app-id
                           [--api-version {2022-06-30-preview}]
                           [--central-api-uri]
                           [--token]

Примеры

Вывод списка всех экспортов в приложении

az iot central export list --app-id {appid}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

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

--api-version --av

Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Допустимые значения: 2022-06-30-preview

Default value: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central export show

Предварительный просмотр

Группа команд iot central export находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Получение сведений о экспорте.

az iot central export show --app-id
                           --export-id
                           [--api-version {2022-06-30-preview}]
                           [--central-api-uri]
                           [--token]

Примеры

Получение сведений об экспорте

az iot central export show --app-id {appid} --export-id {exportid}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--export-id --id

Уникальный идентификатор экспорта.

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

--api-version --av

Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Допустимые значения: 2022-06-30-preview

Default value: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az iot central export update

Предварительный просмотр

Группа команд iot central export находится в предварительной версии и в процессе разработки. Уровни ссылок и поддержки: https://aka.ms/CLI_refstatus

Обновите экспорт для приложения IoT Central.

Источник неизменяем после создания экспорта.

az iot central export update --app-id
                             --content
                             --export-id
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--token]

Примеры

Обновление экспорта из файла

az iot central export update --app-id {appid} --export-id {exportid} --content './filepath/payload.json'

Обновление отображаемого имени экспорта и включение экспорта из полезных данных JSON

az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--content -k

Определение частичного экспорта. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу:./path/to/file.json] [Пример строкифицированного JSON:{}]. Текст запроса должен содержать частичное содержимое экспорта.

--export-id --id

Уникальный идентификатор экспорта.

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

--api-version --av

Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Версия API для запрошенной операции.

Допустимые значения: 2022-06-30-preview

Default value: 2022-06-30-preview

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Default value: azureiotcentral.com

--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше по адресу https://aka.ms/iotcentraldocsapi.

Глобальные параметры

--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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