1. Packages
  2. Azure Native
  3. API Docs
  4. syntex
  5. DocumentProcessor
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.syntex.DocumentProcessor

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Document processor details

Uses Azure REST API version 2022-09-15-preview. In version 2.x of the Azure Native provider, it used API version 2022-09-15-preview.

Example Usage

DocumentProcessor_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var documentProcessor = new AzureNative.Syntex.DocumentProcessor("documentProcessor", new()
    {
        Location = "westus",
        ProcessorName = "myprocessor",
        Properties = new AzureNative.Syntex.Inputs.DocumentProcessorPropertiesArgs
        {
            SpoTenantId = "e9bb744b-9558-4dc6-9e50-a3297e3332fa",
            SpoTenantUrl = "https://test123.sharepoint.com",
        },
        ResourceGroupName = "mygroup",
        Tags = 
        {
            { "additionalProp1", "string1" },
            { "additionalProp2", "string2" },
            { "additionalProp3", "string3" },
        },
    });

});
Copy
package main

import (
	syntex "github.com/pulumi/pulumi-azure-native-sdk/syntex/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := syntex.NewDocumentProcessor(ctx, "documentProcessor", &syntex.DocumentProcessorArgs{
			Location:      pulumi.String("westus"),
			ProcessorName: pulumi.String("myprocessor"),
			Properties: &syntex.DocumentProcessorPropertiesArgs{
				SpoTenantId:  pulumi.String("e9bb744b-9558-4dc6-9e50-a3297e3332fa"),
				SpoTenantUrl: pulumi.String("https://test123.sharepoint.com"),
			},
			ResourceGroupName: pulumi.String("mygroup"),
			Tags: pulumi.StringMap{
				"additionalProp1": pulumi.String("string1"),
				"additionalProp2": pulumi.String("string2"),
				"additionalProp3": pulumi.String("string3"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.syntex.DocumentProcessor;
import com.pulumi.azurenative.syntex.DocumentProcessorArgs;
import com.pulumi.azurenative.syntex.inputs.DocumentProcessorPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var documentProcessor = new DocumentProcessor("documentProcessor", DocumentProcessorArgs.builder()
            .location("westus")
            .processorName("myprocessor")
            .properties(DocumentProcessorPropertiesArgs.builder()
                .spoTenantId("e9bb744b-9558-4dc6-9e50-a3297e3332fa")
                .spoTenantUrl("https://test123.sharepoint.com")
                .build())
            .resourceGroupName("mygroup")
            .tags(Map.ofEntries(
                Map.entry("additionalProp1", "string1"),
                Map.entry("additionalProp2", "string2"),
                Map.entry("additionalProp3", "string3")
            ))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const documentProcessor = new azure_native.syntex.DocumentProcessor("documentProcessor", {
    location: "westus",
    processorName: "myprocessor",
    properties: {
        spoTenantId: "e9bb744b-9558-4dc6-9e50-a3297e3332fa",
        spoTenantUrl: "https://test123.sharepoint.com",
    },
    resourceGroupName: "mygroup",
    tags: {
        additionalProp1: "string1",
        additionalProp2: "string2",
        additionalProp3: "string3",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

document_processor = azure_native.syntex.DocumentProcessor("documentProcessor",
    location="westus",
    processor_name="myprocessor",
    properties={
        "spo_tenant_id": "e9bb744b-9558-4dc6-9e50-a3297e3332fa",
        "spo_tenant_url": "https://test123.sharepoint.com",
    },
    resource_group_name="mygroup",
    tags={
        "additionalProp1": "string1",
        "additionalProp2": "string2",
        "additionalProp3": "string3",
    })
Copy
resources:
  documentProcessor:
    type: azure-native:syntex:DocumentProcessor
    properties:
      location: westus
      processorName: myprocessor
      properties:
        spoTenantId: e9bb744b-9558-4dc6-9e50-a3297e3332fa
        spoTenantUrl: https://test123.sharepoint.com
      resourceGroupName: mygroup
      tags:
        additionalProp1: string1
        additionalProp2: string2
        additionalProp3: string3
Copy

Create DocumentProcessor Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DocumentProcessor(name: string, args: DocumentProcessorArgs, opts?: CustomResourceOptions);
@overload
def DocumentProcessor(resource_name: str,
                      args: DocumentProcessorArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def DocumentProcessor(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      location: Optional[str] = None,
                      processor_name: Optional[str] = None,
                      properties: Optional[DocumentProcessorPropertiesArgs] = None,
                      tags: Optional[Mapping[str, str]] = None)
func NewDocumentProcessor(ctx *Context, name string, args DocumentProcessorArgs, opts ...ResourceOption) (*DocumentProcessor, error)
public DocumentProcessor(string name, DocumentProcessorArgs args, CustomResourceOptions? opts = null)
public DocumentProcessor(String name, DocumentProcessorArgs args)
public DocumentProcessor(String name, DocumentProcessorArgs args, CustomResourceOptions options)
type: azure-native:syntex:DocumentProcessor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DocumentProcessorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DocumentProcessorArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DocumentProcessorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DocumentProcessorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DocumentProcessorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var documentProcessorResource = new AzureNative.Syntex.DocumentProcessor("documentProcessorResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    ProcessorName = "string",
    Properties = new AzureNative.Syntex.Inputs.DocumentProcessorPropertiesArgs
    {
        SpoTenantId = "string",
        SpoTenantUrl = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := syntex.NewDocumentProcessor(ctx, "documentProcessorResource", &syntex.DocumentProcessorArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	ProcessorName:     pulumi.String("string"),
	Properties: &syntex.DocumentProcessorPropertiesArgs{
		SpoTenantId:  pulumi.String("string"),
		SpoTenantUrl: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var documentProcessorResource = new DocumentProcessor("documentProcessorResource", DocumentProcessorArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .processorName("string")
    .properties(DocumentProcessorPropertiesArgs.builder()
        .spoTenantId("string")
        .spoTenantUrl("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
document_processor_resource = azure_native.syntex.DocumentProcessor("documentProcessorResource",
    resource_group_name="string",
    location="string",
    processor_name="string",
    properties={
        "spo_tenant_id": "string",
        "spo_tenant_url": "string",
    },
    tags={
        "string": "string",
    })
Copy
const documentProcessorResource = new azure_native.syntex.DocumentProcessor("documentProcessorResource", {
    resourceGroupName: "string",
    location: "string",
    processorName: "string",
    properties: {
        spoTenantId: "string",
        spoTenantUrl: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:syntex:DocumentProcessor
properties:
    location: string
    processorName: string
    properties:
        spoTenantId: string
        spoTenantUrl: string
    resourceGroupName: string
    tags:
        string: string
Copy

DocumentProcessor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DocumentProcessor resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ProcessorName Changes to this property will trigger replacement. string
The name of document processor resource.
Properties Pulumi.AzureNative.Syntex.Inputs.DocumentProcessorProperties
Document processor properties.
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ProcessorName Changes to this property will trigger replacement. string
The name of document processor resource.
Properties DocumentProcessorPropertiesArgs
Document processor properties.
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
processorName Changes to this property will trigger replacement. String
The name of document processor resource.
properties DocumentProcessorProperties
Document processor properties.
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
processorName Changes to this property will trigger replacement. string
The name of document processor resource.
properties DocumentProcessorProperties
Document processor properties.
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
processor_name Changes to this property will trigger replacement. str
The name of document processor resource.
properties DocumentProcessorPropertiesArgs
Document processor properties.
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
processorName Changes to this property will trigger replacement. String
The name of document processor resource.
properties Property Map
Document processor properties.
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the DocumentProcessor resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.Syntex.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

DocumentProcessorProperties
, DocumentProcessorPropertiesArgs

SpoTenantId This property is required. string
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
SpoTenantUrl This property is required. string
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
SpoTenantId This property is required. string
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
SpoTenantUrl This property is required. string
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantId This property is required. String
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantUrl This property is required. String
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantId This property is required. string
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantUrl This property is required. string
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
spo_tenant_id This property is required. str
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spo_tenant_url This property is required. str
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantId This property is required. String
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantUrl This property is required. String
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource

DocumentProcessorPropertiesResponse
, DocumentProcessorPropertiesResponseArgs

ProvisioningState This property is required. string
The managed resource provisioning state.
SpoTenantId This property is required. string
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
SpoTenantUrl This property is required. string
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
ProvisioningState This property is required. string
The managed resource provisioning state.
SpoTenantId This property is required. string
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
SpoTenantUrl This property is required. string
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
provisioningState This property is required. String
The managed resource provisioning state.
spoTenantId This property is required. String
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantUrl This property is required. String
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
provisioningState This property is required. string
The managed resource provisioning state.
spoTenantId This property is required. string
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantUrl This property is required. string
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
provisioning_state This property is required. str
The managed resource provisioning state.
spo_tenant_id This property is required. str
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spo_tenant_url This property is required. str
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
provisioningState This property is required. String
The managed resource provisioning state.
spoTenantId This property is required. String
The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
spoTenantUrl This property is required. String
The URL of an SharePoint Online (SPO) tenant associated with this document processor resource

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:syntex:DocumentProcessor myprocessor /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Syntex/documentProcessors/{processorName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi