document_processors

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

Overview

Name	document_processors
Type	Resource
Id	azure_extras.syntex.document_processors

Fields

The following fields are returned by SELECT queries:

get

Document processor details.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Document processor properties.
tags	object	Resource tags.

list_by_resource_group

Document processor details.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Document processor properties.
tags	object	Resource tags.

list

Document processor details.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Document processor properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, processorName		Returns a document processor for a given name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Returns document processors in a resource group.
list	select	subscriptionId		Returns document processors in the subscription.
create	insert	subscriptionId, resourceGroupName, processorName		Creates a document processor resource for a given name.
update	update	subscriptionId, resourceGroupName, processorName		Updates a document processor resource for a given name.
delete	delete	subscriptionId, resourceGroupName, processorName		Deletes document processor resource for a given 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
processorName	string	The name of document processor resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns a document processor for a given name.

SELECT
location,
properties,
tags
FROM azure_extras.syntex.document_processors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND processorName = '{{ processorName }}' -- required
;

list_by_resource_group

Returns document processors in a resource group.

SELECT
location,
properties,
tags
FROM azure_extras.syntex.document_processors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Returns document processors in the subscription.

SELECT
location,
properties,
tags
FROM azure_extras.syntex.document_processors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a document processor resource for a given name.

INSERT INTO azure_extras.syntex.document_processors (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
processorName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ processorName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: document_processors
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the document_processors resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the document_processors resource.
    - name: processorName
      value: string
      description: Required parameter for the document_processors resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Document processor properties.

UPDATE examples

update

Updates a document processor resource for a given name.

UPDATE azure_extras.syntex.document_processors
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND processorName = '{{ processorName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes document processor resource for a given name.

DELETE FROM azure_extras.syntex.document_processors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND processorName = '{{ processorName }}' --required
;