| page_title | subcategory | description |
|---|---|---|
airbyte_source_microsoft_sharepoint Resource - terraform-provider-airbyte |
SourceMicrosoftSharepoint Resource |
SourceMicrosoftSharepoint Resource
resource "airbyte_source_microsoft_sharepoint" "my_source_microsoftsharepoint" {
configuration = {
credentials = {
authenticate_via_microsoft_o_auth = {
client_id = "...my_client_id..."
client_secret = "...my_client_secret..."
refresh_token = "...my_refresh_token..."
tenant_id = "...my_tenant_id..."
}
service_key_authentication = {
client_id = "...my_client_id..."
client_secret = "...my_client_secret..."
tenant_id = "...my_tenant_id..."
user_principal_name = "...my_user_principal_name..."
}
}
folder_path = "...my_folder_path..."
search_scope = "ALL"
start_date = "2021-01-01T00:00:00.000000Z"
streams = [
{
days_to_sync_if_history_is_full = 0
format = {
avro_format = {
double_as_string = false
}
csv_format = {
delimiter = "...my_delimiter..."
double_quote = false
encoding = "...my_encoding..."
escape_char = "...my_escape_char..."
false_values = [
"..."
]
header_definition = {
autogenerated = {
# ...
}
from_csv = {
# ...
}
user_provided = {
column_names = [
"..."
]
}
}
ignore_errors_on_fields_mismatch = false
null_values = [
"..."
]
quote_char = "...my_quote_char..."
skip_rows_after_header = 4
skip_rows_before_header = 3
strings_can_be_null = false
true_values = [
"..."
]
}
excel_format = {
# ...
}
jsonl_format = {
# ...
}
parquet_format = {
decimal_as_float = true
}
unstructured_document_format = {
processing = {
local = {
# ...
}
}
skip_unprocessable_files = true
strategy = "auto"
}
}
globs = [
"..."
]
input_schema = "...my_input_schema..."
name = "...my_name..."
recent_n_files_to_read_for_schema_discovery = 7
schemaless = true
validation_policy = "Skip Record"
}
]
}
definition_id = "8120bea0-1e02-41bc-80a8-406f7b21913d"
name = "...my_name..."
secret_id = "...my_secret_id..."
workspace_id = "27c9b886-94de-4d83-9b82-5954db7af16b"
}configuration(Attributes) SourceMicrosoftSharePointSpec class for Microsoft SharePoint Source Specification. This class combines the authentication details with additional configuration for the SharePoint API. (see below for nested schema)name(String) Name of the source e.g. dev-mysql-instance.workspace_id(String)
definition_id(String) The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.secret_id(String) Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
created_at(Number)source_id(String)source_type(String)
Required:
credentials(Attributes) Credentials for connecting to the One Drive API (see below for nested schema)streams(Attributes List) Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. (see below for nested schema)
Optional:
folder_path(String) Path to a specific folder within the drives to search for files. Leave empty to search all folders of the drives. This does not apply to shared items. Default: "."search_scope(String) Specifies the location(s) to search for files. Valid options are 'ACCESSIBLE_DRIVES' for all SharePoint drives the user can access, 'SHARED_ITEMS' for shared items the user has access to, and 'ALL' to search both. Default: "ALL"; must be one of ["ACCESSIBLE_DRIVES", "SHARED_ITEMS", "ALL"]start_date(String) UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated.
Optional:
authenticate_via_microsoft_o_auth(Attributes) OAuthCredentials class to hold authentication details for Microsoft OAuth authentication. This class uses pydantic for data validation and settings management. (see below for nested schema)service_key_authentication(Attributes) ServiceCredentials class for service key authentication. This class is structured similarly to OAuthCredentials but for a different authentication method. (see below for nested schema)
Required:
client_id(String, Sensitive) Client ID of your Microsoft developer applicationclient_secret(String, Sensitive) Client Secret of your Microsoft developer applicationtenant_id(String, Sensitive) Tenant ID of the Microsoft SharePoint user
Optional:
refresh_token(String, Sensitive) Refresh Token of your Microsoft developer application
Required:
client_id(String, Sensitive) Client ID of your Microsoft developer applicationclient_secret(String, Sensitive) Client Secret of your Microsoft developer applicationtenant_id(String, Sensitive) Tenant ID of the Microsoft SharePoint useruser_principal_name(String, Sensitive) Special characters such as a period, comma, space, and the at sign (@) are converted to underscores (_). More details: https://learn.microsoft.com/en-us/sharepoint/list-onedrive-urls
Required:
format(Attributes) The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. (see below for nested schema)name(String) The name of the stream.
Optional:
days_to_sync_if_history_is_full(Number) When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. Default: 3globs(List of String) The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here.input_schema(String) The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files.recent_n_files_to_read_for_schema_discovery(Number) The number of resent files which will be used to discover the schema for this stream.schemaless(Boolean) When enabled, syncs will not validate or structure records against the stream's schema. Default: falsevalidation_policy(String) The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema. Default: "Emit Record"; must be one of ["Emit Record", "Skip Record", "Wait for Discover"]
Optional:
avro_format(Attributes) (see below for nested schema)csv_format(Attributes) (see below for nested schema)excel_format(Attributes) (see below for nested schema)jsonl_format(Attributes) (see below for nested schema)parquet_format(Attributes) (see below for nested schema)unstructured_document_format(Attributes) Extract text from document formats (.pdf, .docx, .md, .pptx) and emit as one record per file. (see below for nested schema)
Optional:
double_as_string(Boolean) Whether to convert double fields to strings. This is recommended if you have decimal numbers with a high degree of precision because there can be a loss precision when handling floating point numbers. Default: false
Optional:
delimiter(String) The character delimiting individual cells in the CSV data. This may only be a 1-character string. For tab-delimited data enter '\t'. Default: ","double_quote(Boolean) Whether two quotes in a quoted CSV value denote a single quote in the data. Default: trueencoding(String) The character encoding of the CSV data. Leave blank to default to UTF8. See list of python encodings for allowable options. Default: "utf8"escape_char(String) The character used for escaping special characters. To disallow escaping, leave this field blank.false_values(List of String) A set of case-sensitive strings that should be interpreted as false values.header_definition(Attributes) How headers will be defined.User Providedassumes the CSV does not have a header row and uses the headers provided andAutogeneratedassumes the CSV does not have a header row and the CDK will generate headers using forf{i}whereiis the index starting from 0. Else, the default behavior is to use the header from the CSV file. If a user wants to autogenerate or provide column names for a CSV having headers, they can skip rows. (see below for nested schema)ignore_errors_on_fields_mismatch(Boolean) Whether to ignore errors that occur when the number of fields in the CSV does not match the number of columns in the schema. Default: falsenull_values(List of String) A set of case-sensitive strings that should be interpreted as null values. For example, if the value 'NA' should be interpreted as null, enter 'NA' in this field.quote_char(String) The character used for quoting CSV values. To disallow quoting, make this field blank. Default: """skip_rows_after_header(Number) The number of rows to skip after the header row. Default: 0skip_rows_before_header(Number) The number of rows to skip before the header row. For example, if the header row is on the 3rd row, enter 2 in this field. Default: 0strings_can_be_null(Boolean) Whether strings can be interpreted as null values. If true, strings that match the null_values set will be interpreted as null. If false, strings that match the null_values set will be interpreted as the string itself. Default: truetrue_values(List of String) A set of case-sensitive strings that should be interpreted as true values.
Optional:
autogenerated(Attributes) (see below for nested schema)from_csv(Attributes) (see below for nested schema)user_provided(Attributes) (see below for nested schema)
Required:
column_names(List of String) The column names that will be used while emitting the CSV records
Optional:
decimal_as_float(Boolean) Whether to convert decimal fields to floats. There is a loss of precision when converting decimals to floats, so this is not recommended. Default: false
Optional:
processing(Attributes) Processing configuration (see below for nested schema)skip_unprocessable_files(Boolean) If true, skip files that cannot be parsed and pass the error message along as the _ab_source_file_parse_error field. If false, fail the sync. Default: truestrategy(String) The strategy used to parse documents.fastextracts text directly from the document which doesn't work for all files.ocr_onlyis more reliable, but slower.hi_resis the most reliable, but requires an API key and a hosted instance of unstructured and can't be used with local mode. See the unstructured.io documentation for more details: https://unstructured-io.github.io/unstructured/core/partition.html#partition-pdf. Default: "auto"; must be one of ["auto", "fast", "ocr_only", "hi_res"]
Optional:
local(Attributes) Process files locally, supportingfastandocrmodes. This is the default option. (see below for nested schema)
Import is supported using the following syntax:
terraform import airbyte_source_microsoft_sharepoint.my_airbyte_source_microsoft_sharepoint ""