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. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses справочный документ ErrorResponse.
InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
IoTHubDeviceAuthentication	Проверка подлинности с помощью строка подключения на устройствах IoTHub.

Error

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

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

ErrorResponse

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

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

InnerError

Внутренняя ошибка, содержащая список ошибок. См. 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

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

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