Sensors - Get Connection String

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Obtém um sensor cadeia de ligação.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O nome do anfitrião do espaço de nomes, por exemplo, admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	ID do recurso do sensor.
sensorPartnerId	path	True	string	ID do parceiro do sensor.
api-version	query	True	string	A versão da API pedida

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Respostas

Name	Tipo	Description
200 OK	IoTHubDeviceAuthentication	Success
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas à API autorizadas. Tenha em atenção que poderá ter de limpar a cache do browser se já tiver tentado chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

Sensors_GetConnectionString

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
Error	Um erro do serviço Azure AgPlatform.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
IoTHubDeviceAuthentication	Autenticação através de cadeia de ligação para dispositivos IoTHub.

Error

Um erro do serviço Azure AgPlatform.

Name	Tipo	Description
code	string	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Name	Tipo	Description
error	Error	Um erro do serviço Azure AgPlatform.
traceId	string	ID de rastreio exclusivo.

InnerError

Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Name	Tipo	Description
code	string	Código de erro específico do que foi fornecido pelo erro de contenção.
innererror	InnerError	Erro interno que contém a lista de erros. Veja https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

IoTHubDeviceAuthentication

Autenticação através de cadeia de ligação para dispositivos IoTHub.

Name	Tipo	Description
primaryDeviceConnectionString	string	Cadeia de ligação principal do dispositivo ioTHub.
secondaryDeviceConnectionString	string	Cadeia de ligação secundário do dispositivo ioTHub.