Sensors - Get Connection String

Servicio:

Azure Data Manager for Agriculture

Versión de la API:

2023-11-01-preview

Obtiene una cadena de conexión del sensor.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	Nombre de host del espacio de nombres, por ejemplo, admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Identificador del recurso del sensor.
sensorPartnerId	path	True	string	Identificador del asociado del sensor.
api-version	query	True	string	La versión de API solicitada

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Respuestas

Nombre	Tipo	Description
200 OK	IoTHubDeviceAuthentication	Éxito
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Seguridad

Authorization

Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Tipo: apiKey
En: header

Ejemplos

Sensors_GetConnectionString

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
Error	Error del servicio Azure AgPlatform.
ErrorResponse	Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para ver el documento de referencia ErrorResponse.
InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.
IoTHubDeviceAuthentication	Autenticación a través de la cadena de conexión a dispositivos IoTHub.

Error

Object

Error del servicio Azure AgPlatform.

Nombre	Tipo	Description
code	string minLength: 1	Conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.
message	string minLength: 1	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para ver el documento de referencia ErrorResponse.

Nombre	Tipo	Description
error	Error	Error del servicio Azure AgPlatform.
traceId	string	Identificador de seguimiento único.

InnerError

Object

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.

Nombre	Tipo	Description
code	string	Código de error específico del proporcionado por el error contenedor.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.

IoTHubDeviceAuthentication

Object

Autenticación a través de la cadena de conexión a dispositivos IoTHub.

Nombre	Tipo	Description
primaryDeviceConnectionString	string	Cadena de conexión principal del dispositivo ioTHub.
secondaryDeviceConnectionString	string	Cadena de conexión secundaria del dispositivo ioTHub.