Sensors - Get Connection String

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-11-01-preview

Ruft eine Sensorverbindungszeichenfolge ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Hostname des Namespaces, z. B. admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	ID der Sensorressource.
sensorPartnerId	path	True	string	ID des Sensorpartners.
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
200 OK	IoTHubDeviceAuthentication	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Sensors_GetConnectionString

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Error	Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.
InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
IoTHubDeviceAuthentication	Authentifizierung über Verbindungszeichenfolge an IoTHub-Geräte.

Error

Objekt

Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string minLength: 1	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
message	string minLength: 1	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Objekt

Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Objekt

Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

IoTHubDeviceAuthentication

Objekt

Authentifizierung über Verbindungszeichenfolge an IoTHub-Geräte.

Name	Typ	Beschreibung
primaryDeviceConnectionString	string	Primäre Verbindungszeichenfolge des ioTHub-Geräts.
secondaryDeviceConnectionString	string	Sekundäre Verbindungszeichenfolge des ioTHub-Geräts.