farms

Creates, updates, deletes, gets or lists a farms resource.

Overview

Name	farms
Type	Resource
Id	azure_extras.agrifood_farming.farms

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_update	insert	party_id, farm_id, endpoint		Creates or updates a farm resource under a particular party.
create_or_update	replace	party_id, farm_id, endpoint		Creates or updates a farm resource under a particular party.
delete	delete	party_id, farm_id, endpoint		Deletes a specified farm resource under a particular party.
get_raw	exec	party_id, farm_id, endpoint		Gets a specified farm resource under a particular party.
list_raw	exec	endpoint	minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of farm resources across all parties.
list_by_party_id	exec	party_id, endpoint	minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a paginated list of farm resources under a particular party.
get_cascade_delete_job_details	exec	job_id, endpoint		Get a cascade delete job for specified farm.
create_cascade_delete_job	exec	job_id, partyId, farmId, endpoint		Create a cascade delete job for specified farm.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
farmId	string	ID of the farm to be deleted. Required.
farm_id	string	ID of the farm resource. Required.
job_id	string	Job ID supplied by end user. Required.
partyId	string	ID of the associated party. Required.
party_id	string	Id of the associated party. Required.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive). Default value is None.
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive). Default value is None.
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive). Default value is None.
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive). Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.

INSERT examples

create_or_update

Creates or updates a farm resource under a particular party.

INSERT INTO azure_extras.agrifood_farming.farms (
party_id,
farm_id,
endpoint
)
SELECT 
'{{ party_id }}',
'{{ farm_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: farms
props:
  - name: party_id
    value: "{{ party_id }}"
    description: Required parameter for the farms resource.
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the farms resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the farms resource.

REPLACE examples

create_or_update

Creates or updates a farm resource under a particular party.

REPLACE azure_extras.agrifood_farming.farms
SET 
-- No updatable properties
WHERE 
party_id = '{{ party_id }}' --required
AND farm_id = '{{ farm_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Deletes a specified farm resource under a particular party.

DELETE FROM azure_extras.agrifood_farming.farms
WHERE party_id = '{{ party_id }}' --required
AND farm_id = '{{ farm_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Gets a specified farm resource under a particular party.

EXEC azure_extras.agrifood_farming.farms.get_raw 
@party_id='{{ party_id }}' --required, 
@farm_id='{{ farm_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_raw

Returns a paginated list of farm resources across all parties.

EXEC azure_extras.agrifood_farming.farms.list_raw 
@endpoint='{{ endpoint }}' --required, 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

list_by_party_id

Returns a paginated list of farm resources under a particular party.

EXEC azure_extras.agrifood_farming.farms.list_by_party_id 
@party_id='{{ party_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

get_cascade_delete_job_details

Get a cascade delete job for specified farm.

EXEC azure_extras.agrifood_farming.farms.get_cascade_delete_job_details 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_cascade_delete_job

Create a cascade delete job for specified farm.

EXEC azure_extras.agrifood_farming.farms.create_cascade_delete_job 
@job_id='{{ job_id }}' --required, 
@partyId='{{ partyId }}' --required, 
@farmId='{{ farmId }}' --required, 
@endpoint='{{ endpoint }}' --required
;