Sensors - Get Connection String

Служба:

Azure Data Manager for Agriculture

Версия API:

2023-11-01-preview

Возвращает строку подключения датчика.

GET {endpoint}/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings?api-version=2023-11-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Имя узла пространства имен, например admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Идентификатор ресурса датчика.
sensorPartnerId	path	True	string	Идентификатор партнера датчика.
api-version	query	True	string	Запрошенная версия API

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Ответы

Имя	Тип	Описание
200 OK	IoTHubDeviceAuthentication	Успех
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Безопасность

Authorization

Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Тип: apiKey
В: header

Примеры

Sensors_GetConnectionString

Образец запроса

HTTP

GET {endpoint}/sensor-partners/sp1/sensors/s124/connection-strings?api-version=2023-11-01-preview

Пример ответа

Код состояния:

200

{
  "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****",
  "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****"
}

Определения

Имя	Описание
Error	Ошибка из службы Azure AgPlatform.
ErrorResponse	Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
IoTHubDeviceAuthentication	Проверка подлинности через строку подключения к устройствам IoTHub.

Error

Object

Ошибка из службы Azure AgPlatform.

Имя	Тип	Описание
code	string minLength: 1	Определяемый сервером набор кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
message	string minLength: 1	Читаемое человеком представление ошибки.
target	string	Цель ошибки.

ErrorResponse

Object

Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
error	Error	Ошибка из службы Azure AgPlatform.
traceId	string	Уникальный идентификатор трассировки.

InnerError

Object

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Имя	Тип	Описание
code	string	Определенный код ошибки, чем был предоставлен содержащей ошибкой.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

IoTHubDeviceAuthentication

Object

Проверка подлинности через строку подключения к устройствам IoTHub.

Имя	Тип	Описание
primaryDeviceConnectionString	string	Основная строка подключения устройства ioTHub.
secondaryDeviceConnectionString	string	Вторичная строка подключения устройства ioTHub.