data_connectors

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

Overview

Name	data_connectors
Type	Resource
Id	azure_extras.ag_food_platform.data_connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
eTag	string	The ETag value to implement optimistic concurrency.
properties	object	DataConnector Properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list

Name	Datatype	Description
eTag	string	The ETag value to implement optimistic concurrency.
properties	object	DataConnector Properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, dataManagerForAgricultureResourceName, dataConnectorName		Get specific Data Connector resource by DataConnectorName.
list	select	subscriptionId, resourceGroupName, dataManagerForAgricultureResourceName	$maxPageSize, $skipToken	Lists the Data Connector Credentials for MADMA instance.
create_or_update	insert	resourceGroupName, subscriptionId, dataManagerForAgricultureResourceName, dataConnectorName, data__properties		Create or update Data Connector For MADMA resource.
delete	delete	resourceGroupName, subscriptionId, dataManagerForAgricultureResourceName, dataConnectorName		Delete a Data Connectors with given dataConnector name.

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
dataConnectorName	string	Connector name.
dataManagerForAgricultureResourceName	string	DataManagerForAgriculture resource name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$maxPageSize	integer (int32)	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
$skipToken	string	Continuation token for getting next set of results.

SELECT examples

get

Get specific Data Connector resource by DataConnectorName.

SELECT
eTag,
properties,
systemData
FROM azure_extras.ag_food_platform.data_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND dataManagerForAgricultureResourceName = '{{ dataManagerForAgricultureResourceName }}' -- required
AND dataConnectorName = '{{ dataConnectorName }}' -- required
;

list

Lists the Data Connector Credentials for MADMA instance.

SELECT
eTag,
properties,
systemData
FROM azure_extras.ag_food_platform.data_connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerForAgricultureResourceName = '{{ dataManagerForAgricultureResourceName }}' -- required
AND $maxPageSize = '{{ $maxPageSize }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create or update Data Connector For MADMA resource.

INSERT INTO azure_extras.ag_food_platform.data_connectors (
data__properties,
resourceGroupName,
subscriptionId,
dataManagerForAgricultureResourceName,
dataConnectorName
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ dataManagerForAgricultureResourceName }}',
'{{ dataConnectorName }}'
RETURNING
eTag,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: data_connectors
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_connectors resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the data_connectors resource.
    - name: dataManagerForAgricultureResourceName
      value: string
      description: Required parameter for the data_connectors resource.
    - name: dataConnectorName
      value: string
      description: Required parameter for the data_connectors resource.
    - name: properties
      value: object
      description: |
        DataConnector Properties.

DELETE examples

delete

Delete a Data Connectors with given dataConnector name.

DELETE FROM azure_extras.ag_food_platform.data_connectors
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND dataManagerForAgricultureResourceName = '{{ dataManagerForAgricultureResourceName }}' --required
AND dataConnectorName = '{{ dataConnectorName }}' --required
;