Skip to content
Lyft Data Docs (Beta)

Microsoft Graph

Microsoft Graph (microsoft-graph)

Ingest data from Microsoft Graph resources such as mail, calendars, or directory objects via REST calls.

API Microsoft json

Minimal example

input:
  microsoft-graph:
    credential: ""
    credential-scope-mode: allowed
    resource: ~
JSON 
{
  "input": {
    "microsoft-graph": {
      "credential": "",
      "credential-scope-mode": "allowed",
      "resource": null
    }
  }
}

Contents

Fields

FieldTypeRequiredDescription
credential Authenticationcredential-id (string)✅Credential identifier managed by the credential manager.
Examples: 2b64d2a0-0b76-4cd0-9ef0-3f0ef3d2a9a1
credential-scope-mode AuthenticationCredential Scope Mode✅How to choose the scopes bound to this job when using the credential.
Allowed values: allowed, custom
resource Requeststring✅Graph resource path (e.g. /users/{user-id}/messages).
credential-scopes Authenticationstring[]Custom scopes to bind to this job when credential-scope-mode is custom.
trigger TriggerTriggerInterval-based polling schedule. Leave empty to run once when the job starts.
retry ReliabilityRetryRetry policy to use when Microsoft Graph returns errors or throttling responses.
batch BatchingBatchBatch configuration when issuing bulk requests (for example, large message pulls).
api-version RequestApi VersionAPI version to target (v1.0 stable or beta).
Allowed values: v1, beta
query Requestmap (string)Optional querystring parameters appended to every request.
payload-mode PayloadPayload ModePayload mode describing how events should be emitted (JSON vs binary).
Allowed values: auto, json, raw, binary
delta Delta SyncDeltaDelta synchronization settings that let the connector resume where it left off.

Authentication

Show fields
FieldTypeRequiredDescription
credentialcredential-id (string)✅Credential identifier managed by the credential manager.
Examples: 2b64d2a0-0b76-4cd0-9ef0-3f0ef3d2a9a1
credential-scope-modeCredential Scope Mode✅How to choose the scopes bound to this job when using the credential.
Allowed values: allowed, custom
credential-scopesstring[]Custom scopes to bind to this job when credential-scope-mode is custom.

Request

Show fields
FieldTypeRequiredDescription
resourcestring✅Graph resource path (e.g. /users/{user-id}/messages).
api-versionApi VersionAPI version to target (v1.0 stable or beta).
Allowed values: v1, beta
querymap (string)Optional querystring parameters appended to every request.

Trigger

Show fields
FieldTypeRequiredDescription
triggerTriggerInterval-based polling schedule. Leave empty to run once when the job starts.

Reliability

Show fields
FieldTypeRequiredDescription
retryRetryRetry policy to use when Microsoft Graph returns errors or throttling responses.

Batching

Show fields
FieldTypeRequiredDescription
batchBatchBatch configuration when issuing bulk requests (for example, large message pulls).

Payload

Show fields
FieldTypeRequiredDescription
payload-modePayload ModePayload mode describing how events should be emitted (JSON vs binary).
Allowed values: auto, json, raw, binary

Delta Sync

Show fields
FieldTypeRequiredDescription
deltaDeltaDelta synchronization settings that let the connector resume where it left off.

Schema

Trigger - Cron - Window - Start Options

OptionNameTypeDescription
start-timeStart Timeobject
trackedTrackedstringExamples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Interval - Window - Start Options

OptionNameTypeDescription
start-timeStart Timeobject
trackedTrackedstringExamples: /path/to/file, c:\users\joe\data\file.txt

Trigger Options

OptionNameTypeDescription
messageMessageobject
cronCronobject
intervalIntervalobject

Trigger - Message Fields

