Sensors - Get Connection String
Mendapatkan string koneksi sensor.
GET {endpoint}/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings?api-version=2023-11-01-preview
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
Nama host namespace layanan, misalnya admaInstanceName.farmbeats.azure.net |
sensor
|
path | True |
string |
Id sumber daya sensor. |
sensor
|
path | True |
string |
Id mitra sensor. |
api-version
|
query | True |
string |
Versi API yang diminta |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
Authorization | True |
string |
Harap berikan token pembawa yang valid untuk panggilan API resmi. Perhatikan bahwa Anda mungkin perlu menghapus cache browser jika Anda mencoba panggilan yang tidak diautentikasi sebelumnya. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Berhasil |
|
Other Status Codes |
Kesalahan Header x-ms-error-code: string |
Keamanan
Authorization
Harap berikan token pembawa yang valid untuk panggilan API resmi. Perhatikan bahwa Anda mungkin perlu menghapus cache browser jika Anda mencoba panggilan yang tidak diautentikasi sebelumnya.
Jenis:
apiKey
Dalam:
header
Contoh
Sensors_GetConnectionString
Permintaan sampel
GET {endpoint}/sensor-partners/sp1/sensors/s124/connection-strings?api-version=2023-11-01-preview
Respon sampel
{
"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=****"
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Kesalahan dari layanan Azure AgPlatform. |
Error |
Respons kesalahan dari layanan Azure AgPlatform. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses untuk dokumen referensi ErrorResponse. |
Inner |
Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError. |
Io |
Autentikasi melalui string koneksi ke perangkat IoTHub. |
Error
Kesalahan dari layanan Azure AgPlatform.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Sekumpulan kode kesalahan yang ditentukan server. |
details |
Error[] |
Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini. |
innererror |
Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError. |
|
message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan dari layanan Azure AgPlatform. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses untuk dokumen referensi ErrorResponse.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Kesalahan dari layanan Azure AgPlatform. |
|
traceId |
string |
Id pelacakan unik. |
InnerError
Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan tertentu daripada yang disediakan oleh kesalahan yang berisi. |
innererror |
Kesalahan dalam yang berisi daftar kesalahan. Lihat https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object untuk dokumen referensi InnerError. |
IoTHubDeviceAuthentication
Autentikasi melalui string koneksi ke perangkat IoTHub.
Nama | Jenis | Deskripsi |
---|---|---|
primaryDeviceConnectionString |
string |
String koneksi utama perangkat ioTHub. |
secondaryDeviceConnectionString |
string |
String koneksi sekunder perangkat ioTHub. |