你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Sensor Mappings - Create Or Update
创建传感器映射实体。
PATCH {endpoint}/sensor-mappings/{sensorMappingId}?api-version=2023-11-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
命名空间的主机名,例如 admaInstanceName.farmbeats.azure.net |
sensor
|
path | True |
string |
传感器映射的 ID。 |
api-version
|
query | True |
string |
请求的 API 版本 |
请求头
Media Types: "application/merge-patch+json"
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
请求正文
Media Types: "application/merge-patch+json"
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
associatedResource | True |
用于存储资源类型和资源 ID 的架构。 |
|
description |
string |
资源的文本说明。 |
|
name |
string |
用于标识资源的名称。 |
|
partyId |
string |
关联方 ID。 |
|
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。 |
||
sensorId |
string |
关联传感器的 ID。 |
|
sensorPartnerId |
string |
关联的传感器合作伙伴的 ID。 |
|
status |
string |
资源的状态。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
201 Created |
创建 |
|
Other Status Codes |
错误 标头 x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
类型:
apiKey
在:
header
示例
SensorMappings_CreateOrUpdate
示例请求
PATCH {endpoint}/sensor-mappings/sm124?api-version=2023-11-01-preview
{
"sensorId": "s124",
"sensorPartnerId": "sp1",
"partyId": "aksaxena-party",
"associatedResource": {
"type": "Field",
"id": "Field123"
},
"status": "sensor map created",
"name": "my new sensor map",
"description": "description for mapping",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
示例响应
{
"sensorId": "s124",
"sensorPartnerId": "sp1",
"partyId": "aksaxena-party",
"associatedResource": {
"type": "Field",
"id": "Field123"
},
"id": "sm124",
"status": "sensor map created",
"createdDateTime": "2022-01-24T06:40:48Z",
"modifiedDateTime": "2022-01-24T06:41:05Z",
"eTag": "0501f236-0000-0700-0000-61ee4a010000",
"name": "my new sensor map",
"description": "description for mapping",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
{
"sensorId": "s124",
"sensorPartnerId": "sp1",
"partyId": "aksaxena-party",
"associatedResource": {
"type": "Field",
"id": "Field123"
},
"id": "sm124",
"status": "sensor map created",
"createdDateTime": "2022-01-24T06:40:48Z",
"modifiedDateTime": "2022-01-24T06:40:48Z",
"eTag": "05018f35-0000-0700-0000-61ee49f00000",
"name": "my new sensor map",
"description": "description for mapping",
"properties": {
"key1": "value1",
"key2": 123.45
}
}
定义
名称 | 说明 |
---|---|
Error |
Azure AgPlatform 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses ErrorResponse 参考文档。 |
Farm |
资源类型。 |
Geo |
用于存储资源类型和资源 ID 的架构。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Sensor |
SensorMapping API 模型。 |
Error
Azure AgPlatform 服务出错。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集。 |
details |
Error[] |
有关导致此报告错误的特定错误的详细信息数组。 |
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 |
Azure AgPlatform 服务出错。 |
|
traceId |
string |
唯一跟踪 ID。 |
FarmHierarchyGeoResourceType
资源类型。
名称 | 类型 | 说明 |
---|---|---|
ApplicationData |
string |
|
Field |
string |
|
HarvestData |
string |
|
PlantTissueAnalysis |
string |
|
PlantingData |
string |
|
Prescription |
string |
|
SeasonalField |
string |
|
TillageData |
string |
|
Zone |
string |
GeoResource
用于存储资源类型和资源 ID 的架构。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
type |
资源类型。 |
InnerError
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含的错误提供的特定错误代码。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
SensorMapping
SensorMapping API 模型。
名称 | 类型 | 说明 |
---|---|---|
associatedResource |
用于存储资源类型和资源 ID 的架构。 |
|
createdBy |
string |
由用户/租户 ID 创建。 |
createdDateTime |
string |
创建资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
description |
string |
资源的文本说明。 |
eTag |
string |
实现乐观并发的 ETag 值。 |
id |
string |
资源的 ID。 |
modifiedBy |
string |
由用户/租户 ID 修改。 |
modifiedDateTime |
string |
上次修改资源的日期时间,示例格式:yyyy-MM-ddTHH:mm:ssZ。 |
name |
string |
用于标识资源的名称。 |
partyId |
string |
关联方 ID。 |
properties |
属于资源的键值对的集合。 每对的键不能超过 50 个字符,并且值不能大于 150 个字符。 注意:最多可以为资源提供 25 个键值对,并且仅支持字符串、数字和 datetime (yyyy-MM-ddTHH:mm:ssZ) 值。 |
|
sensorId |
string |
关联传感器的 ID。 |
sensorPartnerId |
string |
关联的传感器合作伙伴的 ID。 |
status |
string |
资源的状态。 |