tap-ms-graph - Meltano Hub

Microsoft Graph

tap-ms-graph (slalom-consulting variant)🥈

Microsoft Graph REST API

The tap-ms-graph extractor pulls data from Microsoft Graph that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-ms-graph extractor to your project using
```
meltano add
```
:

meltano add extractor tap-ms-graph

Configure the tap-ms-graph settings using

meltano config

:

meltano config tap-ms-graph set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-ms-graph test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-ms-graph may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-ms-graph settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

api_url
api_version
auth_url
client_id
client_secret
include_odata_type
stream_config
tenant

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-ms-graph list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API URL (api_url)

Environment variable: TAP_MS_GRAPH_API_URL

Override the Graph API service base URL. Required if using a national cloud.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set api_url [value]

API Version (api_version)

Environment variable: TAP_MS_GRAPH_API_VERSION
Default Value: v1.0

The version of the Microsoft Graph API to use.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set api_version [value]

Auth URL (auth_url)

Environment variable: TAP_MS_GRAPH_AUTH_URL

Override the Azure AD authentication base URL. Required if using a national cloud.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set auth_url [value]

Client ID (client_id)

Environment variable: TAP_MS_GRAPH_CLIENT_ID

The application ID that the Azure app registration portal assigned to the registered app.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set client_id [value]

Client Secret (client_secret)

Environment variable: TAP_MS_GRAPH_CLIENT_SECRET

The client secret generated for the app in the app registration portal.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set client_secret [value]

Include Odata Type (include_odata_type)

Environment variable: TAP_MS_GRAPH_INCLUDE_ODATA_TYPE
Default Value: false

Include '@odata_type' field when returned from API.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set include_odata_type [value]

Stream Config (stream_config)

Environment variable: TAP_MS_GRAPH_STREAM_CONFIG

Custom configuration for streams.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set stream_config [value]

Tenant (tenant)

Environment variable: TAP_MS_GRAPH_TENANT

The directory tenant to request permission from. The value can be in GUID or a friendly name format.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set tenant [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_MS_GRAPH_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_MS_GRAPH_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_MS_GRAPH_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_MS_GRAPH_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-ms-graph set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-ms-graph extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-ms-graph

Maintenance Status

Repo

https://github.com/Slalom-Consulting/tap-ms-graph

Maintainer

Meltano Stats

Keywords