farm_beats_models

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

Overview

Name	farm_beats_models
Type	Resource
Id	azure_extras.agrifood.farm_beats_models

Fields

The following fields are returned by SELECT queries:

get_operation_result

Name	Datatype	Description
status	string	Status of the async operation.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
identity	object	Identity for the resource.
instanceUri	string	Uri of the FarmBeats instance.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	object	The private endpoint connection resource.
provisioningState	string	FarmBeats instance provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", and "Failed".
publicNetworkAccess	string	Property to allow or block public traffic for an Azure FarmBeats resource. Known values are: "Enabled" and "Hybrid".
sensorIntegration	object	Sensor integration request model.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
identity	object	Identity for the resource.
instanceUri	string	Uri of the FarmBeats instance.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	object	The private endpoint connection resource.
provisioningState	string	FarmBeats instance provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", and "Failed".
publicNetworkAccess	string	Property to allow or block public traffic for an Azure FarmBeats resource. Known values are: "Enabled" and "Hybrid".
sensorIntegration	object	Sensor integration request model.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
identity	object	Identity for the resource.
instanceUri	string	Uri of the FarmBeats instance.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	object	The private endpoint connection resource.
provisioningState	string	FarmBeats instance provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", and "Failed".
publicNetworkAccess	string	Property to allow or block public traffic for an Azure FarmBeats resource. Known values are: "Enabled" and "Hybrid".
sensorIntegration	object	Sensor integration request model.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_operation_result	select	resource_group_name, farm_beats_resource_name, operation_results_id, subscription_id		Get operationResults for a FarmBeats resource.
get	select	resource_group_name, farm_beats_resource_name, subscription_id		Get FarmBeats resource.
list_by_resource_group	select	resource_group_name, subscription_id	$maxPageSize, $skipToken	Lists the FarmBeats instances for a resource group.
list_by_subscription	select	subscription_id	$maxPageSize, $skipToken	Lists the FarmBeats instances for a subscription.
create_or_update	insert	resource_group_name, farm_beats_resource_name, subscription_id, location		Create or update FarmBeats resource.
update	update	resource_group_name, farm_beats_resource_name, subscription_id		Update a FarmBeats resource.
create_or_update	replace	resource_group_name, farm_beats_resource_name, subscription_id, location		Create or update FarmBeats resource.
delete	delete	resource_group_name, farm_beats_resource_name, subscription_id		Delete a FarmBeats resource.

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
farm_beats_resource_name	string	FarmBeats resource name. Required.
operation_results_id	string	The operation results id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$maxPageSize	integer	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. Default value is 50.
$skipToken	string	Skip token for getting next set of results. Default value is None.

SELECT examples

get_operation_result

Get operationResults for a FarmBeats resource.

SELECT
status
FROM azure_extras.agrifood.farm_beats_models
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' -- required
AND operation_results_id = '{{ operation_results_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get FarmBeats resource.

SELECT
id,
name,
identity,
instanceUri,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sensorIntegration,
systemData,
tags,
type
FROM azure_extras.agrifood.farm_beats_models
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists the FarmBeats instances for a resource group.

SELECT
id,
name,
identity,
instanceUri,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sensorIntegration,
systemData,
tags,
type
FROM azure_extras.agrifood.farm_beats_models
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $maxPageSize = '{{ $maxPageSize }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Lists the FarmBeats instances for a subscription.

SELECT
id,
name,
identity,
instanceUri,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sensorIntegration,
systemData,
tags,
type
FROM azure_extras.agrifood.farm_beats_models
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $maxPageSize = '{{ $maxPageSize }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create or update FarmBeats resource.

INSERT INTO azure_extras.agrifood.farm_beats_models (
tags,
location,
identity,
properties,
resource_group_name,
farm_beats_resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ farm_beats_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: farm_beats_models
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the farm_beats_models resource.
  - name: farm_beats_resource_name
    value: "{{ farm_beats_resource_name }}"
    description: Required parameter for the farm_beats_models resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the farm_beats_models resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      Identity for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: properties
    value:
      sensorIntegration:
        enabled: "{{ enabled }}"
        provisioningState: "{{ provisioningState }}"
        provisioningInfo:
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"

UPDATE examples

update

Update a FarmBeats resource.

UPDATE azure_extras.agrifood.farm_beats_models
SET 
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update FarmBeats resource.

REPLACE azure_extras.agrifood.farm_beats_models
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a FarmBeats resource.

DELETE FROM azure_extras.agrifood.farm_beats_models
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND farm_beats_resource_name = '{{ farm_beats_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;