Sensors - Get Connection String

Szolgáltatás:

Azure Data Manager for Agriculture

API-verzió:

2023-11-01-preview

Lekéri az érzékelő kapcsolati sztringet.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A névtér gazdagépneve, például admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Az érzékelőerőforrás azonosítója.
sensorPartnerId	path	True	string	Az érzékelőpartner azonosítója.
api-version	query	True	string	A kért API-verzió

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Válaszok

Name	Típus	Description
200 OK	IoTHubDeviceAuthentication	Siker
Other Status Codes	ErrorResponse	Hiba Fejlécek x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Típus: apiKey
In: header

Példák

Sensors_GetConnectionString

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
IoTHubDeviceAuthentication	Hitelesítés kapcsolati sztringen keresztül az IoTHub-eszközökhöz.

Error

Objektum

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string minLength: 1	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
message	string minLength: 1	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Objektum

Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

InnerError

Objektum

A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

Name	Típus	Description
code	string	A hibát tartalmazó hiba által megadottnál meghatározott hibakód.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

IoTHubDeviceAuthentication

Objektum

Hitelesítés kapcsolati sztringen keresztül az IoTHub-eszközökhöz.

Name	Típus	Description
primaryDeviceConnectionString	string	Az ioTHub-eszköz elsődleges kapcsolati sztringje.
secondaryDeviceConnectionString	string	Az ioTHub-eszköz másodlagos kapcsolati sztringje.