Поделиться через

az iot central export destination

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

Примечание.

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

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

Управление и настройка назначений экспорта 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 destination create

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

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

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

az iot central export destination create --app-id
                                         --dest-id
                                         --display-name
                                         --type {blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1}
                                         [--api-version {2022-06-30-preview}]
                                         [--au]
                                         [--central-api-uri]
                                         [--cluster-url]
                                         [--database]
                                         [--header]
                                         [--table]
                                         [--token]
                                         [--url]

Примеры

Создание назначения экспорта веб-перехватчика с помощью полезных данных JSON

az iot central export destination create --app-id {appid} --dest-id {destinationid} --name {displayname} --url {url} --type webhook@v1 --header '{"x-custom-region":{"value":"westus", "secret": false}}'

Создание назначения экспорта хранилища BLOB-объектов с помощью полезных данных JSON

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type blobstorage@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString":"DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
  "containerName": "test"
}'

Создание назначения экспорта Azure Data Explorer с полезными данными JSON

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type dataexplorer@v1 --name {displayname} --cluster-url {clusterurl} --database {database} --table {table} --authorization '{
  "type": "servicePrincipal",
  "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
  "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
  "clientSecret": "[Secret]"
}'

Создание назначения экспорта концентратора событий с полезными данными JSON

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type eventhubs@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
}'

Создание назначения очереди служебная шина с полезными данными JSON

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebusqueue@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

Создание назначения раздела служебная шина с полезными данными JSON

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebustopic@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

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

--app-id -n

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

--dest-id

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

--display-name --name

Отображаемое имя назначения.

--type -t

Целевой тип.

Допустимые значения: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

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

--api-version --av
Не рекомендуется

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

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

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

Конфигурация авторизации в json.

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

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

Default value: azureiotcentral.com
--cluster-url --cu

URL-адрес кластера обозревателя данных Azure.

--database

База данных обозревателя данных Azure.

--header

Коллекция заголовков назначения веб-перехватчика в json.

--table

Таблица обозревателя данных Azure.

--token

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

--url

URL-адрес веб-перехватчика.

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

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

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

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

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

Примеры

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

az iot central export destination delete --app-id {appid} --dest-id {destinationid}

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

--app-id -n

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

--dest-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 destination list

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

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

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

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

Примеры

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

az iot central export destination 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 destination show

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

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

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

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

Примеры

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

az iot central export destination show --app-id {appid} --dest-id {destinationid}

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

--app-id -n

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

--dest-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 destination update

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

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

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

Тип назначения неизменяем после его создания. Необходимо создать новое назначение с новым типом.

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

Примеры

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

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

Обновление назначения экспорта с помощью полезных данных json-patch

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content '{"displayName": "Web Hook Updated"}'

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

--app-id -n

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

--content -k

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

--dest-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.