你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Sensors - Renew Connection String

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

续订传感器连接字符串。

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

URI 参数

名称	在	必需	类型	说明
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 版本

请求头

名称	必需	类型	说明
Authorization	True	string	请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

请求正文

名称	必需	类型	说明
connectionStringType	True	RenewConnectionStringType	指定要续订的有效值的连接字符串密钥的类型 - 主/辅助/两者。

响应

名称	类型	说明
200 OK	IoTHubDeviceAuthentication	Success
Other Status Codes	ErrorResponse	错误 Headers x-ms-error-code: string

安全性

Authorization

请为授权的 API 调用提供有效的持有者令牌。 请注意，如果之前尝试过未经身份验证的调用，则可能需要清除浏览器缓存。

Type: apiKey
In: header

示例

Sensors_RenewConnectionString

Sample Request

HTTP

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

{
  "connectionStringType": "Primary"
}

Sample Response

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

定义

名称	说明
Error	Azure AgPlatform 服务出错。
ErrorResponse	来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。
InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
IoTHubDeviceAuthentication	通过向 IoTHub 设备连接字符串进行身份验证。
RenewConnectionStringType	指定要续订的有效值的连接字符串密钥的类型 - 主/辅助/两者。
SensorRenewConnectionStringModel	用于续订传感器连接字符串的模型。

Error

Azure AgPlatform 服务出错。

名称	类型	说明
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 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。

名称	类型	说明
error	Error	Azure AgPlatform 服务出错。
traceId	string	唯一跟踪 ID。

InnerError

包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

名称	类型	说明
code	string	包含的错误提供的特定错误代码。
innererror	InnerError	包含错误列表的内部错误。有关 InnerError 参考文档，请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。

IoTHubDeviceAuthentication

通过向 IoTHub 设备连接字符串进行身份验证。

名称	类型	说明
primaryDeviceConnectionString	string	ioTHub 设备的主要连接字符串。
secondaryDeviceConnectionString	string	ioTHub 设备的辅助连接字符串。

RenewConnectionStringType

指定要续订的有效值的连接字符串密钥的类型 - 主/辅助/两者。

名称	类型	说明
Both	string
Primary	string
Secondary	string

SensorRenewConnectionStringModel

用于续订传感器连接字符串的模型。

名称	类型	说明
connectionStringType	RenewConnectionStringType	指定要续订的有效值的连接字符串密钥的类型 - 主/辅助/两者。