FieldTypeRequiredDescription
limitnumber (integer)The number of times to run the input.
Examples: 42, 1.2e-10
filter-kindFilter KindSpecifies whether the message originated from the “system” or by the “user”.
Allowed values: system, user, runtime-artifact-fetch, runtime-artifact-fetch-error, runtime-artifact-clear, runtime-artifact-clear-ack, runtime-artifact-fetch-reply, runtime-artifact-update, …
filter-sourceFilter Source[]Specifies what process generated the message. Was it a “server”, “worker” or “job”?
Allowed values: job, worker, server
filter-workerstringSpecifies what worker to select.
filter-jobstringSpecifies the name of the job that the message came from.
filter-typeFilter Type[]Specifies that particular types of message ought to match.
Allowed values: worker-licensed, worker-unlicensed, variable, variable-deleted, begin-shutting-down-job, begin-shutting-down-server, begin-shutting-down-worker, broadcast-job-thread-state, …
filter-tagstringSpecifies that messages matched ought to carry a tag with a particular value. This only matches against user-generated messages.

Trigger - Cron - Window - Start - Start Time Fields

FieldTypeRequiredDescription
start-timetime-format (string)✅Allows the windowing to start at a specified time.
Hint: %Y-%m-%d %H:%M:%S%.3f %z
highwatermark-filepath (string)✅Specify file where timestamp would be stored in order to resume, for when Job has been restarted.
Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Cron - Window Fields

FieldTypeRequiredDescription
sizeduration (string)✅Window size.
offsetduration (string)Window offset.
startStartSpecify file where timestamp would be stored in order to resume, for when Job has been restarted.

Trigger - Cron Fields

FieldTypeRequiredDescription
croncron-expression (string)✅The Cron pattern.
immediateboolean (bool)Run as soon as invoked, instead of waiting for the specified cron interval.
random-offsetduration (string)Sets a random offset to the schedule, then sticks to it.
windowWindowOptional window definition when the schedule should only read a bounded range.

Trigger - Interval - Window - Start - Start Time Fields

FieldTypeRequiredDescription
start-timetime-format (string)✅Allows the windowing to start at a specified time.
Hint: %Y-%m-%d %H:%M:%S%.3f %z
highwatermark-filepath (string)✅Specify file where timestamp would be stored in order to resume, for when Job has been restarted.
Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Interval - Window Fields

FieldTypeRequiredDescription
sizeduration (string)✅Window size.
offsetduration (string)Window offset.
startStartSpecify file where timestamp would be stored in order to resume, for when Job has been restarted.

Trigger - Interval Fields

FieldTypeRequiredDescription
durationduration (string)✅Duration to wait between events.
random-offsetduration (string)Sets a random offset to the schedule, then sticks to it.
windowWindowOptional window definition when the interval should only cover a bounded range.

Retry Fields

FieldTypeRequiredDescription
timeouttime-interval (string)✅timeout (e.g. 500ms, 2s etc. - default is 30).
Examples: 500ms, 2h
retriesnumber (integer)number of retries.
Examples: 42, 1.2e-10

Batch Fields

FieldTypeRequiredDescription
uuid-fieldfield (string)Field where generated uuid, the unique marker for the group, will be stored.
Examples: data_field
invocation-time-fieldfield (string)Field where invocation time will be stored.
Examples: data_field
completion-time-fieldfield (string)Field where completion (end of execution) time will be stored.
Examples: data_field
begin-marker-fieldfield (string)Field used to mark first event in the group.
Examples: data_field
end-marker-fieldfield (string)Field used to mark last event in the group.
Examples: data_field
line-count-fieldfield (string)Field used to store the line count of the batch.
Examples: data_field
line-num-fieldfield (string)Field used to store the line number of the batch.
Examples: data_field

Delta Fields

FieldTypeRequiredDescription
persist-tostringPath where delta state should be persisted.
initial-urlstringSeed delta link when starting from an external checkpoint.

Query Table

ParameterValue
paramvalue

Value format: templated-text.

Credential Scope Mode Options

ValueDescription
allowedAllowed
customCustom

