Sensors - Get Connection String

Service:

Azure Data Manager for Agriculture

API-versie:

2023-11-01-preview

Hiermee wordt een sensor verbindingsreeks.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Id van de sensorresource.
sensorPartnerId	path	True	string	Id van de sensorpartner.
api-version	query	True	string	De aangevraagde API-versie

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Antwoorden

Name	Type	Description
200 OK	IoTHubDeviceAuthentication	Geslaagd
Other Status Codes	ErrorResponse	Fout Kopteksten x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

Sensors_GetConnectionString

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.
IoTHubDeviceAuthentication	Verificatie via verbindingsreeks naar IoTHub-apparaten.

Error

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string	Door de server gedefinieerde set foutcodes.
details	Error[]	Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.
message	string	Door mensen leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

Name	Type	Description
error	Error	Een fout van de Azure AgPlatform-service.
traceId	string	Unieke tracerings-id.

InnerError

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.

Name	Type	Description
code	string	Specifieke foutcode dan is opgegeven door de betreffende fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.

IoTHubDeviceAuthentication

Verificatie via verbindingsreeks naar IoTHub-apparaten.

Name	Type	Description
primaryDeviceConnectionString	string	Primaire verbindingsreeks van het ioTHub-apparaat.
secondaryDeviceConnectionString	string	Secundaire verbindingsreeks van het ioTHub-apparaat.