azure.agrifood.farming.operations package¶
-
class
azure.agrifood.farming.operations.
ApplicationDataOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sapplication_data
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, application_data_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create cascade delete job for application data resource.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
- Keyword Arguments
party_id (str) – Id of the party. Required.
application_data_id (str) – Id of the application data. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, application_data_id: str, application_data: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, application_data_id: str, application_data: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates an application data resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "applicationProductDetails": [ { "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "isCarrier": False, # Optional. Default value is False. A flag indicating whether product is a carrier for a tank mix. "productName": "str", # Optional. Name of the product applied. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
delete
(party_id: str, application_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified application data resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, application_data_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a specified application data resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "applicationProductDetails": [ { "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "isCarrier": False, # Optional. Default value is False. A flag indicating whether product is a carrier for a tank mix. "productName": "str", # Optional. Name of the product applied. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for application data resource.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of application data resources across all parties.
- Keyword Arguments
min_avg_material (float) – Minimum average amount of material applied during the application (inclusive). Default value is None.
max_avg_material (float) – Maximum average amount of material applied during the application (inclusive). Default value is None.
min_total_material (float) – Minimum total amount of material applied during the application (inclusive). Default value is None.
max_total_material (float) – Maximum total amount of material applied during the application (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "applicationProductDetails": [ { "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "isCarrier": False, # Optional. Default value is False. A flag indicating whether product is a carrier for a tank mix. "productName": "str", # Optional. Name of the product applied. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
list_by_party_id
(party_id: str, *, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of application data resources under a particular party.
- Parameters
party_id (str) – ID of the associated party. Required.
- Keyword Arguments
min_avg_material (float) – Minimum average amount of material applied during the application (inclusive). Default value is None.
max_avg_material (float) – Maximum average amount of material applied during the application (inclusive). Default value is None.
min_total_material (float) – Minimum total amount of material applied during the application (inclusive). Default value is None.
max_total_material (float) – Maximum total amount of material applied during the application (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "applicationProductDetails": [ { "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "isCarrier": False, # Optional. Default value is False. A flag indicating whether product is a carrier for a tank mix. "productName": "str", # Optional. Name of the product applied. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
-
class
azure.agrifood.farming.operations.
AttachmentsOperations
(*args, **kwargs)[source]¶ -
create_or_update
(party_id: str, attachment_id: str, attachment: collections.abc.MutableMapping[str, Any], file: IO, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Creates or updates a party resource.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
-
delete
(party_id: str, attachment_id: str, **kwargs: Any) → None[source]¶ Deletes a specified attachment resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
download
(party_id: str, attachment_id: str, **kwargs: Any) → Iterator[bytes][source]¶ Downloads and returns attachment as response for the given input filePath.
- Parameters
- Returns
Iterator of the response bytes
- Return type
Iterator[bytes]
- Raises
-
get
(party_id: str, attachment_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified attachment resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was created. "description": "str", # Optional. Textual description of resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique id. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was last modified. "name": "str", # Optional. Name to identify resource. "originalFileName": "str", # Optional. Original File Name for this attachment. "partyId": "str", # Optional. PartyId id for this attachment. "resourceId": "str", # Optional. Associated Resource id for this attachment. "resourceType": "str", # Optional. Associated Resource type for this attachment. Known values are: "Party", "Farm", "Field", "SeasonalField", "Boundary", "ApplicationData", "HarvestData", "TillageData", "PlantingData", and "PlantTissueAnalysis". "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list_by_party_id
(party_id: str, *, resource_ids: Optional[List[str]] = None, resource_types: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of attachment resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
resource_ids (list[str]) – Resource Ids of the resource. Default value is None.
resource_types (list[str]) – Resource Types of the resource. i.e. Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was created. "description": "str", # Optional. Textual description of resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique id. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was last modified. "name": "str", # Optional. Name to identify resource. "originalFileName": "str", # Optional. Original File Name for this attachment. "partyId": "str", # Optional. PartyId id for this attachment. "resourceId": "str", # Optional. Associated Resource id for this attachment. "resourceType": "str", # Optional. Associated Resource type for this attachment. Known values are: "Party", "Farm", "Field", "SeasonalField", "Boundary", "ApplicationData", "HarvestData", "TillageData", "PlantingData", and "PlantTissueAnalysis". "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
BoundariesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sboundaries
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, boundary_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified boundary.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
boundary_id (str) – ID of the boundary to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, boundary_id: str, boundary: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, boundary_id: str, boundary: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a boundary resource.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
-
delete
(party_id: str, boundary_id: str, **kwargs: Any) → None[source]¶ Deletes a specified boundary resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, boundary_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified boundary resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for specified boundary.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
get_overlap
(party_id: str, boundary_id: str, *, other_party_id: str, other_boundary_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Returns overlapping area between two boundary Ids.
- Parameters
- Keyword Arguments
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryArea": 0.0, # Optional. Acreage of Main boundary. "intersectingArea": 0.0, # Optional. Acreage of intersecting boundary. "otherBoundaryArea": 0.0 # Optional. Acreage of other boundary. }
-
list
(*, parent_type: Optional[str] = None, type: Optional[str] = None, parent_ids: Optional[List[str]] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of boundary resources across all parties.
- Keyword Arguments
parent_type (str) – Type of the parent it belongs to. Default value is None.
type (str) – Type it belongs to. Default value is None.
parent_ids (list[str]) – Parent Ids of the resource. Default value is None.
min_area (float) – Minimum area of the boundary (inclusive). Default value is None.
max_area (float) – Maximum acreage of the boundary (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Id of the parent it belongs to. "parentType": "str", # Optional. Type of the parent it belongs to. Known values are: "Field", "SeasonalField", "Zone", "Prescription", "PlantTissueAnalysis", "ApplicationData", "PlantingData", "TillageData", and "HarvestData". "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type it belongs to. }
-
list_by_party_id
(party_id: str, *, parent_type: Optional[str] = None, type: Optional[str] = None, parent_ids: Optional[List[str]] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of boundary resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
parent_type (str) – Type of the parent it belongs to. Default value is None.
type (str) – Type it belongs to. Default value is None.
parent_ids (list[str]) – Parent Ids of the resource. Default value is None.
min_area (float) – Minimum area of the boundary (inclusive). Default value is None.
max_area (float) – Maximum acreage of the boundary (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Id of the parent it belongs to. "parentType": "str", # Optional. Type of the parent it belongs to. Known values are: "Field", "SeasonalField", "Zone", "Prescription", "PlantTissueAnalysis", "ApplicationData", "PlantingData", "TillageData", and "HarvestData". "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type it belongs to. }
-
search
(search_boundary_query: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[JSON][source]¶ -
search
(search_boundary_query: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[JSON] Search for boundaries across all parties by fields and intersecting geometry.
- Parameters
search_boundary_query (JSON or IO) – Query filters. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Id of the parent it belongs to. "parentType": "str", # Optional. Type of the parent it belongs to. Known values are: "Field", "SeasonalField", "Zone", "Prescription", "PlantTissueAnalysis", "ApplicationData", "PlantingData", "TillageData", and "HarvestData". "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type it belongs to. }
-
search_by_party_id
(party_id: str, search_boundary_query: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[JSON][source]¶ -
search_by_party_id
(party_id: str, search_boundary_query: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[JSON] Search for boundaries by fields and intersecting geometry.
- Parameters
party_id (str) – Id of the party. Required.
search_boundary_query (JSON or IO) – Query filters. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Id of the parent it belongs to. "parentType": "str", # Optional. Type of the parent it belongs to. Known values are: "Field", "SeasonalField", "Zone", "Prescription", "PlantTissueAnalysis", "ApplicationData", "PlantingData", "TillageData", and "HarvestData". "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type it belongs to. }
-
-
class
azure.agrifood.farming.operations.
CropProductsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’scrop_products
attribute.-
create_or_update
(crop_product_id: str, crop_product: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(crop_product_id: str, crop_product: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a crop Product resource.
- Parameters
crop_product_id (str) – Id of the crop Product resource. Required.
crop_product (JSON or IO) – Crop Product resource payload to create or update. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "brand": "str", # Optional. CropProduct Brand. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropIds": [ "str" # Optional. Ids of the crops it belongs to."nNote: A maximum of 25 crops can be associated with a cropProduct. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "product": "str", # Optional. CropProduct product. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "relativeMaturity": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "trait": "str", # Optional. CropProduct trait. "treatments": [ "str" # Optional. CropProduct treatments. ] }
-
delete
(crop_product_id: str, **kwargs: Any) → None[source]¶ Deletes a specified crop Product resource.
- Parameters
crop_product_id (str) – Id of the crop Product. Required.
- Returns
None
- Return type
- Raises
-
get
(crop_product_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified crop Product resource.
- Parameters
crop_product_id (str) – Id of the crop Product. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "brand": "str", # Optional. CropProduct Brand. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropIds": [ "str" # Optional. Ids of the crops it belongs to."nNote: A maximum of 25 crops can be associated with a cropProduct. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "product": "str", # Optional. CropProduct product. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "relativeMaturity": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "trait": "str", # Optional. CropProduct trait. "treatments": [ "str" # Optional. CropProduct treatments. ] }
-
list
(*, crop_ids: Optional[List[str]] = None, brands: Optional[List[str]] = None, products: Optional[List[str]] = None, traits: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of crop product resources.
- Keyword Arguments
crop_ids (list[str]) – CropIds of the resource. Default value is None.
brands (list[str]) – Brands of the resource. Default value is None.
products (list[str]) – Products of the resource. Default value is None.
traits (list[str]) – Traits of the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "brand": "str", # Optional. CropProduct Brand. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropIds": [ "str" # Optional. Ids of the crops it belongs to."nNote: A maximum of 25 crops can be associated with a cropProduct. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "product": "str", # Optional. CropProduct product. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "relativeMaturity": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "trait": "str", # Optional. CropProduct trait. "treatments": [ "str" # Optional. CropProduct treatments. ] }
-
-
class
azure.agrifood.farming.operations.
CropsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’scrops
attribute.-
create_or_update
(crop_id: str, crop: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(crop_id: str, crop: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a crop resource.
- Parameters
crop_id (str) – Id of the crop resource. Required.
crop (JSON or IO) – Crop resource payload to create or update. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "breedingMethod": "str", # Optional. Breeding Method. Known values are: "VARIETY", "HYBRID", and "UNKNOWN". "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "phenotype": "str", # Optional. Crop phenotype. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
delete
(crop_id: str, **kwargs: Any) → None[source]¶ Deletes Crop for given crop id.
- Parameters
crop_id (str) – Id of crop to be deleted. Required.
- Returns
None
- Return type
- Raises
-
get
(crop_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified crop resource.
- Parameters
crop_id (str) – Id of the crop. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "breedingMethod": "str", # Optional. Breeding Method. Known values are: "VARIETY", "HYBRID", and "UNKNOWN". "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "phenotype": "str", # Optional. Crop phenotype. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list
(*, phenotypes: Optional[List[str]] = None, breeding_methods: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of crop resources.
- Keyword Arguments
phenotypes (list[str]) – Crop phenotypes of the resource. Default value is None.
breeding_methods (list[str]) – Breeding method of the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "breedingMethod": "str", # Optional. Breeding Method. Known values are: "VARIETY", "HYBRID", and "UNKNOWN". "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "phenotype": "str", # Optional. Crop phenotype. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
DeviceDataModelsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sdevice_data_models
attribute.-
create_or_update
(sensor_partner_id: str, device_data_model_id: str, device_data_model_object: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(sensor_partner_id: str, device_data_model_id: str, device_data_model_object: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Create a device data model entity.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "manufacturer": "str", # Optional. Device manufacturer. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "ports": [ { "name": "str", # Optional. Name of the port. "type": "str" # Optional. Type of port digital/analog. } ], "productCode": "str", # Optional. Device productCode. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of device. }
-
delete
(sensor_partner_id: str, device_data_model_id: str, **kwargs: Any) → None[source]¶ Deletes a device data model entity.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(sensor_partner_id: str, device_data_model_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a device data model entity.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "manufacturer": "str", # Optional. Device manufacturer. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "ports": [ { "name": "str", # Optional. Name of the port. "type": "str" # Optional. Type of port digital/analog. } ], "productCode": "str", # Optional. Device productCode. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of device. }
-
list
(sensor_partner_id: str, *, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of device data model resources.
- Parameters
sensor_partner_id (str) – Id of the associated sensor partner. Required.
- Keyword Arguments
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "manufacturer": "str", # Optional. Device manufacturer. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "ports": [ { "name": "str", # Optional. Name of the port. "type": "str" # Optional. Type of port digital/analog. } ], "productCode": "str", # Optional. Device productCode. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of device. }
-
-
class
azure.agrifood.farming.operations.
DevicesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sdevices
attribute.-
create_or_update
(sensor_partner_id: str, device_id: str, device_details: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(sensor_partner_id: str, device_id: str, device_details: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Create a device entity.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "deviceDataModelId": "str", # Optional. Id of the associated device data model. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "hardwareId": "str", # Optional. Device hardwareId. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Integration id for the device. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentDeviceId": "str", # Optional. Parent device Id for this device. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "reportingIntervalInSeconds": 0, # Optional. Interval at which the device sends data in seconds. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of device. }
-
delete
(sensor_partner_id: str, device_id: str, **kwargs: Any) → None[source]¶ Deletes a device entity.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(sensor_partner_id: str, device_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a device entity.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "deviceDataModelId": "str", # Optional. Id of the associated device data model. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "hardwareId": "str", # Optional. Device hardwareId. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Integration id for the device. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentDeviceId": "str", # Optional. Parent device Id for this device. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "reportingIntervalInSeconds": 0, # Optional. Interval at which the device sends data in seconds. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of device. }
-
list
(sensor_partner_id: str, *, parent_device_ids: Optional[List[str]] = None, device_data_model_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of device resources.
- Parameters
sensor_partner_id (str) – Id of the associated sensor partner. Required.
- Keyword Arguments
parent_device_ids (list[str]) – Id’s of the parent devices. Default value is None.
device_data_model_ids (list[str]) – Id’s of the device data models. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "deviceDataModelId": "str", # Optional. Id of the associated device data model. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "hardwareId": "str", # Optional. Device hardwareId. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Integration id for the device. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentDeviceId": "str", # Optional. Parent device Id for this device. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "reportingIntervalInSeconds": 0, # Optional. Interval at which the device sends data in seconds. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of device. }
-
-
class
azure.agrifood.farming.operations.
FarmOperationsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sfarm_operations
attribute.-
begin_create_data_ingestion_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_data_ingestion_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a farm operation data ingestion job.
- Parameters
job_id (str) – Job Id supplied by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "authProviderId": "str", # Authentication provider Id. Required. "partyId": "str", # Party Id. Required. "startYear": 0, # Start Year (Minimum = 2000, Maximum = CurrentYear). Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "isIncremental": False, # Optional. Default value is False. Use this to pull only the incremental changes from the last run. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "operations": [ "str" # Optional. List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_data_ingestion_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a farm operation data ingestion job.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "authProviderId": "str", # Authentication provider Id. Required. "partyId": "str", # Party Id. Required. "startYear": 0, # Start Year (Minimum = 2000, Maximum = CurrentYear). Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "isIncremental": False, # Optional. Default value is False. Use this to pull only the incremental changes from the last run. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "operations": [ "str" # Optional. List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
-
class
azure.agrifood.farming.operations.
FarmsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sfarms
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, farm_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified farm.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
farm_id (str) – ID of the farm to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, farm_id: str, farm: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, farm_id: str, farm: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a farm resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
delete
(party_id: str, farm_id: str, **kwargs: Any) → None[source]¶ Deletes a specified farm resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, farm_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified farm resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified farm.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of farm resources across all parties.
- Keyword Arguments
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list_by_party_id
(party_id: str, *, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of farm resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
FieldsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sfields
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, field_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified field.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
field_id (str) – ID of the field to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, field_id: str, field: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, field_id: str, field: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or Updates a field resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
delete
(party_id: str, field_id: str, **kwargs: Any) → None[source]¶ Deletes a specified field resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, field_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified field resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified field.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, farm_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of field resources across all parties.
- Keyword Arguments
farm_ids (list[str]) – Farm Ids of the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list_by_party_id
(party_id: str, *, farm_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of field resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
farm_ids (list[str]) – Farm Ids of the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
HarvestDataOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sharvest_data
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, harvest_data_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create cascade delete job for harvest data resource.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
- Keyword Arguments
party_id (str) – Id of the party. Required.
harvest_data_id (str) – Id of the harvest data. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, harvest_data_id: str, harvest_data: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, harvest_data_id: str, harvest_data: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates harvest data resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgSpeed": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "harvestProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
delete
(party_id: str, harvest_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified harvest data resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, harvest_data_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a specified harvest data resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgSpeed": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "harvestProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for harvest data resource.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, min_total_yield: Optional[float] = None, max_total_yield: Optional[float] = None, min_avg_yield: Optional[float] = None, max_avg_yield: Optional[float] = None, min_total_wet_mass: Optional[float] = None, max_total_wet_mass: Optional[float] = None, min_avg_wet_mass: Optional[float] = None, max_avg_wet_mass: Optional[float] = None, min_avg_moisture: Optional[float] = None, max_avg_moisture: Optional[float] = None, min_avg_speed: Optional[float] = None, max_avg_speed: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of harvest data resources across all parties.
- Keyword Arguments
min_total_yield (float) – Minimum Yield value(inclusive). Default value is None.
max_total_yield (float) – Maximum Yield value (inclusive). Default value is None.
min_avg_yield (float) – Minimum AvgYield value(inclusive). Default value is None.
max_avg_yield (float) – Maximum AvgYield value (inclusive). Default value is None.
min_total_wet_mass (float) – Minimum Total WetMass value(inclusive). Default value is None.
max_total_wet_mass (float) – Maximum Total WetMass value (inclusive). Default value is None.
min_avg_wet_mass (float) – Minimum AvgWetMass value(inclusive). Default value is None.
max_avg_wet_mass (float) – Maximum AvgWetMass value (inclusive). Default value is None.
min_avg_moisture (float) – Minimum AvgMoisture value(inclusive). Default value is None.
max_avg_moisture (float) – Maximum AvgMoisture value (inclusive). Default value is None.
min_avg_speed (float) – Minimum AvgSpeed value(inclusive). Default value is None.
max_avg_speed (float) – Maximum AvgSpeed value (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgSpeed": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "harvestProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
list_by_party_id
(party_id: str, *, min_total_yield: Optional[float] = None, max_total_yield: Optional[float] = None, min_avg_yield: Optional[float] = None, max_avg_yield: Optional[float] = None, min_total_wet_mass: Optional[float] = None, max_total_wet_mass: Optional[float] = None, min_avg_wet_mass: Optional[float] = None, max_avg_wet_mass: Optional[float] = None, min_avg_moisture: Optional[float] = None, max_avg_moisture: Optional[float] = None, min_avg_speed: Optional[float] = None, max_avg_speed: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of harvest data resources under a particular farm.
- Parameters
party_id (str) – ID of the associated party. Required.
- Keyword Arguments
min_total_yield (float) – Minimum Yield value(inclusive). Default value is None.
max_total_yield (float) – Maximum Yield value (inclusive). Default value is None.
min_avg_yield (float) – Minimum AvgYield value(inclusive). Default value is None.
max_avg_yield (float) – Maximum AvgYield value (inclusive). Default value is None.
min_total_wet_mass (float) – Minimum Total WetMass value(inclusive). Default value is None.
max_total_wet_mass (float) – Maximum Total WetMass value (inclusive). Default value is None.
min_avg_wet_mass (float) – Minimum AvgWetMass value(inclusive). Default value is None.
max_avg_wet_mass (float) – Maximum AvgWetMass value (inclusive). Default value is None.
min_avg_moisture (float) – Minimum AvgMoisture value(inclusive). Default value is None.
max_avg_moisture (float) – Maximum AvgMoisture value (inclusive). Default value is None.
min_avg_speed (float) – Minimum AvgSpeed value(inclusive). Default value is None.
max_avg_speed (float) – Maximum AvgSpeed value (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgSpeed": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "harvestProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalWetMass": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "totalYield": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
-
class
azure.agrifood.farming.operations.
ImageProcessingOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’simage_processing
attribute.-
begin_create_rasterize_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_rasterize_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a ImageProcessing Rasterize job.
- Parameters
job_id (str) – JobId provided by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "shapefileAttachmentId": "str", # Shapefile attachment Id. Required. "shapefileColumnNames": [ "str" # List of shapefile column names to create raster attachments. Required. ], "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_rasterize_job
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get ImageProcessing Rasterize job’s details.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "shapefileAttachmentId": "str", # Shapefile attachment Id. Required. "shapefileColumnNames": [ "str" # List of shapefile column names to create raster attachments. Required. ], "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
-
class
azure.agrifood.farming.operations.
InsightAttachmentsOperations
(*args, **kwargs)[source]¶ -
create_or_update
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_attachment_id: str, insight_attachment: collections.abc.MutableMapping[str, Any], file: IO, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Creates or updates a party resource.
- Parameters
party_id (str) – Id of the party resource. Required.
model_id (str) – Id of the model. Required.
resource_type (str) – Type of the resource the attachment is associated with, allowed values: Party, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis. Required.
resource_id (str) – Id of the resource insight attachment is associated with. Required.
insight_attachment_id (str) – Id of the attachment resource. Required.
insight_attachment (JSON) – Attachment resource payload to create or update. Is a model type. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
-
delete
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_attachment_id: str, **kwargs: Any) → None[source]¶ Deletes a specified insight resource.
- Parameters
party_id (str) – Id of the associated party. Required.
model_id (str) – Id of the associated model. It can be either ‘BiomassModelId’, ‘SensorPlacementModelId’, ‘SoilMoistureModelId’ or any solution id. Required.
resource_type (str) – Resource type associated with the record. Required.
resource_id (str) – Id of the associated resource. Required.
insight_attachment_id (str) – Id of the insight attachment resource. Required.
- Returns
None
- Return type
- Raises
-
download
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_attachment_id: str, **kwargs: Any) → Iterator[bytes][source]¶ Downloads and returns insight-attachment as response for the given input filePath.
- Parameters
party_id (str) – Id of the associated party. Required.
model_id (str) – Id of the associated model. It can be either ‘BiomassModelId’, ‘SensorPlacementModelId’, ‘SoilMoistureModelId’ or any solution id. Required.
resource_type (str) – Resource type associated with the record. Required.
resource_id (str) – Id of the associated resource. Required.
insight_attachment_id (str) – Id of the insight attachment resource. Required.
- Returns
Iterator of the response bytes
- Return type
Iterator[bytes]
- Raises
-
get
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_attachment_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified insight resource under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
model_id (str) – Id of the associated model. It can be either ‘BiomassModelId’, ‘SensorPlacementModelId’, ‘SoilMoistureModelId’ or any solution id. Required.
resource_type (str) – Resource type associated with the record. Required.
resource_id (str) – Id of the associated resource. Required.
insight_attachment_id (str) – Id of the insight attachment resource. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "insightId": "str", # InsightID for this InsightAttachment. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was created. "description": "str", # Optional. Textual description of resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique id. "modelId": "str", # Optional. ModelID for this InsightAttachment. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was last modified. "name": "str", # Optional. Name to identify resource. "originalFileName": "str", # Optional. Original File Name for this attachment. "partyId": "str", # Optional. PartyId id for this attachment. "resourceId": "str", # Optional. Associated Resource id for this attachment. "resourceType": "str", # Optional. Associated Resource type for this attachment. Known values are: "Party", "Farm", "Field", "SeasonalField", and "Boundary". "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list_by_party_id_model_id_and_resource
(party_id: str, model_id: str, resource_type: str, resource_id: str, *, insight_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of insight resources.
- Parameters
- Keyword Arguments
insight_ids (list[str]) – List of insight IDs. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "insightId": "str", # InsightID for this InsightAttachment. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was created. "description": "str", # Optional. Textual description of resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique id. "modelId": "str", # Optional. ModelID for this InsightAttachment. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date when resource was last modified. "name": "str", # Optional. Name to identify resource. "originalFileName": "str", # Optional. Original File Name for this attachment. "partyId": "str", # Optional. PartyId id for this attachment. "resourceId": "str", # Optional. Associated Resource id for this attachment. "resourceType": "str", # Optional. Associated Resource type for this attachment. Known values are: "Party", "Farm", "Field", "SeasonalField", and "Boundary". "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
InsightsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sinsights
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, model_id: str, resource_type: str, resource_id: str, insight_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
model_id (str) – Id of the associated model. Required.
resource_type (str) – Resource Type. Required.
resource_id (str) – Id of the associated resource. Required.
insight_id (str) – Insight id. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_id: str, insight_data: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_id: str, insight_data: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates insight entity.
- Parameters
party_id (str) – Id of the associated party. Required.
model_id (str) – Id of the associated model. It can be either ‘BiomassModelId’, ‘SensorPlacementModelId’, ‘SoilMoistureModelId’ or any solution id. Required.
resource_type (str) – Resource type associated with the record. Required.
resource_id (str) – Id of the associated resource. Required.
insight_id (str) – Id of the insight resource. Required.
insight_data (JSON or IO) – Insight data. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "attachmentsLink": "str", # Optional. Gets link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "insightEndDateTime": "2020-02-20 00:00:00", # Optional. End date to which the insight is related. "insightStartDateTime": "2020-02-20 00:00:00", # Optional. Start date to which the insight is related. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modelId": "str", # Optional. Id of the associated model. "modelVersion": "str", # Optional. Version of the associated model. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "resourceId": "str", # Optional. Id of the associated resource. "resourceType": "str", # Optional. Resource type associated with the record. Known values are: "Party", "Farm", "Field", "SeasonalField", and "Boundary". "status": "str" # Optional. Status of the resource. }
-
delete
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_id: str, **kwargs: Any) → None[source]¶ Deletes a specified insight resource.
- Parameters
party_id (str) – Id of the associated party. Required.
model_id (str) – Id of the associated model. It can be either ‘BiomassModelId’, ‘SensorPlacementModelId’, ‘SoilMoistureModelId’ or any solution id. Required.
resource_type (str) – Resource type associated with the record. Required.
resource_id (str) – Id of the associated resource. Required.
insight_id (str) – Id of the insight resource. Required.
- Returns
None
- Return type
- Raises
-
get
(party_id: str, model_id: str, resource_type: str, resource_id: str, insight_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified insight resource under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
model_id (str) – Id of the associated model. It can be either ‘BiomassModelId’, ‘SensorPlacementModelId’, ‘SoilMoistureModelId’ or any solution id. Required.
resource_type (str) – Resource type associated with the record. Required.
resource_id (str) – Id of the associated resource. Required.
insight_id (str) – Id of the insight resource. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "attachmentsLink": "str", # Optional. Gets link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "insightEndDateTime": "2020-02-20 00:00:00", # Optional. End date to which the insight is related. "insightStartDateTime": "2020-02-20 00:00:00", # Optional. Start date to which the insight is related. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modelId": "str", # Optional. Id of the associated model. "modelVersion": "str", # Optional. Version of the associated model. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "resourceId": "str", # Optional. Id of the associated resource. "resourceType": "str", # Optional. Resource type associated with the record. Known values are: "Party", "Farm", "Field", "SeasonalField", and "Boundary". "status": "str" # Optional. Status of the resource. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified insight.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list_by_party_id_model_id_and_resource
(party_id: str, model_id: str, resource_type: str, resource_id: str, *, min_insight_start_date_time: Optional[datetime.datetime] = None, max_insight_start_date_time: Optional[datetime.datetime] = None, min_insight_end_date_time: Optional[datetime.datetime] = None, max_insight_end_date_time: Optional[datetime.datetime] = None, measurement_filters: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of insight resources.
- Parameters
- Keyword Arguments
min_insight_start_date_time (datetime) – Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
max_insight_start_date_time (datetime) – Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
min_insight_end_date_time (datetime) – Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
max_insight_end_date_time (datetime) – Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
measurement_filters (list[str]) – Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. eg. “measureKey.unit eq {testValue}” where testValue is string. eg. “measureKey.value eq {testValue}” where testValue = double. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "attachmentsLink": "str", # Optional. Gets link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "insightEndDateTime": "2020-02-20 00:00:00", # Optional. End date to which the insight is related. "insightStartDateTime": "2020-02-20 00:00:00", # Optional. Start date to which the insight is related. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modelId": "str", # Optional. Id of the associated model. "modelVersion": "str", # Optional. Version of the associated model. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "resourceId": "str", # Optional. Id of the associated resource. "resourceType": "str", # Optional. Resource type associated with the record. Known values are: "Party", "Farm", "Field", "SeasonalField", and "Boundary". "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
ManagementZonesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’smanagement_zones
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, management_zone_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified management zone.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
management_zone_id (str) – ID of the management zone to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, management_zone_id: str, management_zone: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, management_zone_id: str, management_zone: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a management zone resource.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id associated with the ManagementZone. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id associated with the ManagementZone. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the ManagementZone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id associated with the ManagementZone. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the ManagementZone. }
-
delete
(party_id: str, management_zone_id: str, **kwargs: Any) → None[source]¶ Deletes a specified management zone resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, management_zone_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified management zone resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id associated with the ManagementZone. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id associated with the ManagementZone. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the ManagementZone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id associated with the ManagementZone. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the ManagementZone. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified job id.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, types: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of management zone resources across all parties.
- Keyword Arguments
types (list[str]) – Types of the ManagementZone. Default value is None.
crop_ids (list[str]) – CropIds of the ManagementZone. Default value is None.
season_ids (list[str]) – SeasonIds of the ManagementZone. Default value is None.
field_ids (list[str]) – FieldIds of the ManagementZone. Default value is None.
sources (list[str]) – Sources of the ManagementZone. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id associated with the ManagementZone. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id associated with the ManagementZone. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the ManagementZone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id associated with the ManagementZone. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the ManagementZone. }
-
list_by_party_id
(party_id: str, *, types: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of management zone resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
types (list[str]) – Types of the ManagementZone. Default value is None.
crop_ids (list[str]) – CropIds of the ManagementZone. Default value is None.
season_ids (list[str]) – SeasonIds of the ManagementZone. Default value is None.
field_ids (list[str]) – FieldIds of the ManagementZone. Default value is None.
sources (list[str]) – Sources of the ManagementZone. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id associated with the ManagementZone. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id associated with the ManagementZone. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the ManagementZone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id associated with the ManagementZone. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the ManagementZone. }
-
-
class
azure.agrifood.farming.operations.
ModelInferenceOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’smodel_inference
attribute.-
begin_create_biomass_model_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_biomass_model_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a Biomass Model job.
- Parameters
job_id (str) – JobId provided by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "boundaryId": "str", # The id of the boundary object for which biomass is being calculated. Required. "cropName": "str", # Crop name for biomass model. Available Value: Corn. Required. "Corn" "imageFormat": "str", # ImageFormat. Available value: TIF. Required. "TIF" "imageResolution": 0.0, # ImageResolution in meters. Available values: 10, 20, 60. Required. "inferenceEndDateTime": "2020-02-20 00:00:00", # End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ. Required. "modelVersion": "str", # The version of the biomass model to be run. Available Value: 1.0 . Required. "partyId": "str", # Party Id. Required. "plantingStartDateTime": "2020-02-20 00:00:00", # Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ. Required. "satelliteProvider": "str", # Provider of satellite data. Available Value: Microsoft. Required. "Microsoft" "satelliteSource": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "weatherExtensionId": "str", # ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
begin_create_sensor_placement_model_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_sensor_placement_model_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a Sensor Placement Model job.
- Parameters
job_id (str) – JobId provided by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "boundaryId": "str", # The id of the boundary object for which sensor placement is being calculated. Required. "inferenceEndDateTime": "2020-02-20 00:00:00", # End datetime for satellite data to be pulled. Required. "inferenceStartDateTime": "2020-02-20 00:00:00", # Start datetime for satellite data to be pulled. Required. "isRanked": bool, # IsRanked, if True the sensor placements will be ranked. Required. "modelVersion": "str", # The version of the sensor placement model to be run. Required. "partyId": "str", # Party Id. Required. "satelliteProvider": "str", # Provider of satellite data. Available Value: Microsoft. Required. "Microsoft" "satelliteSource": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "sensorType": "str", # SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
begin_create_soil_moisture_model_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_soil_moisture_model_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a SoilMoisture Model job.
- Parameters
job_id (str) – JobId provided by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "boundaryId": "str", # The id of the boundary object for which soil moisture is being calculated. Required. "imageFormat": "str", # ImageFormat. Available value: TIF. Required. "TIF" "imageResolution": 0.0, # ImageResolution in meters. Available values: 10, 20, 60. Required. "inferenceEndDateTime": "2020-02-20 00:00:00", # Inference end date time for soil moisture calculations. Required. "inferenceStartDateTime": "2020-02-20 00:00:00", # Inference start date time for soil moisture calculations. Required. "modelVersion": "str", # The version of the soil moisture model to be run. Required. "partyId": "str", # Party Id. Required. "satelliteProvider": "str", # Provider of satellite data. Available Value: Microsoft. Required. "Microsoft" "satelliteSource": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "sensorDataModelId": "str", # Sensor data model Id. Required. "sensorDefinition": { "maxProperty": "str", # The measurement name for maximum measurement value. Required. "minProperty": "str", # The measurement name for minimum measurement value. Required. "sensorMeasurement": "str" # The measurement name for sensor measure in sensorDataModel. Required. }, "sensorPartnerId": "str", # Sensor partner Id. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_biomass_model_job
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get Biomass Model job’s details.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # The id of the boundary object for which biomass is being calculated. Required. "cropName": "str", # Crop name for biomass model. Available Value: Corn. Required. "Corn" "imageFormat": "str", # ImageFormat. Available value: TIF. Required. "TIF" "imageResolution": 0.0, # ImageResolution in meters. Available values: 10, 20, 60. Required. "inferenceEndDateTime": "2020-02-20 00:00:00", # End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ. Required. "modelVersion": "str", # The version of the biomass model to be run. Available Value: 1.0 . Required. "partyId": "str", # Party Id. Required. "plantingStartDateTime": "2020-02-20 00:00:00", # Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ. Required. "satelliteProvider": "str", # Provider of satellite data. Available Value: Microsoft. Required. "Microsoft" "satelliteSource": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "weatherExtensionId": "str", # ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_sensor_placement_model_job
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get Sensor Placement Model job’s details.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # The id of the boundary object for which sensor placement is being calculated. Required. "inferenceEndDateTime": "2020-02-20 00:00:00", # End datetime for satellite data to be pulled. Required. "inferenceStartDateTime": "2020-02-20 00:00:00", # Start datetime for satellite data to be pulled. Required. "isRanked": bool, # IsRanked, if True the sensor placements will be ranked. Required. "modelVersion": "str", # The version of the sensor placement model to be run. Required. "partyId": "str", # Party Id. Required. "satelliteProvider": "str", # Provider of satellite data. Available Value: Microsoft. Required. "Microsoft" "satelliteSource": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "sensorType": "str", # SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_soil_moisture_model_job
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get SoilMoisture Model job’s details.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # The id of the boundary object for which soil moisture is being calculated. Required. "imageFormat": "str", # ImageFormat. Available value: TIF. Required. "TIF" "imageResolution": 0.0, # ImageResolution in meters. Available values: 10, 20, 60. Required. "inferenceEndDateTime": "2020-02-20 00:00:00", # Inference end date time for soil moisture calculations. Required. "inferenceStartDateTime": "2020-02-20 00:00:00", # Inference start date time for soil moisture calculations. Required. "modelVersion": "str", # The version of the soil moisture model to be run. Required. "partyId": "str", # Party Id. Required. "satelliteProvider": "str", # Provider of satellite data. Available Value: Microsoft. Required. "Microsoft" "satelliteSource": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "sensorDataModelId": "str", # Sensor data model Id. Required. "sensorDefinition": { "maxProperty": "str", # The measurement name for maximum measurement value. Required. "minProperty": "str", # The measurement name for minimum measurement value. Required. "sensorMeasurement": "str" # The measurement name for sensor measure in sensorDataModel. Required. }, "sensorPartnerId": "str", # Sensor partner Id. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
-
class
azure.agrifood.farming.operations.
NutrientAnalysesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’snutrient_analyses
attribute.-
create_or_update
(party_id: str, nutrient_analysis_id: str, nutrient_analysis: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, nutrient_analysis_id: str, nutrient_analysis: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a nutrient analysis resource.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "classification": "str", # Optional. Classification for this nutrient analysis. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Parent id for this nutrient analysis. "parentType": "str", # Optional. Parent type for this nutrient analysis."ni.e. PlantTissueAnalysis. "PlantTissueAnalysis" "partyId": "str", # Optional. Party id for this nutrient analysis. "products": [ { "instruction": "str", # Optional. Instruction of the resource. "product": "str", # Optional. Product of the resource. "rate": "str" # Optional. Rate of the product. } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "recommendation": "str", # Optional. Recommendation for this nutrient analysis. "referenceValueHigh": 0.0, # Optional. Reference value high for this nutrient analysis. "referenceValueLow": 0.0, # Optional. Reference value low for this nutrient analysis. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "unit": "str", # Optional. Unit for this nutrient analysis. "value": 0.0 # Optional. Value for this nutrient analysis. }
-
delete
(party_id: str, nutrient_analysis_id: str, **kwargs: Any) → None[source]¶ Deletes a specified nutrient analysis resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, nutrient_analysis_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified nutrient analysis resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "classification": "str", # Optional. Classification for this nutrient analysis. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Parent id for this nutrient analysis. "parentType": "str", # Optional. Parent type for this nutrient analysis."ni.e. PlantTissueAnalysis. "PlantTissueAnalysis" "partyId": "str", # Optional. Party id for this nutrient analysis. "products": [ { "instruction": "str", # Optional. Instruction of the resource. "product": "str", # Optional. Product of the resource. "rate": "str" # Optional. Rate of the product. } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "recommendation": "str", # Optional. Recommendation for this nutrient analysis. "referenceValueHigh": 0.0, # Optional. Reference value high for this nutrient analysis. "referenceValueLow": 0.0, # Optional. Reference value low for this nutrient analysis. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "unit": "str", # Optional. Unit for this nutrient analysis. "value": 0.0 # Optional. Value for this nutrient analysis. }
-
list
(*, parent_type: Optional[str] = None, parent_ids: Optional[List[str]] = None, classifications: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of nutrient analysis resources across all parties.
- Keyword Arguments
parent_type (str) – Type of the parent it belongs to. i.e. PlantTissueAnalysis. Default value is None.
parent_ids (list[str]) – Parent ids of the resource. Default value is None.
classifications (list[str]) – Classifications for nutrient analyses. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "classification": "str", # Optional. Classification for this nutrient analysis. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Parent id for this nutrient analysis. "parentType": "str", # Optional. Parent type for this nutrient analysis."ni.e. PlantTissueAnalysis. "PlantTissueAnalysis" "partyId": "str", # Optional. Party id for this nutrient analysis. "products": [ { "instruction": "str", # Optional. Instruction of the resource. "product": "str", # Optional. Product of the resource. "rate": "str" # Optional. Rate of the product. } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "recommendation": "str", # Optional. Recommendation for this nutrient analysis. "referenceValueHigh": 0.0, # Optional. Reference value high for this nutrient analysis. "referenceValueLow": 0.0, # Optional. Reference value low for this nutrient analysis. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "unit": "str", # Optional. Unit for this nutrient analysis. "value": 0.0 # Optional. Value for this nutrient analysis. }
-
list_by_party_id
(party_id: str, *, parent_type: Optional[str] = None, parent_ids: Optional[List[str]] = None, classifications: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of nutrient analysis resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
parent_type (str) – Type of the parent it belongs to. i.e. PlantTissueAnalysis. Default value is None.
parent_ids (list[str]) – Parent ids of the resource. Default value is None.
classifications (list[str]) – Classifications for nutrient analyses. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "classification": "str", # Optional. Classification for this nutrient analysis. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "parentId": "str", # Optional. Parent id for this nutrient analysis. "parentType": "str", # Optional. Parent type for this nutrient analysis."ni.e. PlantTissueAnalysis. "PlantTissueAnalysis" "partyId": "str", # Optional. Party id for this nutrient analysis. "products": [ { "instruction": "str", # Optional. Instruction of the resource. "product": "str", # Optional. Product of the resource. "rate": "str" # Optional. Rate of the product. } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "recommendation": "str", # Optional. Recommendation for this nutrient analysis. "referenceValueHigh": 0.0, # Optional. Reference value high for this nutrient analysis. "referenceValueLow": 0.0, # Optional. Reference value low for this nutrient analysis. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "unit": "str", # Optional. Unit for this nutrient analysis. "value": 0.0 # Optional. Value for this nutrient analysis. }
-
-
class
azure.agrifood.farming.operations.
OAuthProvidersOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’soauth_providers
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, oauth_provider_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create cascade delete job for oauthProvider resource.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
- Keyword Arguments
oauth_provider_id (str) – Id of the application data. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "oauthProviderId": "str", # The id of the oauth provider. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
create_or_update
(oauth_provider_id: str, oauth_provider: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(oauth_provider_id: str, oauth_provider: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates an oauthProvider resource.
- Parameters
oauth_provider_id (str) – ID of oauthProvider resource. Required.
oauth_provider (JSON or IO) – OauthProvider resource payload to create or update. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "apiKey": "str", # Optional. OAuth Api key for given Provider."nNote: currently Applicable to Climate provider. Won't be sent in response. "appId": "str", # Optional. OAuth App Id for given OAuth Provider. "appSecret": "str", # Optional. OAuth App secret for given Provider."nNote: Won't be sent in response. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique OAuth provider ID. "isProductionApp": False, # Optional. Default value is False. An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)"nNote: Currently applicable for JohnDeere. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. } }
-
delete
(oauth_provider_id: str, **kwargs: Any) → None[source]¶ Deletes an specified oauthProvider resource.
- Parameters
oauth_provider_id (str) – ID of oauthProvider. Required.
- Returns
None
- Return type
- Raises
-
get
(oauth_provider_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a specified oauthProvider resource.
- Parameters
oauth_provider_id (str) – ID of the oauthProvider resource. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "apiKey": "str", # Optional. OAuth Api key for given Provider."nNote: currently Applicable to Climate provider. Won't be sent in response. "appId": "str", # Optional. OAuth App Id for given OAuth Provider. "appSecret": "str", # Optional. OAuth App secret for given Provider."nNote: Won't be sent in response. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique OAuth provider ID. "isProductionApp": False, # Optional. Default value is False. An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)"nNote: Currently applicable for JohnDeere. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. } }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for oauthProvider resource.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "oauthProviderId": "str", # The id of the oauth provider. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
list
(*, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of oauthProvider resources.
- Keyword Arguments
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "apiKey": "str", # Optional. OAuth Api key for given Provider."nNote: currently Applicable to Climate provider. Won't be sent in response. "appId": "str", # Optional. OAuth App Id for given OAuth Provider. "appSecret": "str", # Optional. OAuth App secret for given Provider."nNote: Won't be sent in response. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique OAuth provider ID. "isProductionApp": False, # Optional. Default value is False. An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)"nNote: Currently applicable for JohnDeere. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. } }
-
-
class
azure.agrifood.farming.operations.
OAuthTokensOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’soauth_tokens
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, oauth_provider_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create remove job for OAuth token.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
- Keyword Arguments
party_id (str) – Id of the party. Required.
oauth_provider_id (str) – Id of the OAuthProvider. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get remove job for OAuth token.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
get_o_auth_connection_link
(oauth_connect_request: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → str[source]¶ -
get_o_auth_connection_link
(oauth_connect_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → str Returns Connection link needed in the OAuth flow.
- Parameters
oauth_connect_request (JSON or IO) – OAuth Connect Request. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
str
- Return type
- Raises
-
list
(*, auth_provider_ids: Optional[List[str]] = None, party_ids: Optional[List[str]] = None, is_valid: Optional[bool] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a list of OAuthToken documents.
- Keyword Arguments
auth_provider_ids (list[str]) – Name of AuthProvider. Default value is None.
party_ids (list[str]) – List of parties. Default value is None.
is_valid (bool) – If the token object is valid. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "authProviderId": "str", # ID of the OAuth provider resource containing app information. Required. "partyId": "str", # Party ID for this OAuth config. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "isValid": True, # Optional. Default value is True. An optional flag indicating whether the token is a valid or expired (Default value: true). "modifiedDateTime": "2020-02-20 00:00:00" # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. }
-
-
class
azure.agrifood.farming.operations.
PartiesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sparties
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified party.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the party to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, party: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, party: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a party resource.
- Parameters
party_id (str) – Id of the party resource. Required.
party (JSON or IO) – Party resource payload to create or update. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
delete
(party_id: str, **kwargs: Any) → None[source]¶ Deletes a specified party resource.
- Parameters
party_id (str) – Id of party to be deleted. Required.
- Returns
None
- Return type
- Raises
-
get
(party_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified party resource.
- Parameters
party_id (str) – ID of the associated party. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified party.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of party resources.
- Keyword Arguments
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
PlantTissueAnalysesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’splant_tissue_analyses
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, plant_tissue_analysis_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified plant tissue analysis.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
plant_tissue_analysis_id (str) – ID of the plant tissue analysis to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, plant_tissue_analysis_id: str, plant_tissue_analysis: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, plant_tissue_analysis_id: str, plant_tissue_analysis: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a plant tissue analysis resource.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the associated Crop. "cropProductId": "str", # Optional. Id of the associated Crop product. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Id of the associated Field. "growthStage": "str", # Optional. Growth stage for this plant tissue analysis. "id": "str", # Optional. Unique resource ID. "labDetails": { "address": "str", # Optional. Address of the resource. "code": "str", # Optional. Code of the resource. "description": "str", # Optional. Description of the resource. "name": "str" # Optional. Name of the resource. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated Party. "plantAppearance": "str", # Optional. Plant appearance for this plant tissue analysis. "plantPart": "str", # Optional. Plant part for this plant tissue analysis. "plantPosition": "str", # Optional. Plant position for this plant tissue analysis. "plantingDateTime": "2020-02-20 00:00:00", # Optional. Planting datetime for this plant tissue analysis. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sampleCollectionCondition": "str", # Optional. Sample collection condition for this plant tissue analysis. "sampleCollectionDateTime": "2020-02-20 00:00:00", # Optional. Sample collection dateTime for this plant tissue analysis. "sampleReceivedDateTime": "2020-02-20 00:00:00", # Optional. Sample received dateTime. "sampleTestResultDateTime": "2020-02-20 00:00:00", # Optional. Sample test result dateTime for this plant tissue analysis. "seasonId": "str", # Optional. Id of the associated Season. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
delete
(party_id: str, plant_tissue_analysis_id: str, **kwargs: Any) → None[source]¶ Deletes a specified plant tissue analysis resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, plant_tissue_analysis_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified plant tissue analysis resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the associated Crop. "cropProductId": "str", # Optional. Id of the associated Crop product. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Id of the associated Field. "growthStage": "str", # Optional. Growth stage for this plant tissue analysis. "id": "str", # Optional. Unique resource ID. "labDetails": { "address": "str", # Optional. Address of the resource. "code": "str", # Optional. Code of the resource. "description": "str", # Optional. Description of the resource. "name": "str" # Optional. Name of the resource. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated Party. "plantAppearance": "str", # Optional. Plant appearance for this plant tissue analysis. "plantPart": "str", # Optional. Plant part for this plant tissue analysis. "plantPosition": "str", # Optional. Plant position for this plant tissue analysis. "plantingDateTime": "2020-02-20 00:00:00", # Optional. Planting datetime for this plant tissue analysis. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sampleCollectionCondition": "str", # Optional. Sample collection condition for this plant tissue analysis. "sampleCollectionDateTime": "2020-02-20 00:00:00", # Optional. Sample collection dateTime for this plant tissue analysis. "sampleReceivedDateTime": "2020-02-20 00:00:00", # Optional. Sample received dateTime. "sampleTestResultDateTime": "2020-02-20 00:00:00", # Optional. Sample test result dateTime for this plant tissue analysis. "seasonId": "str", # Optional. Id of the associated Season. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified plant tissue analysis.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, season_ids: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, crop_products_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of plant tissue analysis resources across all parties.
- Keyword Arguments
season_ids (list[str]) – Season ids of the plant tissue analyses. Default value is None.
crop_ids (list[str]) – Crop ids of the plant tissue analyses. Default value is None.
crop_products_ids (list[str]) – Crop products ids of the plant tissue analyses. Default value is None.
field_ids (list[str]) – Field ids of the plant tissue analyses. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the associated Crop. "cropProductId": "str", # Optional. Id of the associated Crop product. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Id of the associated Field. "growthStage": "str", # Optional. Growth stage for this plant tissue analysis. "id": "str", # Optional. Unique resource ID. "labDetails": { "address": "str", # Optional. Address of the resource. "code": "str", # Optional. Code of the resource. "description": "str", # Optional. Description of the resource. "name": "str" # Optional. Name of the resource. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated Party. "plantAppearance": "str", # Optional. Plant appearance for this plant tissue analysis. "plantPart": "str", # Optional. Plant part for this plant tissue analysis. "plantPosition": "str", # Optional. Plant position for this plant tissue analysis. "plantingDateTime": "2020-02-20 00:00:00", # Optional. Planting datetime for this plant tissue analysis. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sampleCollectionCondition": "str", # Optional. Sample collection condition for this plant tissue analysis. "sampleCollectionDateTime": "2020-02-20 00:00:00", # Optional. Sample collection dateTime for this plant tissue analysis. "sampleReceivedDateTime": "2020-02-20 00:00:00", # Optional. Sample received dateTime. "sampleTestResultDateTime": "2020-02-20 00:00:00", # Optional. Sample test result dateTime for this plant tissue analysis. "seasonId": "str", # Optional. Id of the associated Season. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list_by_party_id
(party_id: str, *, season_ids: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, crop_products_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of plant tissue analysis resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
season_ids (list[str]) – Season ids of the plant tissue analyses. Default value is None.
crop_ids (list[str]) – Crop ids of the plant tissue analyses. Default value is None.
crop_products_ids (list[str]) – Crop products ids of the plant tissue analyses. Default value is None.
field_ids (list[str]) – Field ids of the plant tissue analyses. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the associated Crop. "cropProductId": "str", # Optional. Id of the associated Crop product. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Id of the associated Field. "growthStage": "str", # Optional. Growth stage for this plant tissue analysis. "id": "str", # Optional. Unique resource ID. "labDetails": { "address": "str", # Optional. Address of the resource. "code": "str", # Optional. Code of the resource. "description": "str", # Optional. Description of the resource. "name": "str" # Optional. Name of the resource. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated Party. "plantAppearance": "str", # Optional. Plant appearance for this plant tissue analysis. "plantPart": "str", # Optional. Plant part for this plant tissue analysis. "plantPosition": "str", # Optional. Plant position for this plant tissue analysis. "plantingDateTime": "2020-02-20 00:00:00", # Optional. Planting datetime for this plant tissue analysis. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sampleCollectionCondition": "str", # Optional. Sample collection condition for this plant tissue analysis. "sampleCollectionDateTime": "2020-02-20 00:00:00", # Optional. Sample collection dateTime for this plant tissue analysis. "sampleReceivedDateTime": "2020-02-20 00:00:00", # Optional. Sample received dateTime. "sampleTestResultDateTime": "2020-02-20 00:00:00", # Optional. Sample test result dateTime for this plant tissue analysis. "seasonId": "str", # Optional. Id of the associated Season. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
PlantingDataOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’splanting_data
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, planting_data_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create cascade delete job for planting data resource.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
- Keyword Arguments
party_id (str) – Id of the party. Required.
planting_data_id (str) – Id of the planting data. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, planting_data_id: str, planting_data: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, planting_data_id: str, planting_data: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates an planting data resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgPlantingRate": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "plantingProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
delete
(party_id: str, planting_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified planting data resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, planting_data_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a specified planting data resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgPlantingRate": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "plantingProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for planting data resource.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, min_avg_planting_rate: Optional[float] = None, max_avg_planting_rate: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of planting data resources across all parties.
- Keyword Arguments
min_avg_planting_rate (float) – Minimum AvgPlantingRate value(inclusive). Default value is None.
max_avg_planting_rate (float) – Maximum AvgPlantingRate value (inclusive). Default value is None.
min_total_material (float) – Minimum TotalMaterial value(inclusive). Default value is None.
max_total_material (float) – Maximum TotalMaterial value (inclusive). Default value is None.
min_avg_material (float) – Minimum AvgMaterial value(inclusive). Default value is None.
max_avg_material (float) – Maximum AvgMaterial value (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgPlantingRate": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "plantingProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
list_by_party_id
(party_id: str, *, min_avg_planting_rate: Optional[float] = None, max_avg_planting_rate: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of planting data resources under a particular party.
- Parameters
party_id (str) – ID of the associated party. Required.
- Keyword Arguments
min_avg_planting_rate (float) – Minimum AvgPlantingRate value(inclusive). Default value is None.
max_avg_planting_rate (float) – Maximum AvgPlantingRate value (inclusive). Default value is None.
min_total_material (float) – Minimum TotalMaterial value(inclusive). Default value is None.
max_total_material (float) – Maximum TotalMaterial value (inclusive). Default value is None.
min_avg_material (float) – Minimum AvgMaterial value(inclusive). Default value is None.
max_avg_material (float) – Maximum AvgMaterial value (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgPlantingRate": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "plantingProductDetails": [ { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "avgMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "productName": "str", # Optional. Name of the product. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } } ], "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "totalMaterial": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
-
class
azure.agrifood.farming.operations.
PrescriptionMapsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sprescription_maps
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, prescription_map_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified prescription map.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
prescription_map_id (str) – ID of the prescription map to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, prescription_map_id: str, prescription_map: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, prescription_map_id: str, prescription_map: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or Updates a prescription map resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription map type. }
-
delete
(party_id: str, prescription_map_id: str, **kwargs: Any) → None[source]¶ Deletes a specified prescription map resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, prescription_map_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified prescription map resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription map type. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified prescription map.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, types: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of prescription map resources across all parties.
- Keyword Arguments
types (list[str]) – Types of the resource. Default value is None.
crop_ids (list[str]) – Crop Ids of the resource. Default value is None.
season_ids (list[str]) – Season Ids of the resource. Default value is None.
field_ids (list[str]) – Field Ids of the resource. Default value is None.
sources (list[str]) – Sources for the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription map type. }
-
list_by_party_id
(party_id: str, *, types: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of prescription map resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
types (list[str]) – Types of the resource. Default value is None.
crop_ids (list[str]) – Crop Ids of the resource. Default value is None.
season_ids (list[str]) – Season Ids of the resource. Default value is None.
field_ids (list[str]) – Field Ids of the resource. Default value is None.
sources (list[str]) – Sources for the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Crop Id. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "fieldId": "str", # Optional. Field Id. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Season Id. "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription map type. }
-
-
class
azure.agrifood.farming.operations.
PrescriptionsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sprescriptions
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, prescription_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified prescription.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
prescription_id (str) – ID of the prescription to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, prescription_id: str, prescription: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, prescription_id: str, prescription: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or Updates a prescription resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "prescriptionMapId": "str", # Optional. Prescription map Id. "productCode": "str", # Optional. Product Code. "productName": "str", # Optional. Product name. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription type. }
-
delete
(party_id: str, prescription_id: str, **kwargs: Any) → None[source]¶ Deletes a specified prescription resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, prescription_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified prescription resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "prescriptionMapId": "str", # Optional. Prescription map Id. "productCode": "str", # Optional. Product Code. "productName": "str", # Optional. Product name. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription type. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified prescription.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, prescription_map_ids: Optional[List[str]] = None, types: Optional[List[str]] = None, product_codes: Optional[List[str]] = None, product_names: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of prescription resources across all parties.
- Keyword Arguments
prescription_map_ids (list[str]) – Prescription Map Ids of the resource. Default value is None.
types (list[str]) – Types of the resource. Default value is None.
product_codes (list[str]) – Product Codes of the resource. Default value is None.
product_names (list[str]) – Product Names of the resource. Default value is None.
sources (list[str]) – Sources for the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "prescriptionMapId": "str", # Optional. Prescription map Id. "productCode": "str", # Optional. Product Code. "productName": "str", # Optional. Product name. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription type. }
-
list_by_party_id
(party_id: str, *, prescription_map_ids: Optional[List[str]] = None, types: Optional[List[str]] = None, product_codes: Optional[List[str]] = None, product_names: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of prescription resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
prescription_map_ids (list[str]) – Prescription Map Ids of the resource. Default value is None.
types (list[str]) – Types of the resource. Default value is None.
product_codes (list[str]) – Product Codes of the resource. Default value is None.
product_names (list[str]) – Product Names of the resource. Default value is None.
sources (list[str]) – Sources for the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "measurements": { "str": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "prescriptionMapId": "str", # Optional. Prescription map Id. "productCode": "str", # Optional. Product Code. "productName": "str", # Optional. Product name. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Prescription type. }
-
-
class
azure.agrifood.farming.operations.
ScenesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sscenes
attribute.-
begin_create_satellite_data_ingestion_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_satellite_data_ingestion_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a satellite data ingestion job.
- Parameters
job_id (str) – JobId provided by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "boundaryId": "str", # The id of the boundary object for which satellite data is being fetched. Required. "endDateTime": "2020-02-20 00:00:00", # End Date. Required. "partyId": "str", # Party Id. Required. "source": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "startDateTime": "2020-02-20 00:00:00", # Start Date. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "data": { "imageFormats": [ "str" # Optional. List of ImageFormats. Available value: TIF. ], "imageNames": [ "str" # Optional. List of ImageNames. ], "imageResolutions": [ 0.0 # Optional. List of ImageResolutions in meters. Available values: 10, 20, 60. ] }, "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "provider": "str", # Optional. Provider of satellite data. Available Value: Microsoft. "Microsoft" "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
download
(*, file_path: str, **kwargs: Any) → Iterator[bytes][source]¶ Downloads and returns file Stream as response for the given input filePath.
-
get_satellite_data_ingestion_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a satellite data ingestion job.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # The id of the boundary object for which satellite data is being fetched. Required. "endDateTime": "2020-02-20 00:00:00", # End Date. Required. "partyId": "str", # Party Id. Required. "source": "str", # Source of satellite data. Available Value: Sentinel_2_L2A. Required. Known values are: "Sentinel_2_L2A" and "Sentinel_2_L1C". "startDateTime": "2020-02-20 00:00:00", # Start Date. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "data": { "imageFormats": [ "str" # Optional. List of ImageFormats. Available value: TIF. ], "imageNames": [ "str" # Optional. List of ImageNames. ], "imageResolutions": [ 0.0 # Optional. List of ImageResolutions in meters. Available values: 10, 20, 60. ] }, "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "provider": "str", # Optional. Provider of satellite data. Available Value: Microsoft. "Microsoft" "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_stac_feature
(collection_id: str, feature_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "assets": { "str": { "href": "str", # Link to the asset object. Required. "description": "str", # Optional. A description of the Asset providing additional details, such as how it was processed or created. "roles": [ "str" # Optional. The semantic roles of the asset, similar to the use of rel in links. ], "title": "str", # Optional. The displayed title for clients and users. "type": "str" # Optional. Media type of the asset. } }, "id": "str", # Provider identifier. Globally unique ID by Data provider. Required. "links": [ { "href": "str", # The actual link in the format of an URL. Required. "rel": "str", # Relationship between the current document and the linked document. Required. "title": "str", # Optional. A human readable title to be used in rendered displays of the link. "type": "str" # Optional. Media type of the referenced entity. } ], "properties": {}, # A dictionary of additional metadata for the item. Required. "stacVersion": "str", # The STAC version the Feature implements. Required. "type": "str", # Type of the GeoJSON Object. It's value is always Feature. Required. "bbox": [ 0.0 # Optional. Bounding box of the feature. ], "collection": "str", # Optional. The id of the STAC Collection this Feature references. "geometry": {}, # Optional. Defines the full footprint of the asset represented by this item."nIts a GeoJSON geometry. "stacExtensions": [ "str" # Optional. A list of extensions the Feature implements. ] }
-
list
(*, provider: str, party_id: str, boundary_id: str, source: str, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, max_cloud_coverage_percentage: float = 100, max_dark_pixel_coverage_percentage: float = 100, image_names: Optional[List[str]] = None, image_resolutions: Optional[List[float]] = None, image_formats: Optional[List[str]] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of scene resources.
- Keyword Arguments
provider (str) – Provider name of scene data. Required.
party_id (str) – PartyId. Required.
boundary_id (str) – BoundaryId. Required.
source (str) – Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C. Required.
start_date_time (datetime) – Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ. Default value is None.
end_date_time (datetime) – Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ. Default value is None.
max_cloud_coverage_percentage (float) – Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. Default value is 100.
max_dark_pixel_coverage_percentage (float) – Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. Default value is 100.
image_names (list[str]) – List of image names to be filtered. Default value is None.
image_resolutions (list[float]) – List of image resolutions in meters to be filtered. Default value is None.
image_formats (list[str]) – List of image formats to be filtered. Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # Optional. Boundary ID which belongs to the scene. "cloudCoverPercentage": 0.0, # Optional. Cloud cover percentage of the scene. "darkPixelPercentage": 0.0, # Optional. Dark pixel percentage of the scene. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique scene resource ID. "imageFiles": [ { "name": "str", # Name of the image file. Required. "fileLink": "str", # Optional. Link of the image file. "imageFormat": "str", # Optional. ImageFormat. Available value: TIF. "TIF" "resolution": 0.0 # Optional. Resolution of image file in meters. } ], "imageFormat": "str", # Optional. ImageFormat. Available value: TIF. "TIF" "ndviMedianValue": 0.0, # Optional. Median of NDVI of the scene. "partyId": "str", # Optional. Party ID which belongs to the scene. "provider": "str", # Optional. Data provider of the scene. "sceneDateTime": "2020-02-20 00:00:00", # Optional. Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ. "source": "str" # Optional. Data source of the scene. }
-
search_features
(collection_id: str, search_features_query: JSON, *, maxpagesize: int = '10', skip: Optional[int] = 'None', content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶ -
search_features
(collection_id: str, search_features_query: IO, *, maxpagesize: int = '10', skip: Optional[int] = 'None', content_type: str = "'application/json'", **kwargs: Any) → JSON Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.
- Parameters
collection_id (str) – Collection Id to be searched. Known values are: “Sentinel_2_L2A” and “Sentinel_2_L1C”. Required.
search_features_query (JSON or IO) – Query filters. Is either a model type or a IO type. Required.
- Keyword Arguments
maxpagesize (int) – Maximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10. Default value is 10.
skip (int) – Skip token for getting next set of results. Default value is None.
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "features": [ { "assets": { "str": { "href": "str", # Link to the asset object. Required. "description": "str", # Optional. A description of the Asset providing additional details, such as how it was processed or created. "roles": [ "str" # Optional. The semantic roles of the asset, similar to the use of rel in links. ], "title": "str", # Optional. The displayed title for clients and users. "type": "str" # Optional. Media type of the asset. } }, "id": "str", # Provider identifier. Globally unique ID by Data provider. Required. "links": [ { "href": "str", # The actual link in the format of an URL. Required. "rel": "str", # Relationship between the current document and the linked document. Required. "title": "str", # Optional. A human readable title to be used in rendered displays of the link. "type": "str" # Optional. Media type of the referenced entity. } ], "properties": {}, # A dictionary of additional metadata for the item. Required. "stacVersion": "str", # The STAC version the Feature implements. Required. "type": "str", # Type of the GeoJSON Object. It's value is always Feature. Required. "bbox": [ 0.0 # Optional. Bounding box of the feature. ], "collection": "str", # Optional. The id of the STAC Collection this Feature references. "geometry": {}, # Optional. Defines the full footprint of the asset represented by this item."nIts a GeoJSON geometry. "stacExtensions": [ "str" # Optional. A list of extensions the Feature implements. ] } ], "nextLink": "str" # Optional. URL to do the POST request with same filters,"nto get next set of features. }
-
-
class
azure.agrifood.farming.operations.
SeasonalFieldsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sseasonal_fields
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, seasonal_field_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified seasonal field.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
seasonal_field_id (str) – ID of the seasonalField to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, seasonal_field_id: str, seasonal_field: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, seasonal_field_id: str, seasonal_field: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or Updates a seasonal field resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the crop it belongs to. "cropProductIds": [ "str" # Optional. CropProduct ids. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "fieldId": "str", # Optional. Id of the associated Field. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Id of the season it belongs to. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
delete
(party_id: str, seasonal_field_id: str, **kwargs: Any) → None[source]¶ Deletes a specified seasonal-field resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, seasonal_field_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified seasonal field resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the crop it belongs to. "cropProductIds": [ "str" # Optional. CropProduct ids. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "fieldId": "str", # Optional. Id of the associated Field. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Id of the season it belongs to. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for specified seasonal field.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, farm_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, crop_product_ids: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of seasonal field resources across all parties.
- Keyword Arguments
farm_ids (list[str]) – Farm Ids of the resource. Default value is None.
field_ids (list[str]) – Field Ids of the resource. Default value is None.
season_ids (list[str]) – Season Ids of the resource. Default value is None.
crop_product_ids (list[str]) – CropProductIds of the resource. Default value is None.
crop_ids (list[str]) – Ids of the crop it belongs to. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the crop it belongs to. "cropProductIds": [ "str" # Optional. CropProduct ids. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "fieldId": "str", # Optional. Id of the associated Field. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Id of the season it belongs to. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
list_by_party_id
(party_id: str, *, farm_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, crop_product_ids: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of seasonal field resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
farm_ids (list[str]) – Farm Ids of the resource. Default value is None.
field_ids (list[str]) – Field Ids of the resource. Default value is None.
season_ids (list[str]) – Season Ids of the resource. Default value is None.
crop_product_ids (list[str]) – CropProductIds of the resource. Default value is None.
crop_ids (list[str]) – Ids of the crop it belongs to. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "cropId": "str", # Optional. Id of the crop it belongs to. "cropProductIds": [ "str" # Optional. CropProduct ids. ], "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "farmId": "str", # Optional. Id of the associated Farm. "fieldId": "str", # Optional. Id of the associated Field. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "seasonId": "str", # Optional. Id of the season it belongs to. "source": "str", # Optional. Source of the resource. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
SeasonsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sseasons
attribute.-
create_or_update
(season_id: str, season: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(season_id: str, season: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a season resource.
- Parameters
season_id (str) – Id of the season resource. Required.
season (JSON or IO) – Season resource payload to create or update. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "endDateTime": "2020-02-20 00:00:00", # Optional. Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. "geographicIdentifier": "str", # Optional. Geographic Identifier. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "startDateTime": "2020-02-20 00:00:00", # Optional. Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str", # Optional. Status of the resource. "year": 0 # Optional. Season year. }
-
delete
(season_id: str, **kwargs: Any) → None[source]¶ Deletes a specified season resource.
- Parameters
season_id (str) – Id of the season. Required.
- Returns
None
- Return type
- Raises
-
get
(season_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified season resource.
- Parameters
season_id (str) – Id of the season. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "endDateTime": "2020-02-20 00:00:00", # Optional. Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. "geographicIdentifier": "str", # Optional. Geographic Identifier. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "startDateTime": "2020-02-20 00:00:00", # Optional. Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str", # Optional. Status of the resource. "year": 0 # Optional. Season year. }
-
list
(*, min_start_date_time: Optional[datetime.datetime] = None, max_start_date_time: Optional[datetime.datetime] = None, min_end_date_time: Optional[datetime.datetime] = None, max_end_date_time: Optional[datetime.datetime] = None, years: Optional[List[int]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of season resources.
- Keyword Arguments
min_start_date_time (datetime) – Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
max_start_date_time (datetime) – Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
min_end_date_time (datetime) – Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
max_end_date_time (datetime) – Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
years (list[int]) – Years of the resource. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "endDateTime": "2020-02-20 00:00:00", # Optional. Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. "geographicIdentifier": "str", # Optional. Geographic Identifier. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "startDateTime": "2020-02-20 00:00:00", # Optional. Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str", # Optional. Status of the resource. "year": 0 # Optional. Season year. }
-
-
class
azure.agrifood.farming.operations.
SensorDataModelsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’ssensor_data_models
attribute.-
create_or_update
(sensor_partner_id: str, sensor_data_model_id: str, sensor_data_model_object: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(sensor_partner_id: str, sensor_data_model_id: str, sensor_data_model_object: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Create a sensor data model entity.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "measures": { "str": { "dataType": "str", # Sensor measure data type. Required. Known values are: "Bool", "Double", "DateTime", "Long", and "String". "description": "str", # Optional. Description of sensor measure. "properties": { "str": {} # Optional. A collection of key value pairs for sensor data model."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a model and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "type": "str", # Optional. Measurement type of sensor data. "unit": "str" # Optional. Unit of sensor measure. } }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "manufacturer": "str", # Optional. Sensor manufacturer. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "productCode": "str", # Optional. Sensor productCode. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of sensor. }
-
delete
(sensor_partner_id: str, sensor_data_model_id: str, **kwargs: Any) → None[source]¶ Deletes a sensor data model entity.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(sensor_partner_id: str, sensor_data_model_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a sensor data model entity.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "measures": { "str": { "dataType": "str", # Sensor measure data type. Required. Known values are: "Bool", "Double", "DateTime", "Long", and "String". "description": "str", # Optional. Description of sensor measure. "properties": { "str": {} # Optional. A collection of key value pairs for sensor data model."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a model and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "type": "str", # Optional. Measurement type of sensor data. "unit": "str" # Optional. Unit of sensor measure. } }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "manufacturer": "str", # Optional. Sensor manufacturer. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "productCode": "str", # Optional. Sensor productCode. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of sensor. }
-
list
(sensor_partner_id: str, *, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of sensor data model resources.
- Parameters
sensor_partner_id (str) – Id of the associated sensor partner. Required.
- Keyword Arguments
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "measures": { "str": { "dataType": "str", # Sensor measure data type. Required. Known values are: "Bool", "Double", "DateTime", "Long", and "String". "description": "str", # Optional. Description of sensor measure. "properties": { "str": {} # Optional. A collection of key value pairs for sensor data model."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a model and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "type": "str", # Optional. Measurement type of sensor data. "unit": "str" # Optional. Unit of sensor measure. } }, "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "manufacturer": "str", # Optional. Sensor manufacturer. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "productCode": "str", # Optional. Sensor productCode. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of sensor. }
-
-
class
azure.agrifood.farming.operations.
SensorEventsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’ssensor_events
attribute.-
list
(*, sensor_id: str, sensor_partner_id: str, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, exclude_duplicate_events: bool = True, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Returns a list of sensor events data. Time span for query is limited to 90 days at a time. Returns last 90 days events when startDateTime and endDateTime are not provided.
- Keyword Arguments
sensor_id (str) – Id of the associated sensor. Required.
sensor_partner_id (str) – Id of the associated sensor partner. Required.
start_date_time (datetime) – Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. It is truncated upto seconds if fraction is provided. Default value is None.
end_date_time (datetime) – Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. It is truncated upto seconds if fraction is provided. Default value is None.
exclude_duplicate_events (bool) – Flag to exclude duplicate events and take the latest ones only (Default: true). Default value is True.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "value": [ { "boundaryId": "str", # Optional. Id of the associated boundary. "eventDateTime": "2020-02-20 00:00:00", # Optional. DateTime of sensor event observation. "ingestionDateTime": "2020-02-20 00:00:00", # Optional. DateTime of sensor event ingestion to data store. "measures": { "str": {} # Optional. Sensor measures. }, "partyId": "str", # Optional. Id of the associated party. "sensorId": "str", # Optional. Id of the sensor. "sensorPartnerId": "str" # Optional. Id of the sensor partner. } ], "nextLink": "str", # Optional. Continuation link (absolute URI) to the next page of results in the list. "skipToken": "str" # Optional. Token used in retrieving the next page. If null, there are no additional pages. }
-
-
class
azure.agrifood.farming.operations.
SensorMappingsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’ssensor_mappings
attribute.-
create_or_update
(sensor_mapping_id: str, sensor_mapping_object: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(sensor_mapping_id: str, sensor_mapping_object: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Create a sensor mapping entity.
- Parameters
sensor_mapping_id (str) – Id of the sensor mapping. Required.
sensor_mapping_object (JSON or IO) – Sensor mapping object details. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "boundaryId": "str", # Optional. Id of the associated boundary. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorId": "str", # Optional. Id of the associated sensor. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str" # Optional. Status of the resource. }
-
delete
(sensor_mapping_id: str, **kwargs: Any) → None[source]¶ Deletes a sensor mapping entity.
- Parameters
sensor_mapping_id (str) – Id of the sensor mapping resource. Required.
- Returns
None
- Return type
- Raises
-
get
(sensor_mapping_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a sensor mapping entity.
- Parameters
sensor_mapping_id (str) – Id of the sensor mapping resource. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # Optional. Id of the associated boundary. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorId": "str", # Optional. Id of the associated sensor. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str" # Optional. Status of the resource. }
-
list
(*, sensor_ids: Optional[List[str]] = None, sensor_partner_ids: Optional[List[str]] = None, party_ids: Optional[List[str]] = None, boundary_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of sensor mapping resources.
- Keyword Arguments
sensor_ids (list[str]) – Id of the sensors. Default value is None.
sensor_partner_ids (list[str]) – Id of the sensor partners. Default value is None.
party_ids (list[str]) – Id of the parties. Default value is None.
boundary_ids (list[str]) – Id of the boundaries. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # Optional. Id of the associated boundary. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the associated party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorId": "str", # Optional. Id of the associated sensor. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
SensorPartnerIntegrationsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’ssensor_partner_integrations
attribute.-
check_consent
(sensor_partner_id: str, integration_id: str, *, key: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Checks consent for partner integration.
- Parameters
- Keyword Arguments
key (str) – Partner integration key. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "consented": bool, # Optional. Flag to determine the status of partner integration consent. "integrationId": "str", # Optional. Id of the integration. "sensorPartnerId": "str" # Optional. Id of the associated sensor partner. }
-
create_or_update
(sensor_partner_id: str, integration_id: str, sensor_partner_integration_model: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(sensor_partner_id: str, integration_id: str, sensor_partner_integration_model: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Create or update an integration with a sensor partner.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Id of the integration. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str" # Optional. Status of the resource. }
-
delete
(sensor_partner_id: str, integration_id: str, **kwargs: Any) → None[source]¶ Deletes a partner integration model entity.
- Parameters
- Returns
None
- Return type
- Raises
-
generate_consent_link
(sensor_partner_id: str, integration_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Generates partner integration consent link.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "consentExpiryDateTime": "2020-02-20 00:00:00", # Optional. Consent expiry date time, sample format: yyyy-MM-ddTHH:mm:ssZ. "consentLink": "str" # Optional. Consent link. }
-
get
(sensor_partner_id: str, integration_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a partner integration model entity.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Id of the integration. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str" # Optional. Status of the resource. }
-
list
(sensor_partner_id: str, *, integration_ids: Optional[List[str]] = None, party_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Gets partner integration models.
- Parameters
sensor_partner_id (str) – Id of the associated sensor partner. Required.
- Keyword Arguments
integration_ids (list[str]) – Ids of the partner integration models. Default value is None.
party_ids (list[str]) – Ids of the parties. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Id of the integration. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Id of the party. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str" # Optional. Status of the resource. }
-
-
class
azure.agrifood.farming.operations.
SensorsOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’ssensors
attribute.-
create_or_update
(sensor_partner_id: str, sensor_id: str, sensor_details: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(sensor_partner_id: str, sensor_id: str, sensor_details: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Create a sensor entity.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "depthInMeters": [ 0.0 # Optional. Depth of each sensor measure in meters."nLike sensor moisture at 2m, 4m, 6m. ], "description": "str", # Optional. Textual description of the resource. "deviceId": "str", # Optional. Id of the associated device. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "hardwareId": "str", # Optional. Id of the associated hardware. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Integration id for the device. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "port": { "name": "str", # Optional. Name of the port. "type": "str" # Optional. Type of port digital/analog. }, "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorDataModelId": "str", # Optional. Id of the associated sensor data model. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of sensor. }
-
delete
(sensor_partner_id: str, sensor_id: str, **kwargs: Any) → None[source]¶ Deletes a sensor entity.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(sensor_partner_id: str, sensor_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a sensor entity.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "depthInMeters": [ 0.0 # Optional. Depth of each sensor measure in meters."nLike sensor moisture at 2m, 4m, 6m. ], "description": "str", # Optional. Textual description of the resource. "deviceId": "str", # Optional. Id of the associated device. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "hardwareId": "str", # Optional. Id of the associated hardware. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Integration id for the device. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "port": { "name": "str", # Optional. Name of the port. "type": "str" # Optional. Type of port digital/analog. }, "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorDataModelId": "str", # Optional. Id of the associated sensor data model. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of sensor. }
-
get_connection_string
(sensor_partner_id: str, sensor_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a sensor connection string.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "primaryDeviceConnectionString": "str", # Optional. Primary connection string of the ioTHub device. "secondaryDeviceConnectionString": "str" # Optional. Secondary connection string of the ioTHub device. }
-
list
(sensor_partner_id: str, *, sensor_data_model_ids: Optional[List[str]] = None, sensor_mapping_ids: Optional[List[str]] = None, device_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of sensor resources.
- Parameters
sensor_partner_id (str) – Id of the associated sensor partner. Required.
- Keyword Arguments
sensor_data_model_ids (list[str]) – Id’s of the sensor data models. Default value is None.
sensor_mapping_ids (list[str]) – Ids of the sensor mappings. Default value is None.
device_ids (list[str]) – Id’s of the devices. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "depthInMeters": [ 0.0 # Optional. Depth of each sensor measure in meters."nLike sensor moisture at 2m, 4m, 6m. ], "description": "str", # Optional. Textual description of the resource. "deviceId": "str", # Optional. Id of the associated device. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "hardwareId": "str", # Optional. Id of the associated hardware. "id": "str", # Optional. Id of the resource. "integrationId": "str", # Optional. Integration id for the device. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "port": { "name": "str", # Optional. Name of the port. "type": "str" # Optional. Type of port digital/analog. }, "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and"nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "sensorDataModelId": "str", # Optional. Id of the associated sensor data model. "sensorPartnerId": "str", # Optional. Id of the associated sensor partner. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of sensor. }
-
renew_connection_string
(sensor_partner_id: str, sensor_id: str, renew_connection_string_model: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶ -
renew_connection_string
(sensor_partner_id: str, sensor_id: str, renew_connection_string_model: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON Renews a sensor connection string.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "primaryDeviceConnectionString": "str", # Optional. Primary connection string of the ioTHub device. "secondaryDeviceConnectionString": "str" # Optional. Secondary connection string of the ioTHub device. }
-
-
class
azure.agrifood.farming.operations.
SolutionInferenceOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’ssolution_inference
attribute.-
begin_create_or_update
(solution_id: str, solution_inference_request: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[Dict[str, Any]][source]¶ -
begin_create_or_update
(solution_id: str, solution_inference_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[Dict[str, Any]] Creates a job trigger for a solution.
- Parameters
solution_id (str) – Id of the solution resource. Required.
solution_inference_request (JSON or IO) – solutionInferenceRequest containing input needed for job request processing. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns dict mapping str to any
- Return type
- Raises
Example
# response body for status code(s): 202 response == { "str": {} # Optional. }
-
cancel
(solution_id: str, solution_inference_request: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → Dict[str, Any][source]¶ -
cancel
(solution_id: str, solution_inference_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Dict[str, Any] Cancels a job for given solution id.
- Parameters
solution_id (str) – Id of solution for which job is to be cancelled. Required.
solution_inference_request (JSON or IO) – solutionInferenceRequest containing input needed for job request processing. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
dict mapping str to any
- Return type
- Raises
Example
# response body for status code(s): 200 response == { "str": {} # Optional. }
-
fetch
(solution_id: str, solution_inference_request: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → Dict[str, Any][source]¶ -
fetch
(solution_id: str, solution_inference_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Dict[str, Any] Fetches details of triggered job for a solution.
- Parameters
solution_id (str) – Id of the solution. Required.
solution_inference_request (JSON or IO) – solutionInferenceRequest containing input needed for job request processing. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
dict mapping str to any
- Return type
- Raises
Example
# response body for status code(s): 200 response == { "str": {} # Optional. }
-
-
class
azure.agrifood.farming.operations.
TillageDataOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’stillage_data
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, tillage_data_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create cascade delete job for tillage data resource.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
- Keyword Arguments
party_id (str) – Id of the party. Required.
tillage_data_id (str) – Id of the tillage data. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, tillage_data_id: str, tillage_data: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, tillage_data_id: str, tillage_data: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates an tillage data resource under a particular party.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "tillageDepth": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "tillagePressure": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
delete
(party_id: str, tillage_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified tillage data resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, tillage_data_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a specified tillage data resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "tillageDepth": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "tillagePressure": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get cascade delete job for tillage data resource.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, min_tillage_depth: Optional[float] = None, max_tillage_depth: Optional[float] = None, min_tillage_pressure: Optional[float] = None, max_tillage_pressure: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of tillage data resources across all parties.
- Keyword Arguments
min_tillage_depth (float) – Minimum measured tillage depth (inclusive). Default value is None.
max_tillage_depth (float) – Maximum measured tillage depth (inclusive). Default value is None.
min_tillage_pressure (float) – Minimum pressure applied to a tillage implement (inclusive). Default value is None.
max_tillage_pressure (float) – Maximum pressure applied to a tillage implement (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "tillageDepth": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "tillagePressure": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
list_by_party_id
(party_id: str, *, min_tillage_depth: Optional[float] = None, max_tillage_depth: Optional[float] = None, min_tillage_pressure: Optional[float] = None, max_tillage_pressure: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of tillage data resources under a particular farm.
- Parameters
party_id (str) – ID of the associated party. Required.
- Keyword Arguments
min_tillage_depth (float) – Minimum measured tillage depth (inclusive). Default value is None.
max_tillage_depth (float) – Maximum measured tillage depth (inclusive). Default value is None.
min_tillage_pressure (float) – Minimum pressure applied to a tillage implement (inclusive). Default value is None.
max_tillage_pressure (float) – Maximum pressure applied to a tillage implement (inclusive). Default value is None.
sources (list[str]) – Sources of the operation data. Default value is None.
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data. Default value is None.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). Default value is None.
min_area (float) – Minimum area for which operation was applied (inclusive). Default value is None.
max_area (float) – Maximum area for which operation was applied (inclusive). Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "area": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "associatedBoundaryId": "str", # Optional. Optional boundary ID of the field for which operation was applied. "attachmentsLink": "str", # Optional. Link for attachments. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "operationEndDateTime": "2020-02-20 00:00:00", # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "operationModifiedDateTime": "2020-02-20 00:00:00", # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ."nNote: this will be specified by the source provider itself. "operationStartDateTime": "2020-02-20 00:00:00", # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. "partyId": "str", # Optional. Party ID which belongs to the operation data. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "tillageDepth": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "tillagePressure": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
-
class
azure.agrifood.farming.operations.
WeatherDataOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sweather_data
attribute.-
get
(weather_data_provider_request: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶ -
get
(weather_data_provider_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON Returns a list of WeatherData.
- Parameters
weather_data_provider_request (JSON or IO) – Weather data provider request. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "weatherMetadata": { "extensionApiName": "str", # Extension api name to which request is to be made. Required. "extensionId": "str", # Id of the extension to be used for the providerInput. eg. DTN.ClearAg. Required. "extensionVersion": "str", # Version of the weather data extension. Required. "units": "str", # Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units. Required. "weatherDataType": "str", # Type of weather data (forecast/historical). Required. "additionalParams": { "details": True, # Optional. Default value is True. Details (Only applicable for AzureWeatherMaps). "iconResolution": "str" # Optional. Icon Resolution (Only applicable for AzureWeatherMaps). }, "duration": 0, # Optional. Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.). "endTimeHours": 0, # Optional. End of time range. (Only applicable for DTN.ClearAg extension.). "language": "str", # Optional. Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'. "startTimeHours": 0 # Optional. Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.). }, "errors": { "locations": [ { "code": 0, # Optional. Status code returned by data provider. "description": "str", # Optional. Description of the error. "location": { "type": "str", # Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. Required. Known values are: "LatLong", "IataCode", "IcaoCode", "PlaceId", and "PostalKey". "value": "str" # Location Value eg. "10,-25" for LocationType Type "LatLong". Required. }, "retryable": bool # Optional. Flag suggesting if retry attempt with same request body should be made to fetch required data. } ] }, "locations": [ { "data": { "additionalAttributes": { "str": {} # Optional. A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 250 characters. Note: A maximum of 100 key value pairs can be provided for a resource and only string and numeral values are supported. }, "cloudCover": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "dayOfWeek": [ "str" # Optional. Day of week. ], "dayOrNight": [ "str" # Optional. This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location. ], "expirationTime": [ "str" # Optional. Expiration time in Utc format. ], "hasPrecipitation": [ bool # Optional. Indicates whether there is precipitation or not. ], "iconCode": [ "str" # Optional. This number is the key to the weather icon lookup. The data field shows the icon number that is matched to represent the observed weather conditions. ], "iconCodeExtend": [ "str" # Optional. Code representing full set sensible weather. ], "pressureMeanSeaLevel": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "relativeHumidity": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "temperature": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "temperatureDewPoint": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "temperatureFeelsLike": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "temperatureHeatIndex": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "temperatureWindChill": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "uvDescription": [ "str" # Optional. The UV Index Description which complements the UV Index value by providing an associated level of risk of skin damage due to exposure (-2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate, 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme). ], "uvIndex": [ "str" # Optional. Hourly maximum UV index. ], "validTime": [ "str" # Optional. Time forecast is valid in Utc format. ], "validTimeLocal": [ "str" # Optional. Time forecast is valid in local apparent time. ], "visibility": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "wetBulbTemperature": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "windDirection": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "windGust": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "windSpeed": { "unit": "str", # Optional. Data unit. "values": [ 0.0 # Optional. Data values. ] }, "wxPhraseLong": [ "str" # Optional. Hourly sensible weather phrase containing longer description. ], "wxPhraseShort": [ "str" # Optional. Hourly sensible weather phrase containing short description. ] }, "lastRefreshedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ. "location": { "type": "str", # Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. Required. Known values are: "LatLong", "IataCode", "IcaoCode", "PlaceId", and "PostalKey". "value": "str" # Location Value eg. "10,-25" for LocationType Type "LatLong". Required. }, "requestCompletionTime": "str" # Optional. Request Completion Time in Utc of the location. } ], "status": "str" # Optional. Indicates a Succeeded, Failed, or PartiallySucceeded response. Known values are: "Succeeded", "Failed", and "PartiallySucceeded". }
-
-
class
azure.agrifood.farming.operations.
WeatherOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’sweather
attribute.-
begin_create_data_delete_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_data_delete_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a weather data delete job.
- Parameters
job_id (str) – Job Id supplied by end user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "boundaryId": "str", # The id of the boundary object for which weather data is being fetched. Required. "extensionId": "str", # Id of the extension to be used for the providerInput. eg. DTN.ClearAg. Required. "partyId": "str", # The id of the party for which weather data is being fetched. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endDateTime": "2020-02-20 00:00:00", # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "granularity": "str", # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startDateTime": "2020-02-20 00:00:00", # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str", # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. "weatherDataType": "str" # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. }
-
begin_create_data_ingestion_job
(job_id: str, job: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON][source]¶ -
begin_create_data_ingestion_job
(job_id: str, job: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[JSON] Create a weather data ingestion job.
- Parameters
job_id (str) – Job id supplied by user. Required.
job (JSON or IO) – Job parameters supplied by user. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "boundaryId": "str", # The id of the boundary object for which weather data is being fetched. Required. "extensionApiInput": { "str": {} # Extension api input dictionary which would be used to feed request query/body/parameter information. Required. }, "extensionApiName": "str", # Extension api name to which request is to be made. Required. "extensionId": "str", # Id of the extension to be used for the providerInput. eg. DTN.ClearAg. Required. "partyId": "str", # The id of the party for which weather data is being fetched. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "extensionDataProviderApiKey": "str", # Optional. Api key of the weather data provider. "extensionDataProviderAppId": "str", # Optional. App id of the weather data provider. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
get_data_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get weather data delete job.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # The id of the boundary object for which weather data is being fetched. Required. "extensionId": "str", # Id of the extension to be used for the providerInput. eg. DTN.ClearAg. Required. "partyId": "str", # The id of the party for which weather data is being fetched. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endDateTime": "2020-02-20 00:00:00", # Optional. Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "granularity": "str", # Optional. Granularity of weather data. Possible values include: 'daily' , 'hourly'. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startDateTime": "2020-02-20 00:00:00", # Optional. Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str", # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. "weatherDataType": "str" # Optional. Type of weather data. Possible values include: 'forecast' , 'historical'. }
-
get_data_ingestion_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get weather ingestion job.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # The id of the boundary object for which weather data is being fetched. Required. "extensionApiInput": { "str": {} # Extension api input dictionary which would be used to feed request query/body/parameter information. Required. }, "extensionApiName": "str", # Extension api name to which request is to be made. Required. "extensionId": "str", # Id of the extension to be used for the providerInput. eg. DTN.ClearAg. Required. "partyId": "str", # The id of the party for which weather data is being fetched. Required. "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "extensionDataProviderApiKey": "str", # Optional. Api key of the weather data provider. "extensionDataProviderAppId": "str", # Optional. App id of the weather data provider. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "modifiedBy": "str", # Optional. Modified by user/tenant id. "name": "str", # Optional. Name to identify resource. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. }
-
list
(*, party_id: str, boundary_id: str, extension_id: str, weather_data_type: str, granularity: str, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of weather data.
- Keyword Arguments
party_id (str) – Party ID. Required.
boundary_id (str) – Boundary ID. Required.
extension_id (str) – ID of the weather extension. Required.
weather_data_type (str) – Type of weather data (forecast/historical). Required.
granularity (str) – Granularity of weather data (daily/hourly). Required.
start_date_time (datetime) – Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
end_date_time (datetime) – Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "boundaryId": "str", # Boundary ID. Required. "dateTime": "2020-02-20 00:00:00", # Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ. Required. "extensionId": "str", # ID of the weather extension. Required. "extensionVersion": "str", # Version of the weather data extension. Required. "granularity": "str", # Granularity of weather data (daily/hourly). Required. "location": { "latitude": 0.0, # Latitude of the location. Required. "longitude": 0.0 # Longitude of the location. Required. }, "partyId": "str", # Party ID. Required. "weatherDataType": "str", # Type of weather data (forecast/historical). Required. "cloudCover": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "dewPoint": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "growingDegreeDay": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "id": "str", # Optional. Weather data ID. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "precipitation": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "pressure": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 250 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. }, "relativeHumidity": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "soilMoisture": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "soilTemperature": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "temperature": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "unitSystemCode": "str", # Optional. Unit System like US/SI etc. "visibility": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "wetBulbTemperature": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "windChill": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "windDirection": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "windGust": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. }, "windSpeed": { "unit": "str", # Optional. Data unit. "value": 0.0 # Optional. Data value. } }
-
-
class
azure.agrifood.farming.operations.
ZonesOperations
(*args, **kwargs)[source]¶ Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
FarmBeatsClient
’szones
attribute.-
begin_create_cascade_delete_job
(job_id: str, *, party_id: str, zone_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[collections.abc.MutableMapping[str, Any]][source]¶ Create a cascade delete job for specified zone.
- Parameters
job_id (str) – Job ID supplied by end user. Required.
- Keyword Arguments
party_id (str) – ID of the associated party. Required.
zone_id (str) – ID of the zone to be deleted. Required.
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be LROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns JSON object
- Return type
LROPoller[JSON]
- Raises
Example
# response body for status code(s): 202 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
create_or_update
(party_id: str, zone_id: str, zone: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶ -
create_or_update
(party_id: str, zone_id: str, zone: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON Creates or updates a Zone resource.
- Parameters
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200, 201 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "managementZoneId": "str", # Optional. Management Zone Id associated with the Zone. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the Zone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the Zone. }
-
delete
(party_id: str, zone_id: str, **kwargs: Any) → None[source]¶ Deletes a specified zone resource under a particular party.
- Parameters
- Returns
None
- Return type
- Raises
-
get
(party_id: str, zone_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Gets a specified zone resource under a particular party.
- Parameters
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "managementZoneId": "str", # Optional. Management Zone Id associated with the Zone. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the Zone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the Zone. }
-
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶ Get a cascade delete job for specified job id.
- Parameters
job_id (str) – Id of the job. Required.
- Returns
JSON object
- Return type
JSON
- Raises
Example
# response body for status code(s): 200 response == { "partyId": "str", # Party Id. Required. "resourceId": "str", # The id of the resource. Required. "resourceType": "str", # The type of the resource. Required. "createdDateTime": "2020-02-20 00:00:00", # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "durationInSeconds": 0.0, # Optional. Duration of the job in seconds. "endTime": "2020-02-20 00:00:00", # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "errorCode": "str", # Optional. Error Code when job failed. "id": "str", # Optional. Unique job id. "lastActionDateTime": "2020-02-20 00:00:00", # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. "message": "str", # Optional. Status message to capture more details of the job. "startTime": "2020-02-20 00:00:00", # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. "status": "str" # Optional. Status of the job."nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. Known values are: "Waiting", "Running", "Succeeded", "Failed", and "Cancelled". }
-
list
(*, types: Optional[List[str]] = None, management_zone_ids: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of zone resources across all parties.
- Keyword Arguments
types (list[str]) – Types of the Zones. Default value is None.
management_zone_ids (list[str]) – ManagementZoneIds of the Zones. Default value is None.
sources (list[str]) – Sources of the Zones. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "managementZoneId": "str", # Optional. Management Zone Id associated with the Zone. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the Zone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the Zone. }
-
list_by_party_id
(party_id: str, *, types: Optional[List[str]] = None, management_zone_ids: Optional[List[str]] = None, sources: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[collections.abc.MutableMapping[str, Any]][source]¶ Returns a paginated list of zone resources under a particular party.
- Parameters
party_id (str) – Id of the associated party. Required.
- Keyword Arguments
types (list[str]) – Types of the Zones. Default value is None.
management_zone_ids (list[str]) – ManagementZoneIds of the Zones. Default value is None.
sources (list[str]) – Sources of the Zones. Default value is None.
ids (list[str]) – Ids of the resource. Default value is None.
names (list[str]) – Names of the resource. Default value is None.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”. Default value is None.
statuses (list[str]) – Statuses of the resource. Default value is None.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive). Default value is None.
max_created_date_time (datetime) – Maximum creation date of resource (inclusive). Default value is None.
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive). Default value is None.
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive). Default value is None.
skip_token (str) – Skip token for getting next set of results. Default value is None.
- Returns
An iterator like instance of JSON object
- Return type
ItemPaged[JSON]
- Raises
Example
# response body for status code(s): 200 response == { "createdBy": "str", # Optional. Created by user/tenant id. "createdDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. "description": "str", # Optional. Textual description of the resource. "eTag": "str", # Optional. The ETag value to implement optimistic concurrency. "id": "str", # Optional. Unique resource ID. "managementZoneId": "str", # Optional. Management Zone Id associated with the Zone. "modifiedBy": "str", # Optional. Modified by user/tenant id. "modifiedDateTime": "2020-02-20 00:00:00", # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. "name": "str", # Optional. Name to identify resource. "partyId": "str", # Optional. Party Id associated with the Zone. "properties": { "str": {} # Optional. A collection of key value pairs that belongs to the resource."nEach pair must not have a key greater than 50 characters"nand must not have a value greater than 150 characters."nNote: A maximum of 25 key value pairs can be provided for a resource and only string,"nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. }, "source": "str", # Optional. Source of the resource. "status": "str", # Optional. Status of the resource. "type": "str" # Optional. Type of the Zone. }
-