Sensors - Get Connection String

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Získá připojovací řetězec senzoru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Název hostitele oboru názvů, například admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	ID prostředku senzoru.
sensorPartnerId	path	True	string	ID partnera senzoru.
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name	Typ	Description
200 OK	IoTHubDeviceAuthentication	Success
Other Status Codes	ErrorResponse	Chybová Headers x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Type: apiKey
In: header

Příklady

Sensors_GetConnectionString

Sample Request

HTTP

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

Sample Response

Status code:

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=****"
}

Definice

Name	Description
Error	Došlo k chybě ze služby Azure AgPlatform.
ErrorResponse	Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.
InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
IoTHubDeviceAuthentication	Ověřování prostřednictvím připojovací řetězec do zařízení IoTHub.

Error

Došlo k chybě ze služby Azure AgPlatform.

Name	Typ	Description
code	string	Sada kódů chyb definovaná serverem.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
message	string	Pro člověka čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name	Typ	Description
error	Error	Došlo k chybě ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Name	Typ	Description
code	string	Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

IoTHubDeviceAuthentication

Ověřování prostřednictvím připojovací řetězec do zařízení IoTHub.

Name	Typ	Description
primaryDeviceConnectionString	string	Primární připojovací řetězec zařízení ioTHub.
secondaryDeviceConnectionString	string	Sekundární připojovací řetězec zařízení ioTHub.