다음을 통해 공유

Sensors - Get Connection String

  • 참조
서비스:
Azure Data Manager for Agriculture
API 버전:
2023-11-01-preview

센서 연결 문자열 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
 path True

string

uri

네임스페이스의 호스트 이름(예: admaInstanceName.farmbeats.azure.net
sensorId
 path True

string

센서 리소스의 ID입니다.
sensorPartnerId
 path True

string

센서 파트너의 ID입니다.
api-version
 query True

string

요청된 API 버전

요청 헤더

Name 필수 형식 Description
Authorization True

string

권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

응답

Name 형식 Description
200 OK

IoTHubDeviceAuthentication

성공
Other Status Codes

ErrorResponse

오류

헤더

x-ms-error-code: string

보안

Authorization

권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

형식: apiKey
In(다음 안에): header

예제

Sensors_GetConnectionString

샘플 요청

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

샘플 응답

상태 코드:
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=****"
}

정의

Name Description
Error

Azure AgPlatform 서비스의 오류입니다.
ErrorResponse

Azure AgPlatform 서비스의 오류 응답입니다. ErrorResponse 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .
InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
IoTHubDeviceAuthentication

연결 문자열 통해 IoTHub 디바이스에 인증합니다.

Error

Azure AgPlatform 서비스의 오류입니다.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합입니다.
details

Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
message

string

사람이 읽을 수 있는 오류 표현입니다.
target

string

오류의 대상입니다.

ErrorResponse

Azure AgPlatform 서비스의 오류 응답입니다. ErrorResponse 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name 형식 Description
error

Error

Azure AgPlatform 서비스의 오류입니다.
traceId

string

고유 추적 ID입니다.

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name 형식 Description
code

string

포함된 오류에서 제공한 것보다 구체적인 오류 코드입니다.
innererror

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

IoTHubDeviceAuthentication

연결 문자열 통해 IoTHub 디바이스에 인증합니다.

Name 형식 Description
primaryDeviceConnectionString

string

ioTHub 디바이스의 기본 연결 문자열.
secondaryDeviceConnectionString

string

ioTHub 디바이스의 보조 연결 문자열.