azure-native.syntex.DocumentProcessor
Explore with Pulumi AI
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.
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" },
},
});
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"),
},
})
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());
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",
})
const documentProcessorResource = new azure_native.syntex.DocumentProcessor("documentProcessorResource", {
resourceGroupName: "string",
location: "string",
processorName: "string",
properties: {
spoTenantId: "string",
spoTenantUrl: "string",
},
tags: {
string: "string",
},
});
type: azure-native:syntex:DocumentProcessor
properties:
location: string
processorName: string
properties:
spoTenantId: string
spoTenantUrl: string
resourceGroupName: string
tags:
string: string
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:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Processor
Name Changes to this property will trigger replacement.
- The name of document processor resource.
- Properties
Pulumi.
Azure Native. Syntex. Inputs. Document Processor Properties - Document processor properties.
- Dictionary<string, string>
- Resource tags.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Processor
Name Changes to this property will trigger replacement.
- The name of document processor resource.
- Properties
Document
Processor Properties Args - Document processor properties.
- map[string]string
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- processor
Name Changes to this property will trigger replacement.
- The name of document processor resource.
- properties
Document
Processor Properties - Document processor properties.
- Map<String,String>
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- processor
Name Changes to this property will trigger replacement.
- The name of document processor resource.
- properties
Document
Processor Properties - Document processor properties.
- {[key: string]: string}
- Resource tags.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- processor_
name Changes to this property will trigger replacement.
- The name of document processor resource.
- properties
Document
Processor Properties Args - Document processor properties.
- Mapping[str, str]
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- processor
Name Changes to this property will trigger replacement.
- The name of document processor resource.
- properties Property Map
- Document processor properties.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the DocumentProcessor resource produces the following output properties:
- Azure
Api stringVersion - 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
- System
Data Pulumi.Azure Native. Syntex. Outputs. System Data Response - 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 stringVersion - 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
- System
Data SystemData Response - 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 StringVersion - 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
- system
Data SystemData Response - 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 stringVersion - 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
- system
Data SystemData Response - 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_ strversion - 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 SystemData Response - 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"
- azure
Api StringVersion - 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
- system
Data 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
- Spo
Tenant Id This property is required. string - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- Spo
Tenant Url 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. string - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- Spo
Tenant Url 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. String - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- spo
Tenant Url 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. string - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- spo
Tenant Url 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
- spo
Tenant Id This property is required. String - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- spo
Tenant Url This property is required. String - The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
DocumentProcessorPropertiesResponse, DocumentProcessorPropertiesResponseArgs
- Provisioning
State This property is required. string - The managed resource provisioning state.
- Spo
Tenant Id This property is required. string - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- Spo
Tenant Url 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. string - The managed resource provisioning state.
- Spo
Tenant Id This property is required. string - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- Spo
Tenant Url 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. String - The managed resource provisioning state.
- spo
Tenant Id This property is required. String - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- spo
Tenant Url 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. string - The managed resource provisioning state.
- spo
Tenant Id This property is required. string - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- spo
Tenant Url 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
- provisioning
State This property is required. String - The managed resource provisioning state.
- spo
Tenant Id This property is required. String - The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource
- spo
Tenant Url This property is required. String - The URL of an SharePoint Online (SPO) tenant associated with this document processor resource
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0