Trigger - Message - Filter Kind Options

ValueDescription
systemSystem
userUser
runtime-artifact-fetchRuntime Artifact Fetch
runtime-artifact-fetch-errorRuntime Artifact Fetch Error
runtime-artifact-clearRuntime Artifact Clear
runtime-artifact-clear-ackRuntime Artifact Clear Ack
runtime-artifact-fetch-replyRuntime Artifact Fetch Reply
runtime-artifact-updateRuntime Artifact Update
runtime-artifact-update-ackRuntime Artifact Update Ack

Trigger - Message - Filter Source Options

ValueDescription
jobJob
workerWorker
serverServer

Trigger - Message - Filter Type Options

ValueDescription
worker-licensedWorker Licensed
worker-unlicensedWorker Unlicensed
variableVariable
variable-deletedVariable Deleted
begin-shutting-down-jobBegin Shutting Down Job
begin-shutting-down-serverBegin Shutting Down Server
begin-shutting-down-workerBegin Shutting Down Worker
broadcast-job-thread-stateBroadcast Job Thread State
broadcast-server-thread-stateBroadcast Server Thread State
broadcast-worker-thread-stateBroadcast Worker Thread State
check-job-report-timeCheck Job Report Time
check-worker-report-timeCheck Worker Report Time
de-register-job-thread-dependencyDe Register Job Thread Dependency
de-register-server-thread-dependencyDe Register Server Thread Dependency
de-register-worker-thread-dependencyDe Register Worker Thread Dependency
deployed-job-activeDeployed Job Active
deployed-job-removedDeployed Job Removed
deployed-job-should-be-runningDeployed Job Should Be Running
deployment-phaseDeployment Phase
heart-beatHeart Beat
initialise-internal-stateInitialise Internal State
initialise-job-statesInitialise Job States
job-batch-endJob Batch End
job-backlog-updateJob Backlog Update
job-checkpoint-updateJob Checkpoint Update
job-deploy-readyJob Deploy Ready
job-deployedJob Deployed
job-document-endJob Document End
job-document-startJob Document Start
job-errorsJob Errors
job-execution-anomalyJob Execution Anomaly
job-execution-statusJob Execution Status
job-emit-customJob Emit Custom
job-finishedJob Finished
job-idleJob Idle
job-initiatedJob Initiated
job-is-processingJob Is Processing
job-logsJob Logs
job-metricsJob Metrics
job-notificationsJob Notifications
job-removingJob Removing
job-removedJob Removed
job-remove-failedJob Remove Failed
job-remove-readyJob Remove Ready
job-replacedJob Replaced
job-requiredJob Required
job-run-endedJob Run Ended
job-runtime-errorJob Runtime Error
job-runtime-settingsJob Runtime Settings
job-run-startedJob Run Started
job-running-dockerJob Running Docker
job-running-scriptJob Running Script
job-running-subprocessJob Running Subprocess
job-running-system-dJob Running System D
job-settingsJob Settings
job-step-statisticsJob Step Statistics
job-startedJob Started
job-stagedJob Staged
job-state-transitionJob State Transition
job-shutting-downJob Shutting Down
job-stoppingJob Stopping
job-stoppedJob Stopped
job-timed-outJob Timed Out
job-suspicious-silenceJob Suspicious Silence
job-thread-stateJob Thread State
job-traceJob Trace
job-trace-requires-samplesJob Trace Requires Samples
job-updatedJob Updated
job-worker-comms-errorJob Worker Comms Error
job-unstagedJob Unstaged
license-state-changedLicense State Changed
license-validation-failedLicense Validation Failed
license-validation-okLicense Validation Ok
license-volume-violationLicense Volume Violation
new-licenseNew License
override-job-coordinated-shutdownOverride Job Coordinated Shutdown
override-server-coordinated-shutdownOverride Server Coordinated Shutdown
override-worker-coordinated-shutdownOverride Worker Coordinated Shutdown
register-job-thread-dependencyRegister Job Thread Dependency
register-server-thread-dependencyRegister Server Thread Dependency
register-worker-thread-dependencyRegister Worker Thread Dependency
run-job-failureRun Job Failure
server-logsServer Logs
server-metrics-batchServer Metrics Batch
server-startedServer Started
server-startingServer Starting
server-stoppingServer Stopping
server-thread-stateServer Thread State
server-worker-comms-errorServer Worker Comms Error
shutdown-jobsShutdown Jobs
shutdown-workerShutdown Worker
system-shutdownSystem Shutdown
update-upstream-sync-for-jobUpdate Upstream Sync For Job
update-upstream-sync-for-workerUpdate Upstream Sync For Worker
update-variableUpdate Variable
user-alertUser Alert
user-generatedUser Generated
user-notificationUser Notification
worker-command-for-jobWorker Command For Job
worker-auth-lease-ackWorker Auth Lease Ack
worker-connectedWorker Connected
worker-createdWorker Created
worker-debug-heart-beatWorker Debug Heart Beat
worker-errorWorker Error
worker-first-seenWorker First Seen
worker-heart-beatWorker Heart Beat
worker-logsWorker Logs
worker-metrics-batchWorker Metrics Batch
worker-offlineWorker Offline
worker-requests-auth-leaseWorker Requests Auth Lease
worker-server-comms-errorWorker Server Comms Error
worker-settingsWorker Settings
worker-shutdownWorker Shutdown
worker-shutting-downWorker Shutting Down
worker-startedWorker Started
worker-state-uuidWorker State Uuid
worker-stoppingWorker Stopping
worker-suspicious-silenceWorker Suspicious Silence
worker-system-informationWorker System Information
worker-thread-stateWorker Thread State
worker-updatedWorker Updated
worker-modifiedWorker Modified
worker-removedWorker Removed
context-changedContext Changed
rerender-deploymentRerender Deployment
job-killedJob Killed
message-servicedMessage Serviced
failed-to-service-messageFailed To Service Message
worker-wants-initial-settingsWorker Wants Initial Settings
worker-wants-initial-settings-replyWorker Wants Initial Settings Reply
worker-wants-deployed-jobsWorker Wants Deployed Jobs
worker-wants-deployed-jobs-replyWorker Wants Deployed Jobs Reply
worker-wants-job-configurationWorker Wants Job Configuration
worker-wants-job-configuration-replyWorker Wants Job Configuration Reply
job-wants-dslir-keyJob Wants Dslir Key
job-wants-dslir-key-replyJob Wants Dslir Key Reply
worker-wants-dslir-keyWorker Wants Dslir Key
worker-wants-dslir-key-replyWorker Wants Dslir Key Reply
job-wants-variablesJob Wants Variables
job-wants-variables-replyJob Wants Variables Reply
job-wants-credentialsJob Wants Credentials
job-wants-credentials-replyJob Wants Credentials Reply
job-wants-credentials-errorJob Wants Credentials Error
job-wants-secret-variables-replyJob Wants Secret Variables Reply
job-credentials-invalidatedJob Credentials Invalidated
aggregator-healthAggregator Health
worker-verification-tokenWorker Verification Token
worker-requests-verification-tokenWorker Requests Verification Token
runtime-artifact-updateRuntime Artifact Update
runtime-artifact-update-ackRuntime Artifact Update Ack
runtime-artifact-clearRuntime Artifact Clear
runtime-artifact-clear-ackRuntime Artifact Clear Ack
runtime-artifact-fetchRuntime Artifact Fetch
runtime-artifact-fetch-replyRuntime Artifact Fetch Reply
runtime-artifact-fetch-errorRuntime Artifact Fetch Error

Api Version Options

ValueDescription
v1V1
betaBeta

Payload Mode Options

ValueDescription
autoAuto
jsonJson
rawRaw
binaryBinary