你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Solutions Discoverability - Get
按 ID 获取 Data Manager For Agriculture 解决方案。
GET https://management.azure.com/providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions/{dataManagerForAgricultureSolutionId}?api-version=2023-06-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
data
|
path | True |
string |
要查询的 dataManagerForAgricultureSolutionId。 Regex pattern: |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
错误 |
安全性
azure_auth
Azure Active Directory OAuth2 流。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
SolutionsDiscoverability_Get
Sample Request
GET https://management.azure.com/providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions/bayerAgPowered.gdu?api-version=2023-06-01-preview
Sample Response
{
"id": "/providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions/bayerAgPowered.gdu",
"type": "Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions",
"systemData": {
"createdAt": "2022-07-25T10:15:15Z",
"lastModifiedAt": "2022-07-25T10:15:15Z"
},
"properties": {
"partnerId": "abc",
"partnerTenantId": "556b0c04-d33e-48d0-9f6f-f893c8c77e00",
"marketplaceOfferDetails": {
"saasOfferId": "saasOfferId",
"publisherId": "publisherId"
},
"dataAccessScopes": [
"Weather",
"Scenes"
],
"openApiSpecsDictionary": {
"v1": {
"paths": {
"/v1/resources/{resourceId}": {
"get": {
"tags": [
"Weather"
],
"description": "Get weather ingestion job.",
"operationId": "Weather_GetDataIngestionJobDetails",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "resourceId",
"description": "Id of the job.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "api-version",
"description": "The requested API version",
"required": true,
"type": "string",
"default": "2021-07-31-preview"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"description": "Schema of weather ingestion job.",
"required": [
"boundaryId",
"extensionApiInput",
"extensionApiName",
"extensionId",
"farmerId"
],
"type": "object",
"properties": {
"boundaryId": {
"description": "The id of the boundary object for which weather data is being fetched.",
"type": "string"
},
"farmerId": {
"description": "The id of the farmer object for which weather data is being fetched.",
"type": "string"
},
"extensionId": {
"description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.",
"maxLength": 100,
"minLength": 2,
"pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$",
"type": "string"
},
"extensionApiName": {
"description": "Extension api name to which request is to be made.",
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"extensionApiInput": {
"description": "Extension api input dictionary which would be used to feed request query/body/parameter information.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"extensionDataProviderAppId": {
"description": "App id of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"extensionDataProviderApiKey": {
"description": "Api key of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"id": {
"description": "Unique job id.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.",
"type": "string",
"readOnly": true
},
"durationInSeconds": {
"format": "double",
"description": "Duration of the job in seconds.",
"type": "number",
"readOnly": true
},
"message": {
"description": "Status message to capture more details of the job.",
"type": "string",
"readOnly": true
},
"createdDateTime": {
"format": "date-time",
"description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"lastActionDateTime": {
"format": "date-time",
"description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"startTime": {
"format": "date-time",
"description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"endTime": {
"format": "date-time",
"description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"name": {
"description": "Name to identify resource.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"description": {
"description": "Textual description of the resource.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"properties": {
"description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.",
"type": "object",
"additionalProperties": {
"type": "object"
},
"example": {
"key1": "value1",
"key2": 123.45
}
}
},
"additionalProperties": {}
}
},
"default": {
"description": "Error",
"schema": {
"description": "An error response from the Azure AgPlatform service.\r\n<see href=\"https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses\">ErrorResponse reference document.</see>.",
"type": "object",
"properties": {
"error": {
"description": "An error from the Azure AgPlatform service.",
"type": "object",
"properties": {
"code": {
"description": "Server-defined set of error codes.",
"type": "string"
},
"message": {
"description": "Human-readable representation of the error.",
"type": "string"
},
"target": {
"description": "Target of the error.",
"type": "string"
},
"details": {
"description": "Array of details about specific errors that led to this reported error.",
"type": "array"
}
}
},
"traceId": {
"description": "Unique trace Id.",
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Weather"
],
"description": "Create a weather data ingestion job.",
"operationId": "Weather_CreateDataIngestionJob",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "resourceId",
"description": "Job id supplied by user.",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "api-version",
"description": "The requested API version",
"required": true,
"type": "string",
"default": "2021-07-31-preview"
},
{
"in": "body",
"name": "body",
"description": "Job parameters supplied by user.",
"schema": {
"description": "Schema of weather ingestion job.",
"required": [
"boundaryId",
"extensionApiInput",
"extensionApiName",
"extensionId",
"farmerId"
],
"type": "object",
"properties": {
"boundaryId": {
"description": "The id of the boundary object for which weather data is being fetched.",
"type": "string"
},
"farmerId": {
"description": "The id of the farmer object for which weather data is being fetched.",
"type": "string"
},
"extensionId": {
"description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.",
"maxLength": 100,
"minLength": 2,
"pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$",
"type": "string"
},
"extensionApiName": {
"description": "Extension api name to which request is to be made.",
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"extensionApiInput": {
"description": "Extension api input dictionary which would be used to feed request query/body/parameter information.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"extensionDataProviderAppId": {
"description": "App id of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"extensionDataProviderApiKey": {
"description": "Api key of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"id": {
"description": "Unique job id.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.",
"type": "string",
"readOnly": true
},
"durationInSeconds": {
"format": "double",
"description": "Duration of the job in seconds.",
"type": "number",
"readOnly": true
},
"message": {
"description": "Status message to capture more details of the job.",
"type": "string",
"readOnly": true
},
"createdDateTime": {
"format": "date-time",
"description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"lastActionDateTime": {
"format": "date-time",
"description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"startTime": {
"format": "date-time",
"description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"endTime": {
"format": "date-time",
"description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"name": {
"description": "Name to identify resource.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"description": {
"description": "Textual description of the resource.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"properties": {
"description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.",
"type": "object",
"additionalProperties": {
"type": "object"
},
"example": {
"key1": "value1",
"key2": 123.45
}
}
},
"additionalProperties": {}
}
}
],
"responses": {
"202": {
"description": "Success",
"schema": {
"description": "Schema of weather ingestion job.",
"required": [
"boundaryId",
"extensionApiInput",
"extensionApiName",
"extensionId",
"farmerId"
],
"type": "object",
"properties": {
"boundaryId": {
"description": "The id of the boundary object for which weather data is being fetched.",
"type": "string"
},
"farmerId": {
"description": "The id of the farmer object for which weather data is being fetched.",
"type": "string"
},
"extensionId": {
"description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.",
"maxLength": 100,
"minLength": 2,
"pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$",
"type": "string"
},
"extensionApiName": {
"description": "Extension api name to which request is to be made.",
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"extensionApiInput": {
"description": "Extension api input dictionary which would be used to feed request query/body/parameter information.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"extensionDataProviderAppId": {
"description": "App id of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"extensionDataProviderApiKey": {
"description": "Api key of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"id": {
"description": "Unique job id.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.",
"type": "string",
"readOnly": true
},
"durationInSeconds": {
"format": "double",
"description": "Duration of the job in seconds.",
"type": "number",
"readOnly": true
},
"message": {
"description": "Status message to capture more details of the job.",
"type": "string",
"readOnly": true
},
"createdDateTime": {
"format": "date-time",
"description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"lastActionDateTime": {
"format": "date-time",
"description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"startTime": {
"format": "date-time",
"description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"endTime": {
"format": "date-time",
"description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"name": {
"description": "Name to identify resource.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"description": {
"description": "Textual description of the resource.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"properties": {
"description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.",
"type": "object",
"additionalProperties": {
"type": "object"
},
"example": {
"key1": "value1",
"key2": 123.45
}
}
},
"additionalProperties": {}
}
},
"default": {
"description": "Error",
"schema": {
"description": "An error response from the Azure AgPlatform service.\r\n<see href=\"https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses\">ErrorResponse reference document.</see>.",
"type": "object",
"properties": {
"error": {
"description": "An error from the Azure AgPlatform service.",
"type": "object",
"properties": {
"code": {
"description": "Server-defined set of error codes.",
"type": "string"
},
"message": {
"description": "Human-readable representation of the error.",
"type": "string"
},
"target": {
"description": "Target of the error.",
"type": "string"
},
"details": {
"description": "Array of details about specific errors that led to this reported error.",
"type": "array"
}
}
},
"traceId": {
"description": "Unique trace Id.",
"type": "string"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
}
},
"basePath": "/",
"definitions": {
"WeatherDataIngestionJob": {
"description": "Schema of weather ingestion job.",
"required": [
"boundaryId",
"extensionApiInput",
"extensionApiName",
"extensionId",
"farmerId"
],
"type": "object",
"properties": {
"boundaryId": {
"description": "The id of the boundary object for which weather data is being fetched.",
"type": "string"
},
"farmerId": {
"description": "The id of the farmer object for which weather data is being fetched.",
"type": "string"
},
"extensionId": {
"description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.",
"maxLength": 100,
"minLength": 2,
"pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$",
"type": "string"
},
"extensionApiName": {
"description": "Extension api name to which request is to be made.",
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"extensionApiInput": {
"description": "Extension api input dictionary which would be used to feed request query/body/parameter information.",
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"extensionDataProviderAppId": {
"description": "App id of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"extensionDataProviderApiKey": {
"description": "Api key of the weather data provider.",
"maxLength": 200,
"minLength": 2,
"type": "string"
},
"id": {
"description": "Unique job id.",
"type": "string",
"readOnly": true
},
"status": {
"description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.",
"type": "string",
"readOnly": true
},
"durationInSeconds": {
"format": "double",
"description": "Duration of the job in seconds.",
"type": "number",
"readOnly": true
},
"message": {
"description": "Status message to capture more details of the job.",
"type": "string",
"readOnly": true
},
"createdDateTime": {
"format": "date-time",
"description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"lastActionDateTime": {
"format": "date-time",
"description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"startTime": {
"format": "date-time",
"description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"endTime": {
"format": "date-time",
"description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.",
"type": "string",
"readOnly": true
},
"name": {
"description": "Name to identify resource.",
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"description": {
"description": "Textual description of the resource.",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"properties": {
"description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.",
"type": "object",
"additionalProperties": {
"type": "object"
},
"example": {
"key1": "value1",
"key2": 123.45
}
}
},
"additionalProperties": {}
},
"ErrorResponse": {
"description": "An error response from the Azure AgPlatform service.\r\n<see href=\"https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses\">ErrorResponse reference document.</see>.",
"type": "object",
"properties": {
"error": {
"description": "An error from the Azure AgPlatform service.",
"type": "object",
"properties": {
"code": {
"description": "Server-defined set of error codes.",
"type": "string"
},
"message": {
"description": "Human-readable representation of the error.",
"type": "string"
},
"target": {
"description": "Target of the error.",
"type": "string"
},
"details": {
"description": "Array of details about specific errors that led to this reported error.",
"type": "array"
}
}
},
"traceId": {
"description": "Unique trace Id.",
"type": "string"
}
}
},
"InnerError": {
"description": "Inner error containing list of errors.\r\n<see href=\"https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object\">InnerError reference document</see>.",
"type": "object",
"properties": {
"code": {
"description": "Specific error code than was provided by the\r\ncontaining error.",
"type": "string"
}
},
"additionalProperties": {
"type": "object"
}
},
"Error": {
"description": "An error from the Azure AgPlatform service.",
"type": "object",
"properties": {
"code": {
"description": "Server-defined set of error codes.",
"type": "string"
},
"message": {
"description": "Human-readable representation of the error.",
"type": "string"
},
"target": {
"description": "Target of the error.",
"type": "string"
},
"details": {
"description": "Array of details about specific errors that led to this reported error.",
"type": "array"
}
}
}
},
"externalDocs": {
"description": "Find out more about Swagger",
"url": "http://swagger.io"
},
"host": "addon.azurewebsites.net",
"info": {
"contact": {
"email": "apiteam@swagger.io"
},
"description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"termsOfService": "http://swagger.io/terms/",
"title": "Swagger Petstore",
"version": "1.0.6"
},
"schemes": [
"https"
],
"swagger": "2.0"
}
},
"accessFBApplicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accessFBApplicationName": "solution provider 1",
"saaSApplicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"actionIds": [
"actionId1"
],
"roleId": "role1",
"roleName": "roleName1"
},
"name": "bayerAgPowered.gdu"
}
定义
名称 | 说明 |
---|---|
created |
创建资源的标识类型。 |
Data |
DataManagerForAgriculture 解决方案资源。 |
Data |
DataManagerForAgricultureSolution 属性。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Marketplace |
|
system |
与资源的创建和上次修改相关的元数据。 |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataManagerForAgricultureSolution
DataManagerForAgriculture 解决方案资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
name |
string |
资源的名称 |
properties |
DataManagerForAgricultureSolution 属性。 |
|
systemData |
与资源的创建和上次修改相关的元数据。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
DataManagerForAgricultureSolutionProperties
DataManagerForAgricultureSolution 属性。
名称 | 类型 | 说明 |
---|---|---|
accessFBApplicationId |
string |
合作伙伴用于访问 Data Manager For Agriculture 数据的多租户应用程序的应用程序 ID。 |
accessFBApplicationName |
string |
合作伙伴用于访问 Data Manager For Agriculture Data 的多租户应用程序的应用程序名称。 |
actionIds |
string[] |
使 SaaS 多租户应用程序访问相关 fb 数据所需的 ActionId 列表。 |
dataAccessScopes |
string[] |
获取处理合作伙伴的解决方案请求所需的数据管理器农业数据访问的范围。 示例:对于 gdd,它们可能需要 weatherScope 和 satelliteScope。 |
marketplaceOfferDetails | ||
openApiSpecsDictionary |
获取 api-version Swagger 文档字典,以捕获合作伙伴向 Data Manager For Agriculture 公开的所有 swagger API 版本。 |
|
partnerId |
string |
解决方案合作伙伴 ID。 |
partnerTenantId |
string |
解决方案合作伙伴租户 ID。 |
roleId |
string |
用于访问相关 fb 数据的 SaaS 多租户应用程序的角色 ID。 |
roleName |
string |
用于访问相关 fb 数据的 SaaS 多租户应用程序的角色名称。 |
saaSApplicationId |
string |
SaaS 多租户应用程序的应用程序 ID。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
MarketplaceOfferDetails
名称 | 类型 | 说明 |
---|---|---|
publisherId |
string |
|
saasOfferId |
string |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |