Microsoft OneNote Verbindungsdetails
Einführung
Connector-Version
Diese Dokumentation basiert auf Version 23.0.8804 des Connectors.
Erste Schritte
Versionsunterstützung für Microsoft OneNote
Alle gehosteten Versionen von Microsoft OneNote werden über die Microsoft Graph API v1.0 unterstützt. Enthält Informationen, auf die über die OneNote-Notizbücher, Abschnitte und Seiten eines Benutzers in einem persönlichen oder Organisationskonto zugegriffen werden kann.
Herstellen einer Verbindung
Mit Microsoft OneNote verbinden
Für die Verbindung mit Microsoft OneNote Datenquellen stehen zwei Authentifizierungsmethoden zur Verfügung:
- OAuth 2.0-basierte Methoden: Microsoft OneNote bietet OAuth 2.0-basierte Authentifizierung sowohl über die Microsoft Entra ID als auch über den Microsoft Entra-Dienstprinzipal.
- Für die Microsoft Entra ID Authentifizierung setzen Sie
AuthScheme
ZuAzureAD
. - Für die Microsoft Entra-Dienstprinzipalauthentifizierung legen Sie fest
AuthScheme
ZuAzureServicePrincipal
.
- Für die Microsoft Entra ID Authentifizierung setzen Sie
- Managed Service Identity (MSI)-Authentifizierung. Um diese Methode zu verwenden, setzen Sie
AuthScheme
ZuAzureMSI
.
Die folgenden Unterabschnitte beschreiben jede Authentifizierungsmethode im Detail.
Microsoft Entra ID
Azure AD ist der mehrinstanzenfähige, cloudbasierte Verzeichnis- und Identitätsverwaltungsdienst von Microsoft. Es handelt sich um eine benutzerbasierte Authentifizierung, für die Sie Folgendes festlegen müssen: AuthScheme
Zu AzureAD
.
Desktop-Anwendungen
bietet eine eingebettete OAuth-Anwendung, die die Authentifizierung am Desktop vereinfacht.
Legen Sie vor der Verbindung die folgenden Variablen fest:
-
InitiateOAuth
:GETANDREFRESH
. Wird verwendet, um automatisch die abzurufen und zu aktualisierenOAuthAccessToken
. bietet eine eingebettete OAuth-Anwendung, die die Authentifizierung auf dem Desktop vereinfacht, d. h. in Situationen, in denen der Benutzer einen lokalen Server verwendet, der nicht mit dem Internet verbunden ist.Sie können sich auch vom Desktop aus über eine benutzerdefinierte OAuth-Anwendung authentifizieren, die Sie in der Microsoft OneNote-Konsole konfigurieren und registrieren. Weitere Informationen finden Sie unter Erstellen einer benutzerdefinierten Authentifizierungs-App.
-
Custom Microsoft Entra ID applications only
:OAuthClientId
: Die Client-ID, die Ihnen bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung zugewiesen wurde.OAuthClientSecret
: Das Client-Geheimnis, das Ihnen bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung zugewiesen wurde.CallbackURL
: Die Umleitungs-URI, die bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung definiert wurde.
Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von Microsoft OneNote in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen. Anschließend schließt der Connector den OAuth-Prozess ab:
- Extrahiert das Zugriffstoken aus der Rückruf URL und authentifiziert Anfragen.
- Erhält einen neuen Zugriffstoken, wenn der alte abläuft.
- Speichert OAuth-Werte in
OAuthSettingsLocation
. Diese Werte bleiben über Verbindungen hinweg bestehen.
Wenn das Zugriffstoken abläuft, aktualisiert der Connector es automatisch.
Microsoft Entra-Dienstprinzipal
Azure Service Principal ist eine rollenbasierte, anwendungsbasierte Authentifizierung. Das bedeutet, dass die Authentifizierung pro Anwendung und nicht pro Benutzer erfolgt. Alle von der Anwendung übernommenen Aufgaben werden ohne Standardbenutzerkontext, sondern basierend auf den zugewiesenen Rollen ausgeführt. Der Anwendungszugriff auf die Ressourcen wird über die Berechtigungen der zugewiesenen Rollen gesteuert.
Informationen zum Einrichten der Microsoft Entra-Dienstprinzipalauthentifizierung finden Sie unter
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide auf OAuth basieren.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie die Administratorzustimmung für eine benutzerdefinierte OAuth-Anwendung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In portal.azure.com
:
- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Arten der Authentifizierung zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatauthentifizierung: In
- Auswählen
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen. Anschließend müssen Sie eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Auswählen
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Zustimmung des Administrators
Einige benutzerdefinierte Anwendungen erfordern Administratorberechtigungen, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratoreinwilligung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Kundenanmeldeinformationen
OAuth unterstützt die Verwendung von Clientanmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Clientanmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, mit der Ausnahme, dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen zu verwenden, wie oben beschrieben.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre spezielle Integration gelten.
.
Verwaltete Dienstidentität (MSI)
Wenn Sie Microsoft OneNote auf einer Azure-VM ausführen und MSI zur Verbindung nutzen möchten, setzen Sie AuthScheme
Zu AzureMSI
.
Benutzerverwaltete Identitäten
Um ein Token für eine verwaltete Identität zu erhalten, verwenden Sie OAuthClientId
Eigenschaft zur Angabe der „client_id“ der verwalteten Identität.
Wenn Ihre VM über mehrere benutzerzugewiesene verwaltete Identitäten verfügt, müssen Sie außerdem angeben OAuthClientId
.
Microsoft Entra-Dienstprinzipal verwenden
Microsoft Entra-Dienstprinzipal
Azure Service Principal ist eine rollenbasierte, anwendungsbasierte Authentifizierung. Dies bedeutet, dass die Authentifizierung pro Anwendung und nicht pro Benutzer erfolgt. Alle von der App ausgeführten Aufgaben werden ohne Standardbenutzerkontext, sondern basierend auf den zugewiesenen Rollen ausgeführt. Der Anwendungszugriff auf die Ressourcen wird über die Berechtigungen der zugewiesenen Rollen gesteuert.
Um die Dienstprinzipalauthentifizierung von Microsoft Entra zu verwenden, müssen Sie:
-
Richten Sie die Möglichkeit ein, der Authentifizierungsanwendung eine Rolle zuzuweisen. Erstellen Sie dazu eine benutzerdefinierte OAuth AD-Anwendung, wie in
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide OAuth-basiert sind.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie einer benutzerdefinierten OAuth-Anwendung die Administratorzustimmung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In
portal.azure.com
:- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die festlegen
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die festlegen
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Authentifizierungsarten zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatsauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatsauthentifizierung: In
- Wählen Sie
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen, und dann eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In
portal.azure.com
:- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
-Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Wählen Sie
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Administratorzustimmung
Für einige benutzerdefinierte Anwendungen sind Administratorberechtigungen erforderlich, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratorzustimmung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Client-Anmeldeinformationen
OAuth unterstützt die Verwendung von Client-Anmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Client-Anmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, außer dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen wie oben beschrieben zu verwenden.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre jeweilige Integration gelten.
.
- Registrieren Sie eine Anwendung mit einem Microsoft Entra ID Mandanten, um einen neuen Dienstprinzipal zu erstellen, der mit der rollenbasierten Zugriffssteuerung verwendet werden kann, um auf Ressourcen in Ihrem Abonnement zuzugreifen.
Gehen Sie folgendermaßen vor:
-
Erstellen Sie eine benutzerdefinierte Microsoft Entra ID Anwendung, wie in
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide OAuth-basiert sind.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie einer benutzerdefinierten OAuth-Anwendung die Administratorzustimmung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In
portal.azure.com
:- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die festlegen
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die festlegen
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Authentifizierungsarten zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatsauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatsauthentifizierung: In
- Wählen Sie
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen, und dann eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In
portal.azure.com
:- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
-Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Wählen Sie
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Administratorzustimmung
Für einige benutzerdefinierte Anwendungen sind Administratorberechtigungen erforderlich, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratorzustimmung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Client-Anmeldeinformationen
OAuth unterstützt die Verwendung von Client-Anmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Client-Anmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, außer dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen wie oben beschrieben zu verwenden.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre jeweilige Integration gelten.
.
- Weisen Sie der Anwendung eine Rolle zu:
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
-Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Wählen Sie
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Zustimmung des Administrators
Die Administratorzustimmung erfolgt, wenn der Administrator für einen Microsoft Entra ID Mandanten Berechtigungen für eine benutzerdefinierte Anwendung erteilt, für die ausdrücklich die Zustimmung eines Administrators zum Anwendungsfall erforderlich ist.
Wenn Sie im Azure-Portal eine neue Microsoft Entra ID Anwendung erstellen, müssen Sie angeben, welche Berechtigungen die Anwendung benötigt. Einige Berechtigungen können als „Administratorzustimmung erforderlich“ gekennzeichnet sein. Beispielsweise erfordern alle Gruppenberechtigungen die Administratorzustimmung. Wenn Ihre Anwendung die Administratorzustimmung erfordert, können Sie dies auf zwei Arten tun.
Der einfachste Weg, die Administrator-Zustimmung zu erteilen, besteht darin, dass sich ein Administrator anmeldet portal.azure.com
und navigieren Sie zu der Anwendung, die Sie in App-Registrierungen erstellt haben. Unter API Permissions
, klick Grant Consent
. Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Wenn Ihre Organisation mehrere Mandanten hat oder Sie Anwendungsberechtigungen für andere Mandanten außerhalb Ihrer Organisation erteilen müssen, verwenden Sie GetAdminConsentURL gespeicherte Prozedur zum Generieren der Admin-Autorisierungs URL. Im Gegensatz zur GetOAuthAuthorizationURL gespeicherte Prozedur werden von diesem Endpoint keine wichtigen Informationen zurückgegeben. Stattdessen gibt die OAuth-Anwendung nach erfolgreicher Autorisierung einen Boolean-Wert zurück, der angibt, dass Berechtigungen erteilt wurden.
Nachdem der Administrator die OAuth-Anwendung genehmigt hat, können Sie mit der Authentifizierung fortfahren.
Client-Anmeldeinformationen
Client-Anmeldeinformationen bezieht sich auf einen Ablauf in OAuth, bei dem keine direkte Benutzerauthentifizierung stattfindet. Stattdessen werden Anmeldeinformationen nur für die Anwendung selbst erstellt. Alle von der Anwendung ausgeführten Aufgaben werden ohne einen Standardbenutzerkontext ausgeführt. Dadurch unterscheidet sich der Authentifizierungsablauf etwas vom Standardablauf.
Für alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow ist die Zustimmung des Administrators erforderlich. Dies bedeutet, dass Sie die mit dem Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwenden können. Sie müssen Ihre eigene OAuth-Anwendung erstellen, um Client-Anmeldeinformationen verwenden zu können. Siehe
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide auf OAuth basieren.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie die Administratorzustimmung für eine benutzerdefinierte OAuth-Anwendung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In portal.azure.com
:
- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Arten der Authentifizierung zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatauthentifizierung: In
- Auswählen
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen. Anschließend müssen Sie eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Auswählen
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Zustimmung des Administrators
Einige benutzerdefinierte Anwendungen erfordern Administratorberechtigungen, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratoreinwilligung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Kundenanmeldeinformationen
OAuth unterstützt die Verwendung von Clientanmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Clientanmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, mit der Ausnahme, dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen zu verwenden, wie oben beschrieben.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre spezielle Integration gelten.
für weitere Informationen.
In Ihrer App-Registrierung in portal.azure.com
, navigieren Sie zu API Berechtigungen und wählen Sie die Microsoft Graph permissions
. Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter „Anwendungsberechtigungen“.
Wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen. Legen Sie anschließend die folgenden Verbindungseigenschaften fest:
AuthScheme
:AzureServicePrincipal
.InitiateOAuth
:GETANDREFRESH
. Sie können InitiateOAuth verwenden, um die Wiederholung des OAuth-Austauschs und das manuelle Festlegen der zu vermeidenOAuthAccessToken
.AzureTenant
: Der Mandant, mit dem Sie sich verbinden möchten.OAuthGrantType
:CLIENT
.OAuthClientId
: Die Client-ID in Ihren Anwendungseinstellungen.OAuthClientSecret
: Das Client-Geheimnis in Ihren Anwendungseinstellungen.
Die Authentifizierung mit Client-Anmeldeinformationen erfolgt automatisch wie bei jeder anderen Verbindung, außer dass kein Fenster geöffnet wird, das den Benutzer auffordert. Da kein Benutzerkontext vorhanden ist, ist kein Browser-Popup erforderlich. Verbindungen werden hergestellt und intern gehandhabt.
Authentifizierungszertifikat
Auth Certificate bezieht sich auf einen OAuth-Flow, der ein Zertifikat verwendet, um die Server-zu-Server-Authentifizierung zu ermöglichen. Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass Sie die mit dem Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwenden können. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um ein OAuth-Zertifikat zu verwenden. Siehe
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide auf OAuth basieren.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie die Administratorzustimmung für eine benutzerdefinierte OAuth-Anwendung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In portal.azure.com
:
- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Arten der Authentifizierung zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatauthentifizierung: In
- Auswählen
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen. Anschließend müssen Sie eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Auswählen
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Zustimmung des Administrators
Einige benutzerdefinierte Anwendungen erfordern Administratorberechtigungen, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratoreinwilligung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Kundenanmeldeinformationen
OAuth unterstützt die Verwendung von Clientanmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Clientanmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, mit der Ausnahme, dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen zu verwenden, wie oben beschrieben.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre spezielle Integration gelten.
für weitere Informationen.
In Ihrer App-Registrierung in portal.azure.com
, navigieren Sie zu API Permissions
und wählen Sie die Client-Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Zertifikatauthentifizierung verwendeten Berechtigungen finden Sie unter „Anwendungsberechtigungen“.
Wählen Sie die Berechtigungen aus, die für Ihre spezielle Integration gelten. Legen Sie anschließend die folgenden Verbindungseigenschaften fest:
AuthScheme
:AzureServicePrincipalCert
.AzureTenant
: Der Mandant, mit dem Sie sich verbinden müssen.OAuthJWTCert
: Der JWT-Zertifikatspeicher.OAuthJWTIssuer
: Die OAuth-Client-ID.OAuthJWTCertType
: Der Typ des Zertifikatspeichers angegeben durchOAuthJWTCert
.
Die Zertifikatsauthentifizierung erfolgt automatisch. Da kein Benutzerkontext vorhanden ist, wird kein Popup angezeigt, das den Zeitpunkt der Authentifizierung signalisiert. Verbindungen werden intern hergestellt und gehandhabt.
Erstellen einer benutzerdefinierten OAuth-Anwendung
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide auf OAuth basieren.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie die Administratorzustimmung für eine benutzerdefinierte OAuth-Anwendung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In portal.azure.com
:
- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Arten der Authentifizierung zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatauthentifizierung: In
- Auswählen
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen. Anschließend müssen Sie eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Auswählen
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Zustimmung des Administrators
Einige benutzerdefinierte Anwendungen erfordern Administratorberechtigungen, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratoreinwilligung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Kundenanmeldeinformationen
OAuth unterstützt die Verwendung von Clientanmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Clientanmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, mit der Ausnahme, dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen zu verwenden, wie oben beschrieben.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre spezielle Integration gelten.
Erstellen einer benutzerdefinierten OAuth-Anwendung
Microsoft OneNote unterstützt die Authentifizierung mit Microsoft Entra ID und Microsoft Entra Service Principal, die beide auf OAuth basieren.
In diesem Thema wird Folgendes beschrieben:
- Erstellen und Registrieren einer benutzerdefinierten OAuth-Anwendung für die Microsoft Entra ID oder den Microsoft Entra-Dienstprinzipal
- Erteilen Sie die Administratorzustimmung für eine benutzerdefinierte OAuth-Anwendung
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung zur Verwendung mit Client-Anmeldeinformationen
Microsoft Entra ID
In portal.azure.com
:
- Melden Sie sich an bei
https://portal.azure.com
. - Wählen Sie im linken Navigationsbereich
Microsoft Entra ID
, DannapplicationRegistrations
. - Klicken Sie auf
New registration
. - Geben Sie einen Namen für die Anwendung ein.
- Wählen Sie die gewünschte Mandantenkonfiguration aus: Einzel- oder Mehrmandant und öffentliche oder private Nutzung.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
AzureTenant
Verbindungseigenschaft auf die ID des Microsoft Entra ID Tenants, wenn eine Verbindung mit dem Microsoft OneNote Connector hergestellt wird. Andernfalls schlägt der Authentifizierungsversuch mit einem Fehler fehl. - Wenn Ihre Anwendung nur für den privaten Gebrauch bestimmt ist, geben Sie an
Accounts in this organization directory only
. - Wenn Sie Ihre Anwendung verteilen möchten, wählen Sie eine der Multi-Tenant-Optionen.
- Wenn Sie die Standardoption „Nur Konten in diesem Organisationsverzeichnis“ auswählen, müssen Sie die
- Setzen Sie die Weiterleitungs URL auf
http://localhost:33333
(Standard des Connectors) ODER geben Sie einen anderen Port an und setzen SieCallbackURL
an die genaue Antwort-URL, die Sie definiert haben. - Klicken Sie auf
Register
, um die neue Anwendung zu registrieren. Ein Anwendungsverwaltungsbildschirm wird angezeigt.
Notieren Sie den Wert inApplication (client) ID
alsOAuthClientId
und dasDirectory (tenant) ID
alsAzureTenant
. - Navigieren Sie zu
Certificates & Secrets
und definieren Sie den Authentifizierungstyp der Anwendung. Es stehen zwei Arten der Authentifizierung zur Verfügung: Zertifikat (empfohlen) oder Client-Geheimnis.- Für die Zertifikatauthentifizierung: In
Certificates & Secrets
, wählenUpload certificate
, und laden Sie dann das Zertifikat von Ihrem lokalen Computer hoch. - Zum Erstellen eines neuen Client-Geheimnisses: In
Certificates & Secrets
, wählenNew Client Secret
für die Anwendung und geben Sie deren Dauer an. Nachdem das Clientgeheimnis gespeichert wurde, zeigt Microsoft OneNote den Schlüsselwert an. Kopieren Sie diesen Wert, da er nur einmal angezeigt wird. Dieser Wert wird zumOAuthClientSecret
.
- Für die Zertifikatauthentifizierung: In
- Auswählen
API Permissions > Add > Delegated permissions
. - Wählen Sie die Microsoft Graph-API aus. Die folgenden delegierten Berechtigungen ermöglichen den Zugriff auf die vollständige Funktionalität des Treiber:
- Lesen und schreiben Sie alle Notizbücher, Abschnitte, Abschnittsgruppen und Seiten.
- Alle Benutzer lesen.
- Alle Gruppen lesen.
- Speichern Sie Ihre Änderungen.
- Wenn Sie die Verwendung von Berechtigungen angegeben haben, für die die Zustimmung des Administrators erforderlich ist (z. B. Anwendungsberechtigungen), können Sie diese vom aktuellen Mandanten aus auf der Seite „API Berechtigungen“ erteilen.
Microsoft Entra-Dienstprinzipal
Um die Microsoft Entra-Dienstprinzipalauthentifizierung zu verwenden, müssen Sie die Möglichkeit einrichten, der Authentifizierungsanwendung eine Rolle zuzuweisen. Anschließend müssen Sie eine Anwendung beim Microsoft Entra ID Mandanten registrieren, um einen neuen Dienstprinzipal zu erstellen. Dieser neue Dienstprinzipal kann dann den zugewiesenen rollenbasierten Zugriff nutzen.
Kontrolle über den Zugriff auf Ressourcen in Ihrem Abonnement.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth AD-Anwendung, wie oben beschrieben.
- Verwenden Sie die Suchleiste, um nach dem Abonnementdienst zu suchen.
- Öffnen Sie die
Subscriptions
Seite. - Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.
- Öffnen Sie die
Access control (IAM)
. - Auswählen
Add > Add role assignment
. Microsoft OneNote öffnet dasAdd role assignment
Seite. - Weisen Sie Ihrer benutzerdefinierten Microsoft Entra ID Anwendung die Rolle zu
Owner
.
Zustimmung des Administrators
Einige benutzerdefinierte Anwendungen erfordern Administratorberechtigungen, um innerhalb eines Microsoft Entra ID Mandanten ausgeführt zu werden. Die Administratorzustimmung kann beim Erstellen einer neuen benutzerdefinierten OAuth-Anwendung erteilt werden, indem relevante Berechtigungen hinzugefügt werden, die bereits mit „Administratorzustimmung erforderlich“ gekennzeichnet sind. Die Administratorzustimmung ist auch erforderlich, um Clientanmeldeinformationen im OAuth-Flow zu verwenden.
So erteilen Sie die Administratoreinwilligung:
- Lassen Sie einen Administrator sich anmelden bei
portal.azure.com
. - Navigieren Sie zu
App Registrations
und suchen Sie die benutzerdefinierte OAuth-Anwendung, die Sie erstellt haben. - Unter
API Permissions
, klickGrant Consent
.
Dadurch erhält Ihre Anwendung Berechtigungen für den Mandanten, unter dem sie erstellt wurde.
Zustimmung zu Kundenanmeldeinformationen
OAuth unterstützt die Verwendung von Clientanmeldeinformationen zur Authentifizierung. In einem OAuth-Flow mit Clientanmeldeinformationen werden Anmeldeinformationen für die authentifizierende Anwendung selbst erstellt. Der Authentifizierungsflow verhält sich wie der übliche Authentifizierungsflow, mit der Ausnahme, dass ein zugeordneter Benutzer nicht aufgefordert wird, Anmeldeinformationen anzugeben.
Alle von der Anwendung akzeptierten Aufgaben werden außerhalb des Kontexts eines Standardbenutzers ausgeführt.
Hinweis
Da die eingebetteten OAuth-Anmeldeinformationen pro Benutzer authentifiziert werden, können Sie sie nicht
in einem Client-OAuth-Flow verwenden. Sie müssen immer eine benutzerdefinierte OAuth-Anwendung erstellen, um Client-Anmeldeinformationen zu verwenden.
In portal.azure.com
:
- Erstellen Sie eine benutzerdefinierte OAuth-Anwendung, wie oben beschrieben.
- Navigieren Sie zu
App Registrations
. - Suchen Sie die Anwendung, die Sie gerade erstellt haben, und öffnen Sie
API Permissions
. - Wählen Sie die Microsoft Graph-Berechtigungen aus. Es gibt zwei verschiedene Berechtigungssätze: Delegiert und Anwendung.
- Unter
Application Permissions
, wählen Sie die Berechtigungen aus, die Sie für Ihre Integration benötigen.
Client-OAuth-Flow mit einem Zertifikat
Alle Berechtigungen im Zusammenhang mit dem Client-OAuth-Flow erfordern die Zustimmung des Administrators. Dies bedeutet, dass die in den Microsoft OneNote Connector eingebettete Anwendung nicht im Client-OAuth-Flow verwendet werden kann. Sie müssen
Erstellen Sie Ihre eigene OAuth-Anwendung, um Client-Anmeldeinformationen zu verwenden, wie oben beschrieben.
Nachdem Ihre OAuth-Anwendung erstellt wurde:
-
Zurück zu
portal.azure.com
. -
Navigieren Sie zu
App Registration
. -
Suchen Sie die Anwendung, die Sie gerade erstellt haben.
-
Unter
API Permissions
, wählen Sie die Microsoft Graph-Berechtigungen aus.Es gibt zwei verschiedene Berechtigungssätze: Delegierte Berechtigungen und Anwendungsberechtigungen. Die während der Client-Anmeldeauthentifizierung verwendeten Berechtigungen finden Sie unter Anwendungsberechtigungen.
-
Wählen Sie die Berechtigungen aus, die für Ihre spezielle Integration gelten.
Administrative Aufgaben
Mit dem Microsoft OneNote Connector können Sie Verwaltungsaufgaben ausführen. Dies können Sie tun, indem Sie die Spalte „UserId“ angeben, um CUD-Vorgänge auszuführen.
Die UserId-Spalte
Viele Tabellen enthalten eine spezielle UserId-Spalte. Diese ist für Administratoren gedacht, die Datensätze im Konto eines anderen Benutzers ändern möchten. Wenn Sie kein Administrator sind oder dieses Verhalten nicht wünschen, geben Sie die UserId nicht an, wenn Sie einen INSERT-/UPDATE-/DELETE Operation ausführen. Wenn Sie beispielsweise Folgendes ausführen, wird ein Notizbuch für einen anderen Benutzer eingefügt:
INSERT INTO Notebooks (displayName, UserId) VALUES ('Test Notebook', '12345')
Die obige Anfrage hat insgesamt den Effekt, dass versucht wird, ein Notizbuch unter der Ressource /users/12345/notebooks hinzuzufügen. Wenn UserId nicht angegeben ist, werden die betroffenen Ressourcen stattdessen unter /users/me/notebooks geändert. Wenn Sie kein Administrator sind, können Sie im Allgemeinen nur Datensätze unter /users/me beeinflussen oder anzeigen. Es wird daher nicht empfohlen, UserId festzulegen, wenn Sie kein Administrator sind.
Wichtige Hinweise
Konfigurationsdateien und ihre Pfade
- Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.
Erweiterte Funktionen
In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des Microsoft OneNote Connectors beschrieben.
Benutzerdefinierte Ansichten
Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.
SSL-Konfiguration
Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert
-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.
Proxy
So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings
Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.
Abfrageverarbeitung
Der Connector verlagert die Verarbeitung der SELECT-Anweisung so weit wie möglich auf Microsoft OneNote und verarbeitet den Rest der Abfrage dann im Speicher (clientseitig).
Benutzerdefinierte Ansichten
Mit dem Microsoft OneNote-Connector können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.
Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:
- Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
- DDL-Anweisungen.
Definieren von Ansichten mithilfe einer Konfigurationsdatei
Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json
. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.
Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews
Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.
Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:
- Jedes Stammelement definiert den Namen einer Ansicht.
- Jedes Stammelement enthält ein untergeordnetes Element namens
query
, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.
Zum Beispiel:
{
"MyView": {
"query": "SELECT * FROM Notebooks WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie UserDefinedViews
Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Definieren von Ansichten mit DDL-Anweisungen
Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.
Erstellen einer Ansicht
Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:
CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;
Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews
Verbindungseigenschaft.
Ändern einer Ansicht
Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:
ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.
Löschen einer Ansicht
Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.
DROP LOCAL VIEW [MyViewName]
Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.
Schema für benutzerdefinierte Ansichten
Benutzerdefinierte Ansichten werden im angezeigt UserViews
Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName
Eigentum.
Arbeiten mit benutzerdefinierten Ansichten
Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers
listet nur Kunden in Raleigh auf:
SELECT * FROM Customers WHERE City = 'Raleigh';
Ein Beispiel für eine Abfrage an den Treiber:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Daraus ergibt sich die effektive Abfrage an die Quelle:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.
SSL-Konfiguration
Anpassen der SSL-Konfiguration
Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.
Um ein anderes Zertifikat anzugeben, siehe SSLServerCert
Eigenschaft für die verfügbaren Formate, um dies zu tun.
Datenmodell
Überblick
In diesem Abschnitt werden die verfügbaren API Objekte angezeigt und weitere Informationen zur Ausführung von SQL für Microsoft OneNote APIs bereitgestellt.
Hauptmerkmale
- Der Connector modelliert Microsoft OneNote Entitäten wie Benutzer und Gruppen als relationale Ansichten, Entitäten wie Notizbücher, Abschnitte, Abschnittsgruppen und Seiten als relationale Tabellen, sodass Sie SQL schreiben können, um Microsoft OneNote Daten Abfrage.
- Gespeicherte Prozeduren ermöglichen Ihnen die Ausführung von Vorgängen in Microsoft OneNote, einschließlich des Abrufens und Aktualisierens des Zugriffstokens in OAuth 2.0.
- Die Live-Konnektivität zu diesen Objekten bedeutet, dass alle Änderungen an Ihrem Microsoft OneNote Konto bei Verwendung des Connectors sofort berücksichtigt werden.
Ansichten
Ansichten beschreibt die verfügbaren Ansichten. Ansichten werden statisch definiert, um Benutzer und Gruppen zu modellieren.
Tabellen
Tabellen beschreibt die verfügbaren Tabellen. Tabellen werden statisch definiert, um Notizbücher, Abschnittsgruppen, Abschnitte und Seiten zu modellieren.
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu OneNote. Sie können zum Suchen, Erstellen und Ändern von Informationen in OneNote verwendet werden.
Tabellen
Der Connector modelliert die Daten in Microsoft OneNote als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.
Microsoft OneNote Connector-Tabellen
Name | Beschreibung |
---|---|
Notebooks | Ruft alle Notizbücher für den authentifizierten Benutzer ab. |
SectionGroups | Ruft für den authentifizierten Benutzer alle Abschnittsgruppen in allen Notizbüchern ab. |
Sections | Ruft für den authentifizierten Benutzer alle Abschnitte aller Notizbücher ab. |
Notebooks
Ruft alle Notizbücher für den authentifizierten Benutzer ab.
Tabellenspezifische Informationen
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber die spezifischen Felder Id, UserId, GroupId und SiteId ändern den Endpoint, den wir zum Abrufen der Daten verwenden. Sie müssen mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM Notebooks WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Notebooks WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-56e2fc02-f3dd-4f82-fvgf-dfsdf4807935')
SELECT * FROM Notebooks WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Notebooks WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM Notebooks WHERE SiteId = 'rssbuscrm.sharepoint.com,9839b8a3-343a-4064-996a-d2a300bc559f,2b6cda85-3573-4578-ae76-dfdde60c771b'
Einfügen
Die Spalte, die zum Ausführen eines Operation in der Notebooks-Tabelle erforderlich ist, ist DisplayName. Wenn der Operation im Namen einer Gruppe oder eines Benutzers ausgeführt wird, muss auch UserId oder GroupId angegeben werden. Die folgenden Beispiele veranschaulichen einen Operation in Notebooks:
INSERT INTO Notebooks (DisplayName) VALUES ('Getting started')
INSERT INTO Notebooks (DisplayName, UserId) VALUES ('Getting started', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Notebooks (DisplayName, GroupId) VALUES ('Getting started', '044d385d-6ca8-4d81-800d-223124b651db')
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
id [KEY] | String | True | Die ID des Notizbuchs. |
self | String | Falsch | Das Selbst des Notizbuchs. |
createdDateTime | Datetime | Falsch | Das Erstellungsdatum und die Uhrzeit des Notebooks. |
createdBy_application_displayName | String | Falsch | Der createdBy_application_displayName des Notebooks. |
createdBy_application_id | String | Falsch | Die createdBy_application_id des Notebooks. |
displayName | String | False | Der Anzeigename des Notizbuchs. |
lastModifiedBy_application_displayName | String | Falsch | Der lastModifiedBy_application_displayName des Notebooks. |
lastModifiedBy_application_id | String | Falsch | Die lastModifiedBy_application_id des Notebooks. |
lastModifiedDateTime | Datetime | Falsch | Das Datum und die Uhrzeit der letzten Änderung des Notizbuchs. |
isDefault | Bool | Falsch | Anzeige, ob das Notebook das Standardnotizbuch ist. |
isShared | Bool | Falsch | Indikator, ob das Notizbuch freigegeben ist. |
links_oneNoteClientUrl_href | String | Falsch | Die links_oneNoteClientUrl_href des Notizbuchs. |
sectionGroupsUrl | String | Falsch | Die Abschnittsgruppen-URL des Notizbuchs. |
sectionsUrl | String | False | Die Abschnitts-URL des Notizbuchs. |
userRole | String | False | Die Benutzerrolle des Notebooks. |
createdBy_user_displayName | String | False | Der vom Benutzer erstellte Anzeigename des Notizbuchs |
createdBy_user_id | String | False | Die createdBy-Benutzer-ID des Notizbuchs |
UserId | String | Falsch | Die Benutzer-ID, die der authentifizierte Benutzer vorgibt. |
GroupId | String | Falsch | Die Gruppen-ID, die der authentifizierte Benutzer imitiert. |
SiteId | String | Falsch | Die ID der Site. |
Abschnittsgruppen
Ruft alle Abschnittsgruppen in allen Notizbüchern für den authentifizierten Benutzer ab.
Tabellenspezifische Informationen
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber die spezifischen Felder Id, UserId, GroupId, SiteId und ParentNotebookId ändern den Endpoint, den wir zum Abrufen der Daten verwenden. Sie müssen mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM SectionGroups WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE ParentNotebookId = '1-2342423-1234-3424-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM SectionGroups WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM SectionGroups WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
Einfügen
Die zum Ausführen eines Operation in der SectionGroups-Tabelle erforderlichen Spalten sind DisplayName und ParentNotebookId. Wenn der INSERT- Operation im Auftrag einer Gruppe oder eines Benutzers ausgeführt wird, muss auch UserId oder GroupId angegeben werden. Die folgenden Beispiele veranschaulichen einen Operation in SectionGroups:
INSERT INTO SectionGroups (DisplayName, ParentNotebookId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
id [KEY] | String | True | Die ID der Abschnittsgruppe. |
self | String | Falsch | Das Selbst der Abschnittsgruppe. |
createdDateTime | Datetime | Falsch | Das Erstellungsdatum und die Uhrzeit der Abschnittsgruppe. |
createdBy_application_displayName | String | Falsch | Der createdBy_application_displayName der Abschnittsgruppe. |
createdBy_application_id | String | Falsch | Die createdBy_application_id der Abschnittsgruppe. |
displayName | String | False | Der Anzeigename der Abschnittsgruppe. |
lastModifiedBy_application_displayName | String | Falsch | Der lastModifiedBy_application_displayName der Abschnittsgruppe. |
lastModifiedBy_application_id | String | Falsch | Die lastModifiedBy_application_id der Abschnittsgruppe. |
lastModifiedDateTime | Datetime | Falsch | Das lastModifiedDateTime der Abschnittsgruppe. |
sectionGroupsUrl | String | Falsch | Die sectionGroupsUrl der Abschnittsgruppe. |
sectionsUrl | String | Falsch | Die Abschnitts-URL der Abschnittsgruppe. |
ParentNotebookId | String | False | Die ParentNotebookId der Abschnittsgruppe. |
ParentSectionGroupId | String | Falsch | Die ParentSectionGroupId der Abschnittsgruppe. |
createdBy_user_displayName | String | Falsch | Der createdBy_user_displayName der Abschnittsgruppe. |
createdBy_user_id | String | Falsch | Die createdBy_user_id der Abschnittsgruppe. |
UserId | String | Falsch | Die Benutzer-ID, die der authentifizierte Benutzer imitiert. |
GroupId | String | Falsch | Die Gruppen-ID, die der authentifizierte Benutzer imitiert. |
SiteId | String | Falsch | Die ID der Sharepoint-Site. |
Abschnitte
Ruft alle Abschnitte aller Notizbücher für den authentifizierten Benutzer ab.
Tabellenspezifische Informationen
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber die spezifischen Felder Id, UserId, GroupId, SiteId, ParentNotebookId und ParentSectionGroupId ändern den Endpoint, den wir zum Abrufen der Daten verwenden. Sie müssen mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM Sections WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentNotebookId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentSectionGroupId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentSectionGroupId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Sections WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'
SELECT * FROM Sections WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
Einfügen
Die zum Ausführen eines Operation in der Tabelle „Abschnitte“ erforderlichen Spalten sind DisplayName und ParentNotebookId. Wenn der Operation im Namen einer Gruppe oder eines Benutzers ausgeführt wird, muss auch UserId oder GroupId angegeben werden. Die folgenden Beispiele veranschaulichen einen Operation in Abschnitten:
INSERT INTO Sections (DisplayName, ParentNotebookId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO Sections (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Sections (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started', '1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')
Spalten
Name | Typ | Nur Lesen | Beschreibung |
---|---|---|---|
id [KEY] | String | True | Die ID des Abschnitts. |
self | String | Falsch | Das Selbst des Abschnitts. |
createdDateTime | Datetime | Falsch | Das Erstellungsdatum und die Uhrzeit des Abschnitts. |
createdBy_application_displayName | String | Falsch | Der createdBy_application_displayName des Abschnitts. |
createdBy_application_id | String | Falsch | Die createdBy_application_id des Abschnitts. |
displayName | String | False | Der Anzeigename des Abschnitts. |
lastModifiedBy_application_displayName | String | Falsch | Der lastModifiedBy_application_displayName des Abschnitts. |
lastModifiedBy_application_id | String | Falsch | Die lastModifiedBy_application_id des Abschnitts. |
lastModifiedDateTime | Datetime | Falsch | Das lastModifiedDateTime des Abschnitts. |
isDefault | Bool | Falsch | Der isDefault des Abschnitts. |
links_oneNoteClientUrl_href | String | Falsch | Die links_oneNoteClientUrl_href des Abschnitts. |
pagesUrl | String | False | Die Seiten-URL des Abschnitts. |
ParentNotebookId | String | Falsch | Die ParentNotebookId des Abschnitts. |
ParentSectionGroupId | String | Falsch | Die ParentSectionGroupId des Abschnitts. |
createdBy_user_displayName | String | Falsch | Der createdBy_user_displayName des Abschnitts. |
createdBy_user_id | String | Falsch | Die createdBy_user_id des Abschnitts. |
UserId | String | Falsch | Die Benutzer-ID, die der authentifizierte Benutzer vorgibt. |
GroupId | String | Falsch | Die Gruppen-ID, die der authentifizierte Benutzer vorgibt. |
SiteId | String | Falsch | Die ID der Sharepoint-Site. |
Ansichten
Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.
Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.
Microsoft OneNote Connector-Ansichten
Name | Beschreibung |
---|---|
Groups | Ruft alle Microsoft Entra ID Gruppen (Azure AD) ab, bei denen es sich um Office 365-Gruppen oder Sicherheitsgruppen handeln kann. |
Pages | Ruft für den authentifizierten Benutzer alle Seiten aus allen Notizbüchern ab. |
PagesContent | Ruft den Inhalt für die Seiten ab |
Sites | Ruft alle Sites für den authentifizierten Benutzer ab. |
Users | Ruft alle Microsoft Entra ID Benutzerkonten innerhalb der authentifizierten Berechtigungen ab. |
Gruppen
Ruft alle Microsoft Entra ID Gruppen (Azure AD) ab, bei denen es sich um Office 365-Gruppen oder Sicherheitsgruppen handeln kann.
Tabellenspezifische Informationen
Gruppen erfordern Administratorberechtigungen. Um mit ihnen arbeiten zu können, müssen Sie Ihre eigene benutzerdefinierte OAuth-App erstellen und die entsprechenden festlegen OAuthClientId
Und OAuthClientSecret
. In dieser App müssen Sie sie so konfigurieren, dass sie die Berechtigung Group.Read.All anfordert. Dies können Sie unter https://apps.dev.microsoft.com
oder im Bereich „App-Registrierungen“ unter http://portal.azure.com
. Siehe Erstellen einer benutzerdefinierten Authentifizierungs-App für weitere Details zum Erstellen einer benutzerdefinierten App.
Um Gruppenberechtigungen zu autorisieren, muss ein Administrator die Gruppenberechtigungen für Ihre gesamte Organisation erteilen. Dies kann über den Endpoint erfolgen. Lassen Sie den Administrator einfach zur folgenden Webseite navigieren und Berechtigungen erteilen. Führen Sie anschließend die OAuth-Autorisierung wie gewohnt aus.
https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber das spezifische ID-Feld ändert den Endpoint, den wir zum Abrufen der Daten verwenden. Es muss mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM Groups WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Groups WHERE ID IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')
Spalten
Name | Typ | Beschreibung |
---|---|---|
ParentReference | String | Die übergeordnete Referenz der Gruppe. |
id [KEY] | String | Die ID der Gruppe. |
deletedDateTime | Datetime | Datum und Uhrzeit der Löschung der Gruppe. |
allowExternalSenders | Bool | Der Indikator zeigt an, ob externe Absender zugelassen werden sollen oder nicht. |
assignedLabels | String | Die vergebenen Labels der Gruppe |
assignedLicenses | String | Die zugewiesenen Lizenzen der Gruppe. |
autoSubscribeNewMembers | Bool | Der Indikator zeigt an, ob neue Mitglieder automatisch angemeldet werden sollen. |
classification | String | Die Einstufung der Gruppe. |
createdDateTime | Datetime | Das Erstellungsdatum und die Uhrzeit der Gruppe. |
description | String | Die Beschreibung der Gruppe. |
displayName | String | Der Anzeigename der Gruppe. |
expirationDateTime | Datetime | Das Ablaufdatum und die Ablaufzeit der Gruppe. |
groupTypes | String | Die Typen der Gruppe. |
hasMembersWithLicenseErrors | Bool | Anzeige, ob es Mitglieder mit Lizenzfehlern gibt. |
hideFromAddressLists | Bool | Das Ausblenden aus Adresslisten der Gruppe. |
hideFromOutlookClients | Bool | Die Option „Vor Outlook-Clients der Gruppe ausblenden“ |
isArchived | Bool | Indikator, ob die Gruppe archiviert ist. |
isSubscribedByMail | Bool | Anzeige, ob die Gruppe per Email abonniert ist. |
licenseProcessingState_state | String | Der Lizenzverarbeitungsstatus der Gruppe. |
mail | String | Die Mail der Gruppe. |
mailEnabled | Bool | Anzeige, ob E-Mail in der Gruppe aktiviert ist. |
mailNickname | String | Der E-Mail-Spitzname der Gruppe. |
membershipRule | String | Die Mitgliedschaftsregel der Gruppe. |
membershipRuleProcessingState | String | Der Verarbeitungsstatus der Mitgliedschaftsregel der Gruppe. |
onPremisesDomainName | String | Der Domänenname der Gruppe. |
onPremisesLastSyncDateTime | Datetime | Das Datum und die Uhrzeit der letzten Synchronisierung der Gruppe. |
onPremisesNetBiosName | String | Der NetBIOS-Name der Gruppe. |
onPremisesProvisioningErrors | String | Die Provisioning-Fehler der Gruppe. |
onPremisesSamAccountName | String | Der SAM-Kontoname der Gruppe. |
onPremisesSecurityIdentifier | String | Die Sicherheitskennung der Gruppe. |
onPremisesSyncEnabled | Bool | Anzeige, ob die Synchronisierung in der Gruppe aktiviert ist. |
preferredDataLocation | String | Der bevorzugte Datenspeicherort der Gruppe. |
preferredLanguage | String | bevorzugte Sprache in der Gruppe. |
proxyAddresses | String | Die Proxy-Adressen der Gruppe. |
renewedDateTime | Datetime | Das erneuerte Datum und die Uhrzeit der Gruppe. |
securityEnabled | Bool | Anzeige, ob Sicherheit in der Gruppe aktiviert ist. |
securityIdentifier | String | Die Sicherheitskennung der Gruppe. |
theme | String | Das Thema der Gruppe. |
unseenCount | Int | Der unsichtbare Graf der Gruppe. |
visibility | String | Die Sichtbarkeit der Gruppe. |
Seiten
Ruft alle Seiten aus Notizbüchern für den authentifizierten Benutzer ab.
Tabellenspezifische Informationen
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber die spezifischen Felder Id, ParentSectionId, UserId, GroupId oder SiteId ändern den Endpoint, den wir zum Abrufen der Daten verwenden. Sie müssen mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM Pages WHERE Id = '1-e8992fa8e5254df387d062d04e75a6e7!6-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE Id IN ('1193-dsdda-9392-4706514c636b', '1193-dsdda-9392-sdfasdw33324')
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND GroupId = '1772bb5a-f8e9-405d-a90b-eac11b0b9b9a'
SELECT * FROM Pages WHERE GroupId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'
SELECT * FROM Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
Spalten
Name | Typ | Beschreibung |
---|---|---|
id [KEY] | String | Die ID der Seite. |
self | String | Das Selbst der Seite. |
createdDateTime | Datetime | Das Erstellungsdatum und die Uhrzeit der Seite. |
contentUrl | String | Die ContentUrl der Seite. |
createdByAppId | String | Die createdByAppId der Seite. |
lastModifiedDateTime | Datetime | Das lastModifiedDateTime der Seite. |
level | Int | Die Ebene der Seite. |
links_oneNoteClientUrl_href | String | Die links_oneNoteClientUrl_href der Seite |
order | Int | Die Reihenfolge der Seite. |
title | String | Der Titel der Seite. |
userTags | String | Die Benutzertags der Seite. |
ParentSectionId | String | Die ParentSectionId der Seite. |
UserId | String | Die Benutzer-ID, die der authentifizierte Benutzer imitiert. |
GroupId | String | Die Gruppen-ID, die der authentifizierte Benutzer imitiert. |
SiteId | String | Die ID der Sharepoint-Site. |
SeitenInhalt
Ruft den Inhalt für die Seiten ab
Tabellenspezifische Informationen
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber die spezifischen Felder PageId, UserId, GroupId oder SiteId ändern den Endpoint, den wir zum Abrufen der Daten verwenden. Sie müssen mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM PagesContent WHERE PageId = '1-396658ffc20744bcb716bdd972cc3bfb!1-26d8f808-d809-4df0-a292-d79499d870d'
SELECT * FROM PagesContent where PageId IN ('1-396658ffc20744bcb716bdd972cc3bfb!1-26d8f808-d809-4df0-a292-d79499d870d7', '1-3c0db927dab643d0bbe402f79e6be51f!1-11a54aa2-2105-4d7b-92c3-6e448fbadcc7', '1-a4375ec1f6cd4183ae142bd1fc54859c!1-11a54aa2-2105-4d7b-92c3-6e448fbadcc7')
SELECT * FROM PagesContent WHERE PageId IN (SELECT Id from Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe') AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM PagesContent WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM PagesContent WHERE SiteId = 'cdata0.sharepoint.com,0a40f113-9f39-459d-a22a-9cc88b46f031,dd4add46-e9ed-4ed8-b479-d55d0721bc7f'
Spalten
Name | Typ | Beschreibung |
---|---|---|
PageId | String | Die ID der Seite. |
Content | String | Der HTML-Inhalt der Seite. |
UserId | String | Die ID des Benutzers. |
GroupId | String | Die ID der Gruppe. |
SiteId | String | Die ID der Site. |
Seiten
Ruft alle Sites für den authentifizierten Benutzer ab.
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id [KEY] | String | Die vollständige Kennung der Site. |
SiteId | String | Die eindeutige Kennung der Websitesammlung. |
WebId | String | Die Web-ID der Site. |
SiteName | String | Der Name der Site. |
Title | String | Der Titel der Site. |
SiteDescription | String | Die Beschreibung der Site. |
Description | String | Die Beschreibung des Artikels. |
CreatedDateTime | Datetime | Datum und Uhrzeit der Site-Erstellung. |
LastModifiedDateTime | Datetime | Datum und Uhrzeit der letzten Änderung der Site. |
SPWebUrl | String | URL, die die Ressource im Browser anzeigt. |
Author | String | Der Autor der Site. |
DocumentSignature | String | Die Dokumentsignatur der Site. |
FileExtension | String | Die Erweiterung der Site-Datei. |
SecondaryFileExtension | String | Die sekundäre Erweiterung der Site-Datei. |
FileType | String | Der Dateityp der Site. |
DocId | Long | Die eindeutige Kennung der Site innerhalb eines geografischen Standorts. |
GeoLocationSource | String | Der geografische Standort der Site. |
HitHighlightedSummary | String | Die ausführliche Zusammenfassung der Site. |
Importance | Long | Die Bedeutung des Standorts. |
IsContainer | Bool | Gibt an, ob die Site ein Ordner ist. |
IsDocument | Bool | Gibt an, ob es sich bei der Site um ein Dokument handelt. |
OriginalPath | String | Der ursprüngliche Site-Pfad. |
Path | String | Der aktuelle Site-Pfad. |
Rank | Double | Der Rang der Site. |
RenderTemplateId | String | Der Name der Steuerelement-Rendervorlage der Site. |
SiteLogo | String | Die URI des Site-Logos. |
ViewsLifeTime | Long | Die Gesamtzahl der Aufrufe seit der Erstellung der Site. |
ViewsRecent | Long | Die Gesamtzahl der Aufrufe der Site in den letzten 14 Tagen. |
WebTemplate | String | Der Webtempel, aus dem die Site erstellt wird. |
Benutzer
Ruft alle Microsoft Entra ID Benutzerkonten innerhalb der authentifizierten Berechtigungen ab.
Tabellenspezifische Informationen
Benutzer benötigen Administratorberechtigungen. Um mit ihnen arbeiten zu können, müssen Sie Ihre eigene benutzerdefinierte OAuth-App erstellen und die entsprechenden festlegen OAuthClientId
Und OAuthClientSecret
. In dieser App müssen Sie sie so konfigurieren, dass sie die Berechtigung User.Read.All anfordert. Dies können Sie unter https://apps.dev.microsoft.com
oder im Bereich „App-Registrierungen“ unter http://portal.azure.com
. Siehe Erstellen einer benutzerdefinierten Authentifizierungs-App für weitere Details zum Erstellen einer benutzerdefinierten App.
Um Benutzerberechtigungen zu autorisieren, muss ein Administrator den Benutzern Berechtigungen für Ihre gesamte Organisation erteilen. Dies kann über den Endpoint erfolgen. Lassen Sie den Administrator einfach zur folgenden Webseite navigieren und Berechtigungen erteilen. Führen Sie anschließend die OAuth-Autorisierung wie gewohnt aus.
https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333
Wählen
Die meisten Filter werden serverseitig gehandhabt, aber das spezifische ID-Feld ändert den Endpoint, den wir zum Abrufen der Daten verwenden. Es muss mit einer '='- oder IN-Bedingung angegeben werden. Beispiel:
SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Users WHERE ID IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')
Spalten
Name | Typ | Beschreibung |
---|---|---|
id [KEY] | String | Die ID des Benutzers. |
deletedDateTime | Datetime | Das Löschdatum und die Uhrzeit des Benutzers. |
aboutMe | String | Das „AboutMe“ des Benutzers. |
accountEnabled | Bool | Gibt an, ob „accountEnabled“ für den Benutzer aktiviert ist. |
ageGroup | String | Die Altersgruppe des Benutzers. |
assignedLicenses | String | Die zugewiesenen Lizenzen des Benutzers. |
assignedPlans | String | Die zugewiesenen Pläne des Benutzers. |
birthday | Datetime | Der Geburtstag des Benutzers. |
businessPhones | String | Die Geschäftstelefone des Benutzers. |
city | String | Die Stadt des Benutzers. |
companyName | String | Der Firmenname des Benutzers. |
consentProvidedForMinor | String | Die Einwilligung des Benutzers für Minderjährige. |
country | String | Das Land des Benutzers. |
createdDateTime | Datetime | Das Erstellungsdatum und die Uhrzeit des Benutzers. |
creationType | String | Der Erstellungstyp des Benutzers. |
department | String | Die Abteilung des Benutzers. |
deviceEnrollmentLimit | Int | Das DeviceEnrollmentLimit des Benutzers. |
displayName | String | Der Anzeigename des Benutzers. |
employeeHireDate | Datetime | Das Einstellungsdatum des Benutzers. |
employeeId | String | Die Mitarbeiter-ID des Benutzers. |
employeeOrgData_costCenter | String | Das employeeOrgData_costCenter des Benutzers. |
employeeOrgData_division | String | Die employeeOrgData_division des Benutzers. |
employeeType | String | Der Mitarbeitertyp des Benutzers. |
externalUserState | String | Der externe Benutzerstatus des Benutzers. |
externalUserStateChangeDateTime | Datetime | Das externalUserStateChangeDateTime des Benutzers. |
faxNumber | String | Die Faxnummer des Benutzers. |
givenName | String | Der Vorname des Benutzers. |
hireDate | Datetime | Das Einstellungsdatum des Benutzers. |
identities | String | Die Identitäten des Benutzers. |
imAddresses | String | Die imAddresses des Benutzers. |
interests | String | Die Interessen des Benutzers. |
isResourceAccount | Bool | Gibt an, ob es sich um das Ressourcenkonto des Benutzers handelt. |
jobTitle | String | Die Berufsbezeichnung des Benutzers. |
lastPasswordChangeDateTime | Datetime | Das Datum und die Uhrzeit der letzten Kennwortänderung des Benutzers. |
legalAgeGroupClassification | String | Die legalAgeGroupClassification des Benutzers. |
licenseAssignmentStates | String | Die Lizenzzuweisungszustände des Benutzers. |
mail | String | Die E-Mail des Benutzers. |
mailboxSettings_archiveFolder | String | Der MailboxSettings_archiveFolder des Benutzers. |
mailboxSettings_automaticRepliesSetting_externalAudience | String | Das mailboxSettings_automaticRepliesSetting_externalAudience des Benutzers. |
mailboxSettings_automaticRepliesSetting_externalReplyMessage | String | Die mailboxSettings_automaticRepliesSetting_externalReplyMessage des Benutzers. |
mailboxSettings_automaticRepliesSetting_internalReplyMessage | String | Die mailboxSettings_automaticRepliesSetting_internalReplyMessage des Benutzers. |
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime | Datetime | Die mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime des Benutzers. |
mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone | String | Die mailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone des Benutzers. |
mailboxSettings_automaticRepliesSetting_status | String | Der mailboxSettings_automaticRepliesSetting_status des Benutzers. |
mailboxSettings_dateFormat | String | Das „mailboxSettings_dateFormat“ des Benutzers. |
mailboxSettings_delegateMeetingMessageDeliveryOptions | String | Die mailboxSettings_delegateMeetingMessageDeliveryOptions des Benutzers. |
mailboxSettings_language_displayName | String | Der MailboxSettings_language_displayName des Benutzers. |
mailboxSettings_language_locale | String | Das MailboxSettings_language_locale des Benutzers. |
mailboxSettings_timeFormat | String | Das mailboxSettings_timeFormat des Benutzers. |
mailboxSettings_timeZone | String | Die MailboxSettings_timeZone des Benutzers. |
mailboxSettings_workingHours_daysOfWeek | String | Die mailboxSettings_workingHours_daysOfWeek des Benutzers. |
mailboxSettings_workingHours_endTime | Time | Die mailboxSettings_workingHours_endTime des Benutzers. |
mailboxSettings_workingHours_startTime | Time | Die mailboxSettings_workingHours_startTime des Benutzers. |
mailboxSettings_workingHours_timeZone_name | String | Der MailboxSettings_workingHours_timeZone_name des Benutzers. |
mailNickname | String | Der MailNickname des Benutzers. |
mobilePhone | String | Das Mobiltelefon des Benutzers. |
mySite | String | Die MySite des Benutzers. |
officeLocation | String | Der Bürostandort des Benutzers. |
onPremisesDistinguishedName | String | Der onPremisesDistinguishedName des Benutzers. |
onPremisesDomainName | String | Der onPremisesDomainName des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute1 | String | Das onPremisesExtensionAttributes_extensionAttribute1 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute10 | String | Das onPremisesExtensionAttributes_extensionAttribute10 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute11 | String | Das onPremisesExtensionAttributes_extensionAttribute11 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute12 | String | Das onPremisesExtensionAttributes_extensionAttribute12 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute13 | String | Das onPremisesExtensionAttributes_extensionAttribute13 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute14 | String | Das onPremisesExtensionAttributes_extensionAttribute14 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute15 | String | Das onPremisesExtensionAttributes_extensionAttribute15 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute2 | String | Das onPremisesExtensionAttributes_extensionAttribute2 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute3 | String | Das onPremisesExtensionAttributes_extensionAttribute3 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute4 | String | Das onPremisesExtensionAttributes_extensionAttribute4 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute5 | String | Das onPremisesExtensionAttributes_extensionAttribute5 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute6 | String | Das onPremisesExtensionAttributes_extensionAttribute6 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute7 | String | Das onPremisesExtensionAttributes_extensionAttribute7 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute8 | String | Das onPremisesExtensionAttributes_extensionAttribute8 des Benutzers. |
onPremisesExtensionAttributes_extensionAttribute9 | String | Das onPremisesExtensionAttributes_extensionAttribute9 des Benutzers. |
onPremisesImmutableId | String | Die onPremisesImmutableId des Benutzers. |
onPremisesLastSyncDateTime | Datetime | Die onPremisesLastSyncDateTime des Benutzers. |
onPremisesProvisioningErrors | String | Die onPremisesProvisioningErrors des Benutzers. |
onPremisesSamAccountName | String | Der onPremisesSamAccountName des Benutzers. |
onPremisesSecurityIdentifier | String | Der onPremisesSecurityIdentifier des Benutzers. |
onPremisesSyncEnabled | Bool | Zeigt „onPremisesSyncEnabled“ für den Benutzer an. |
onPremisesUserPrincipalName | String | Der onPremisesUserPrincipalName des Benutzers. |
otherMails | String | Die anderen Mails des Benutzers. |
passwordPolicies | String | Die Kennwortrichtlinien des Benutzers. |
passwordProfile_forceChangePasswordNextSignIn | Bool | Geben Sie passwordProfile_forceChangePasswordNextSignIn für den Benutzer an. |
passwordProfile_forceChangePasswordNextSignInWithMfa | Bool | Geben Sie passwordProfile_forceChangePasswordNextSignInWithMfa für den Benutzer an. |
passwordProfile_password | String | Das PasswortProfile_password des Benutzers. |
pastProjects | String | Die vergangenen Projekte des Benutzers. |
postalCode | String | Die Postleitzahl des Benutzers. |
preferredLanguage | String | Die bevorzugte Sprache des Benutzers. |
preferredName | String | Der bevorzugte Name des Benutzers. |
provisionedPlans | String | Die bereitgestellten Pläne des Benutzers. |
proxyAddresses | String | Die Proxy-Adressen des Benutzers. |
responsibilities | String | Die Verantwortlichkeiten des Benutzers. |
schools | String | Die Schulen des Benutzers. |
showInAddressList | Bool | Geben Sie die showInAddressList des Benutzers an. |
signInSessionsValidFromDateTime | Datetime | Die signInSessionsValidFromDateTime des Benutzers. |
skills | String | Die Fähigkeiten des Benutzers. |
state | String | Der Status des Benutzers. |
streetAddress | String | Die Straßenadresse des Benutzers. |
surname | String | Der Nachname des Benutzers. |
usageLocation | String | Der Nutzungsstandort des Benutzers. |
userPrincipalName | String | Der userPrincipalName des Benutzers. |
userType | String | Der Benutzertyp des Benutzers. |
ParentReference | String | Die ParentReference des Benutzers. |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT-Operationen mit Microsoft OneNote hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Microsoft OneNote zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren für den Microsoft OneNote Connector
KopieNotebook
Kopiert ein Notizbuch in den Ordner „Notebooks“ in der Zieldokumentenbibliothek. Der Ordner wird erstellt, wenn er nicht existiert.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
NotebookId | String | True | Die ID des Notizbuchs, das Sie kopieren möchten. |
GroupId | String | Falsch | Die ID der Gruppe, in die kopiert werden soll. Nur beim Kopieren in eine Office 365-Gruppe verwenden. |
UserId | String | Falsch | Die ID des Benutzers, zu dem kopiert werden soll. Nur beim Kopieren zu einem Office 365-Benutzer verwenden. |
RenameAs | String | Falsch | Der Name der Kopie. Standardmäßig der Name des vorhandenen Elements. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Status | String | Status des Operation. |
Seite kopieren
Kopiere eine Seite in einen bestimmten Abschnitt.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
PageId | String | True | Die ID der Seite, die Sie kopieren möchten. |
SectionId | String | True | Die ID des Abschnitts, den Sie kopieren möchten. |
GroupId | String | Falsch | Die ID der Gruppe, in die kopiert werden soll. Nur beim Kopieren in eine Office 365-Gruppe verwenden. |
UserId | String | Falsch | Die ID des Benutzers, zu dem kopiert werden soll. Nur beim Kopieren zu einem Office 365-Benutzer verwenden. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Status | String | Status des Operation. |
Abschnitt kopieren
Kopiert einen Abschnitt in ein bestimmtes Notizbuch oder eine bestimmte Abschnittsgruppe.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
SectionId | String | True | Die ID des Abschnitts, den Sie kopieren möchten. |
GroupId | String | Falsch | Die ID der Gruppe, in die kopiert werden soll. Nur beim Kopieren in eine Office 365-Gruppe verwenden. |
UserId | String | Falsch | Die ID des Benutzers, zu dem kopiert werden soll. Nur beim Kopieren zu einem Office 365-Benutzer verwenden. |
NotebookId | String | Falsch | Die ID des Zielnotizbuchs. Entweder diese oder SectionGroupId sollte angegeben werden. |
SectionGroupId | String | Falsch | Die ID der Zielabschnittsgruppe. Entweder diese oder NotebookId muss angegeben werden. |
RenameAs | String | Falsch | Der Name der Kopie. Standardmäßig der Name des vorhandenen Elements. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Status | String | Status des Operation. |
Seite erstellen
Erstellt eine neue Seite für den angegebenen Abschnitt
Gespeicherte Prozeduren - Spezifische Informationen
Microsoft OneNote ermöglicht die Verwendung mehrerer Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. SectionId und einer der Parameter Content oder File sind erforderlich, um dieses Verfahren auszuführen.
Hinweis: Im Fall von OAuthGrantType=CLIENT muss entweder userId oder groupId angegeben werden. Beispiel:
EXECUTE CreatePage SectionId = '1-8a84fed0-5381-47f3-89bc-cd16f7a4f06d', File = 'C:\\Users\\Dell\\Desktop\\content.html'
Eingang
Name | Typ | Erforderlich | Akzeptiert Eingabeströme | Beschreibung |
---|---|---|---|---|
SectionId | String | True | False | Die ID der Seite. |
Content | String | Falsch | Falsch | Der HTML-Inhalt der Seite. |
File | String | Falsch | Falsch | Der Pfad der Datei, die den HTML-Inhalt der Seite enthält. |
GroupId | String | Falsch | Falsch | Die ID der Gruppe. |
UserId | String | Falsch | Falsch | Die ID des Benutzers |
ContentStream | String | Falsch | Wahr | Der Inhalt als InputStream, der hochgeladen werden soll, wenn Datei (Pfad) nicht angegeben ist |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Id | String | Die ID der erstellten Seite. |
Status | String | Status des Operation. |
Title | String | Titel der erstellten Seite. |
Dokument herunterladen
So laden Sie das Datei- oder Bildressourcenobjekt herunter
Eingang
Name | Typ | Erforderlich | Akzeptiert Ausgabestreams | Beschreibung |
---|---|---|---|---|
ResourceId | String | True | False | Die ID der herunterzuladenden Datei/des herunterzuladenden Bildes. |
GroupId | String | Falsch | Falsch | Die Gruppen-ID der Ressourcen-ID. |
UserId | String | Falsch | Falsch | Die Benutzer-ID der Ressourcen-ID. |
Name | String | Falsch | Falsch | Der Name der herunterzuladenden Datei/des herunterzuladenden Bildes (Sie können den korrekten Namen der Datei manuell festlegen oder einen anderen Namen wählen). Der Dateiname sollte auch das Dateiformat enthalten. Beispiel: Test.jpg |
LocalPath | String | Falsch | Falsch | Der lokale Pfad, in dem die Dateien/Bilder gespeichert werden sollen. |
Encoding | String | Falsch | Falsch | Der FileData-Eingabecodierungstyp. Die zulässigen Werte sind NONE, BASE64. Der Standardwert ist BASE64. |
FileStream | String | Falsch | Wahr | Eine Instanz eines Ausgabestreams, in den Dateidaten geschrieben werden. Wird nur verwendet, wenn LocalPath nicht angegeben ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
FullName | String | Der Name der heruntergeladenen Datei/des heruntergeladenen Bildes. |
FullPath | String | Der vollständige Pfad (einschließlich Name) der heruntergeladenen Datei. |
Status | String | Status des Dokument-Download-Operation. |
FileData | String | Wenn LocalPath und FileStream nicht angegeben sind, enthält dies den Inhalt der Datei. |
GetAdminConsentURL
Ruft die Administratoreinwilligungs URL ab, die von einem Administrator einer bestimmten Domäne separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Nur erforderlich, wenn benutzerdefinierte OAuth-Anmeldeinformationen verwendet werden.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Antwort-URL in den App-Einstellungen von Microsoft Entra ID übereinstimmen. |
State | String | Falsch | Derselbe Statuswert, den Sie gesendet haben, als Sie den Autorisierungscode angefordert haben. |
Scope | String | Falsch | Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Administrator angefordert werden sollen. Der Standardwert ist „https://graph.microsoft.com/group.read.all https://graph.microsoft.com/user.read.all https://graph.microsoft.com/notes.readwrite.all“ |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die Autorisierungs-URL, die in einen Webbrowser eingegeben wird, um das Prüftoken zu erhalten und Ihre App zu autorisieren. |
GetOAuthAccessToken
Ruft ein Authentifizierungstoken von OneNote ab.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AuthMode | String | Falsch | Der zu verwendende Authentifizierungsmodustyp. Wählen Sie „App“, um Authentifizierungstoken über eine Desktop-App abzurufen. Wählen Sie „Web“, um Authentifizierungstoken über eine Web-App abzurufen. Die zulässigen Werte sind APP, WEB. Der Standardwert ist APP. |
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Antwort URL übereinstimmen, die Sie in den Einstellungen der Microsoft Entra ID -App angegeben haben. |
Verifier | String | Falsch | Der von Microsoft Entra ID zurückgegebene Prüfer, nachdem der Benutzer Ihrer App den Zugriff auf seine Daten gestattet hat. Dieser Wert wird als Parameter an die Rückruf-URL zurückgegeben. |
Scope | String | Falsch | Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Benutzer angefordert werden sollen. Wenn OAuthGrantType='CODE', ist der Standardwert 'offline_access https://graph.microsoft.com/User.ReadWrite https://graph.microsoft.com/User.ReadBasic.All https://graph.microsoft.com/User.Read https://graph.microsoft.com/notes.readwrite.all https://graph.microsoft.com/Sites.Read.All https://graph.microsoft.com/Sites.ReadWrite.All'. Aber wenn OAuthGrantType='CLIENT', wird ein Bereich von 'https://graph.microsoft.com/.default' verwendet. '/.default' übernimmt alle Berechtigungen, die Ihre App bereits hat. |
State | String | Falsch | Eine beliebige Zeichenfolge Ihrer Wahl, die an Ihre App zurückgegeben wird. Ein erfolgreicher Roundtrip dieser Zeichenfolge trägt dazu bei sicherzustellen, dass Ihre App die Anforderung initiiert hat. |
Prompt | String | Falsch | Standardmäßig ist „select_account“ eingestellt, wodurch der Benutzer bei der Authentifizierung aufgefordert wird, ein Konto auszuwählen. Auf „None“ eingestellt, um keine Eingabeaufforderung zu erhalten, auf „login“, um den Benutzer zur Eingabe seiner Anmeldeinformationen zu zwingen, oder auf „consent“, um nach der Anmeldung des Benutzers den OAuth-Zustimmungsdialog auszulösen, in dem der Benutzer aufgefordert wird, der App Berechtigungen zu erteilen. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das für die Kommunikation mit OneNote verwendete Zugriffstoken. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. Eine -1 bedeutet, dass es nicht abläuft. |
OAuthRefreshToken | String | Aktualisierungstoken zum Erneuern des Zugriffstokens. |
GetOAuthAuthorizationURL
Ruft die Autorisierungs URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern das Authentifizierungstoken von dieser URL an.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Antwort-URL in den App-Einstellungen von Microsoft Entra ID übereinstimmen. |
State | String | Falsch | Derselbe Statuswert, den Sie gesendet haben, als Sie den Autorisierungscode angefordert haben. |
Scope | String | Falsch | Eine durch Leerzeichen getrennte Liste von Bereichen, die vom Benutzer angefordert werden sollen. Wenn OAuthGrantType='CODE', ist der Standardwert 'offline_access https://graph.microsoft.com/group.read.all https://graph.microsoft.com/user.read.all https://graph.microsoft.com/notes.readwrite.all'. Wenn OAuthGrantType='CLIENT' ist, wird jedoch ein Bereich von 'https://graph.microsoft.com/.default' verwendet. '/.default' übernimmt alle Berechtigungen, die Ihre App bereits hat. |
Prompt | String | Falsch | Standardmäßig ist „select_account“ eingestellt, wodurch der Benutzer bei der Authentifizierung aufgefordert wird, ein Konto auszuwählen. Auf „None“ eingestellt, um keine Eingabeaufforderung zu erhalten, auf „login“, um den Benutzer zur Eingabe seiner Anmeldeinformationen zu zwingen, oder auf „consent“, um nach der Anmeldung des Benutzers den OAuth-Zustimmungsdialog auszulösen, in dem der Benutzer aufgefordert wird, der App Berechtigungen zu erteilen. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die Autorisierungs-URL, die in einen Webbrowser eingegeben wird, um das Prüftoken zu erhalten und Ihre App zu autorisieren. |
GetPages
Der HTML-Inhalt der jeweiligen Seite
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
PageId | String | True | Die ID der Seite. |
GroupId | String | Falsch | Die ID der Gruppe. |
UserId | String | Falsch | Die ID des Benutzers |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Content | String | Der HTML-Inhalt der jeweiligen Seite. |
Aktualisieren Sie das OAuthAccessToken
Aktualisiert das OAuth-Zugriffstoken, das zur Authentifizierung bei verschiedenen OneNote-Diensten verwendet wird.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
OAuthRefreshToken | String | True | Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von Microsoft Entra ID zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. |
Systemtabellen
Sie können die in diesem Abschnitt beschriebenen Systemtabellen Abfrage, um auf Schema, Informationen zur Datenquellenfunktionalität und Statistiken zu Operation Charge.
Schematabellen
Die folgenden Tabellen geben Datenbankmetadaten für Microsoft OneNote zurück:
- sys_catalogs: Listet die verfügbaren Datenbanken auf.
- sys_schemas: Listet die verfügbaren Schemata auf.
- sys_tables: Listet die verfügbaren Tabellen und Ansichten auf.
- sys_tablecolumns: Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
- sys_procedures: Beschreibt die verfügbaren gespeicherten Prozeduren.
- sys_procedureparameters: Beschreibt Parameter gespeicherter Prozeduren.
- sys_keycolumns: Beschreibt die Primär- und Fremdschlüssel.
- sys_indexes: Beschreibt die verfügbaren Indizes.
Datenquellentabellen
Die folgenden Tabellen enthalten Informationen dazu, wie eine Verbindung zur Datenquelle hergestellt und diese Abfrage wird:
- sys_connection_props: Gibt Informationen zu den verfügbaren Verbindungseigenschaften zurück.
- sys_sqlinfo: Beschreibt die SELECT-Abfragen, die der Connector an die Datenquelle auslagern kann.
Abfrageinformationstabellen
Die folgende Tabelle gibt Abfrage für Datenänderungsabfragen zurück:
- Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.
Sys_catalogs
Listet die verfügbaren Datenbanken auf.
Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:
SELECT * FROM sys_catalogs
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
Sys_schemas
Listet die verfügbaren Schemas auf.
Die folgende Abfrage ruft alle verfügbaren Schemata ab:
SELECT * FROM sys_schemas
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
SchemaName | String | Der Schema. |
Sys_tables
Listet die verfügbaren Tabellen auf.
Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:
SELECT * FROM sys_tables
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht. |
TableType | String | Der Tabellentyp (Tabelle oder Ansicht). |
Description | String | Eine Beschreibung der Tabelle oder Ansicht. |
IsUpdateable | Boolean | Ob die Tabelle aktualisiert werden kann. |
Sys_tablecolumns
Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
Die folgende Abfrage gibt die Spalten und Datentypen für die Notebooks-Tabelle zurück:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Notebooks'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht, die die Spalte enthält. |
ColumnName | String | Der Spaltenname. |
DataTypeName | String | Der Name des Datentyps. |
DataType | Int32 | Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt. |
Length | Int32 | Die Speichergröße der Spalte. |
DisplaySize | Int32 | Die normale Maximalbreite der angegebenen Spalte in Zeichen. |
NumericPrecision | Int32 | Die maximale Anzahl von Ziffern in numerischen Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten. |
NumericScale | Int32 | Die Spaltenskala oder Anzahl der Ziffern rechts vom Dezimalpunkt. |
IsNullable | Boolean | Ob die Spalte Null enthalten kann. |
Description | String | Eine kurze Beschreibung der Spalte. |
Ordinal | Int32 | Die Sequenznummer der Spalte. |
IsAutoIncrement | String | Ob der Spaltenwert in festen Schritten zugewiesen wird. |
IsGeneratedColumn | String | Ob die Spalte generiert wird. |
IsHidden | Boolean | Ob die Spalte ausgeblendet ist. |
IsArray | Boolean | Ob die Spalte ein Array ist. |
IsReadOnly | Boolean | Ob die Spalte schreibgeschützt ist. |
IsKey | Boolean | Gibt an, ob ein von sys_tablecolumns zurückgegebenes Feld der Primärschlüssel der Tabelle ist. |
Sys_procedures
Listet die verfügbaren gespeicherten Prozeduren auf.
Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:
SELECT * FROM sys_procedures
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die gespeicherte Prozedur enthält. |
SchemaName | String | Das Schema, das die gespeicherte Prozedur enthält. |
ProcedureName | String | Der Name der gespeicherten Prozedur. |
Description | String | Eine Beschreibung der gespeicherten Prozedur. |
ProcedureType | String | Der Typ der Prozedur, z. B. PROZEDUR oder FUNKTION. |
Sys_procedureparameters
Beschreibt Parameter gespeicherter Prozeduren.
Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur CopyNotebook zurück:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='CopyNotebook' AND Direction=1 OR Direction=2
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die die gespeicherte Prozedur enthält. |
SchemaName | String | Der Name des Schema, das die gespeicherte Prozedur enthält. |
ProcedureName | String | Der Name der gespeicherten Prozedur, die den Parameter enthält. |
ColumnName | String | Der Name des gespeicherten Prozedurparameters. |
Direction | Int32 | Eine Ganzzahl, die dem Typ des Parameters entspricht: Eingabe (1), Eingabe/Ausgabe (2) oder Ausgabe (4). Parameter vom Typ Eingabe/Ausgabe können sowohl Eingabe- als auch Ausgabeparameter sein. |
DataTypeName | String | Der Name des Datentyps. |
DataType | Int32 | Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt. |
Length | Int32 | Die Anzahl der für Zeichendaten zulässigen Zeichen. Die Anzahl der für numerische Daten zulässigen Ziffern. |
NumericPrecision | Int32 | Die maximale Genauigkeit für numerische Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten. |
NumericScale | Int32 | Die Anzahl der Ziffern rechts vom Dezimalkomma in numerischen Daten. |
IsNullable | Boolean | Ob der Parameter Null enthalten kann. |
IsRequired | Boolean | Ob der Parameter zur Ausführung der Prozedur erforderlich ist. |
IsArray | Boolean | Ob der Parameter ein Array ist. |
Description | String | Die Beschreibung des Parameters. |
Ordinal | Int32 | Der Index des Parameters. |
Sys_keycolumns
Beschreibt die Primär- und Fremdschlüssel.
Die folgende Abfrage ruft den Primärschlüssel für die Notebooks-Tabelle ab:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Notebooks'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
IsKey | Boolean | Ob die Spalte ein Primärschlüssel in der Tabelle ist, auf die im Feld „TableName“ verwiesen wird. |
IsForeignKey | Boolean | Ob die Spalte ein Fremdschlüssel ist, auf den im Feld TableName verwiesen wird. |
PrimaryKeyName | String | Der Name des Primärschlüssels. |
ForeignKeyName | String | Der Name des Fremdschlüssels. |
ReferencedCatalogName | String | Die Datenbank, die den Primärschlüssel enthält. |
ReferencedSchemaName | String | Das Schema, das den Primärschlüssel enthält. |
ReferencedTableName | String | Die Tabelle, die den Primärschlüssel enthält. |
ReferencedColumnName | String | Der Spaltenname des Primärschlüssels. |
Sys_foreignkeys
Beschreibt die Fremdschlüssel.
Die folgende Abfrage ruft alle Fremdschlüssel ab, die auf andere Tabellen verweisen:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
PrimaryKeyName | String | Der Name des Primärschlüssels. |
ForeignKeyName | String | Der Name des Fremdschlüssels. |
ReferencedCatalogName | String | Die Datenbank, die den Primärschlüssel enthält. |
ReferencedSchemaName | String | Das Schema, das den Primärschlüssel enthält. |
ReferencedTableName | String | Die Tabelle, die den Primärschlüssel enthält. |
ReferencedColumnName | String | Der Spaltenname des Primärschlüssels. |
ForeignKeyType | String | Gibt an, ob der Fremdschlüssel ein Importschlüssel (zeigt auf andere Tabellen) oder ein Exportschlüssel (referenziert von anderen Tabellen) ist. |
Sys_primarykeys
Beschreibt die Primärschlüssel.
Die folgende Abfrage ruft die Primärschlüssel aus allen Tabellen und Ansichten ab:
SELECT * FROM sys_primarykeys
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
KeySeq | String | Die Sequenznummer des Primärschlüssels. |
KeyName | String | Der Name des Primärschlüssels. |
Sys_indexes
Beschreibt die verfügbaren Indizes. Durch das Filtern nach Indizes können Sie selektivere Abfragen mit schnelleren Abfrage schreiben.
Die folgende Abfrage ruft alle Indizes ab, die keine Primärschlüssel sind:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Index enthält. |
SchemaName | String | Der Name des Schema, das den Index enthält. |
TableName | String | Der Name der Tabelle, die den Index enthält. |
IndexName | String | Der Indexname. |
ColumnName | String | Der Name der mit dem Index verknüpften Spalte. |
IsUnique | Boolean | Wahr, wenn der Index eindeutig ist. Andernfalls falsch. |
IsPrimary | Boolean | Wahr, wenn der Index ein Primärschlüssel ist. Andernfalls falsch. |
Type | Int16 | Ein ganzzahliger Wert, der dem Indextyp entspricht: Statistik (0), gruppiert (1), gehasht (2) oder Sonstiges (3). |
SortOrder | String | Die Sortierreihenfolge: A für aufsteigend oder D für absteigend. |
OrdinalPosition | Int16 | Die Sequenznummer der Spalte im Index. |
Sys_connection_props
Gibt Informationen zu den verfügbaren Verbindungseigenschaften und den in der Verbindungszeichenfolge festgelegten Eigenschaften zurück.
Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:
jdbc:cdata:onenote:config:
Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.
Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:
SELECT * FROM sys_connection_props WHERE Value <> ''
Spalten
Name | Typ | Beschreibung |
---|---|---|
Name | String | Der Name der Verbindungseigenschaft. |
ShortDescription | String | Eine kurze Beschreibung. |
Type | String | Der Datentyp der Verbindungseigenschaft. |
Default | String | Der Standardwert, sofern nicht explizit einer festgelegt wurde. |
Values | String | Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben. |
Value | String | Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard. |
Required | Boolean | Ob für die Immobilie eine Verbindung erforderlich ist. |
Category | String | Die Kategorie der Verbindungseigenschaft. |
IsSessionProperty | String | Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird. |
Sensitivity | String | Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird. |
PropertyName | String | Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise. |
Ordinal | Int32 | Der Index des Parameters. |
CatOrdinal | Int32 | Der Index der Parameterkategorie. |
Hierarchy | String | Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen. |
Visible | Boolean | Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist. |
ETC | String | Diverse sonstige Informationen zum Objekt. |
Sys_sqlinfo
Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.
Entdecken der SELECT-Funktionen der Datenquelle
Nachfolgend sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.
Name | Beschreibung | Mögliche Werte |
---|---|---|
AGGREGATE_FUNCTIONS | Unterstützte Aggregatfunktionen. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Ob die COUNT-Funktion unterstützt wird. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | ] |
SUPPORTED_OPERATORS | Eine Liste unterstützter SQL-Operatoren. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Unterstützte String-Funktionen. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Unterstützte numerische Funktionen. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Unterstützte Datums-/Uhrzeitfunktionen. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Zeigt an, dass während der Replikation Tabellen übersprungen wurden. | |
REPLICATION_TIMECHECK_COLUMNS | Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen. | |
IDENTIFIER_PATTERN | Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist. | |
SUPPORT_TRANSACTION | Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. | YES , NO |
DIALECT | Gibt den zu verwendenden SQL-Dialekt an. | |
KEY_PROPERTIES | Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren. | |
SUPPORTS_MULTIPLE_SCHEMAS | Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. | YES , NO |
DATASYNCVERSION | Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | Die Kategorie „Datensynchronisierung“ dieses Treiber. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Ob Charge Operationen unterstützt werden. | YES , NO |
SQL_CAP | Alle unterstützten SQL-Funktionen für diesen Treiber. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an. | |
ENABLE_EF_ADVANCED_QUERY | Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. | YES , NO |
PSEUDO_COLUMNS | Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt. | |
MERGE_ALWAYS | Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation. | |
REPLICATION_MIN_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll. | |
REPLICATION_START_DATE | Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben. | |
REPLICATION_MAX_DATE_QUERY | Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation. | |
REPLICATION_MAX_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird. | |
CHECKCACHE_USE_PARENTID | Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Gibt gespeicherte Prozeduren an, die zum Generieren von Schema verwendet werden können. |
Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; siehe Datenmodell Abschnitt für weitere Informationen.
Spalten
Name | Typ | Beschreibung |
---|---|---|
NAME | String | Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann. |
VALUE | String | Details zum unterstützten SQL bzw. zur SQL-Syntax. |
Systemidentität
Gibt Informationen zu versuchten Änderungen zurück.
Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:
SELECT * FROM sys_identity
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id | String | Die von einer Operation zurückgegebene, von der Datenbank generierte ID. |
Batch | String | Eine Kennung für den Charge. 1 für einen einzelnen Operation. |
Operation | String | Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT. |
Message | String | SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist. |
Datentypzuordnung
Datentypzuordnungen
Der Connector ordnet Typen aus der Datenquelle dem entsprechenden im Schema verfügbaren Datentyp zu. Die folgende Tabelle dokumentiert diese Zuordnungen.
Microsoft OneNote (OData V4) | Schema |
---|---|
Edm.Binary | binär |
Edm.Boolean | |
Edm.Date | Datum/Uhrzeit |
Edm.DateTimeOffset | Datum/Uhrzeit |
Edm.Decimal | Dezimal |
Edm.Double | doppelt |
Edm.Guid | Anleitung |
Edm.Int32 | int |
Edm.String | Zeichenfolge |
Edm.TimeOfDay | Zeit |
Erweiterte Konfigurationseigenschaften
Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der für die Verbindung mit Microsoft OneNote zu verwendende Authentifizierungstyp. |
Eigenschaft | Beschreibung |
---|---|
IncludeSharePointSites | Ob Laufwerke für alle SharePoint-Sites abgerufen werden sollen, wenn die Laufwerksansicht abgefragt wird. Wenn „true“, ruft der Anbieter alle Site-IDs rekursiv ab und gibt für jede Site einen separaten Aufruf aus, um ihre Laufwerke abzurufen. Beachten Sie daher, dass das Festlegen dieser Eigenschaft auf „true“ die Leistung für die Laufwerksansicht verringern kann. Beachten Sie, dass die Verbindungseigenschaft SharePointAccessToken oder OAuthJWTCert angegeben werden muss, um die SharePointSites-Ansicht und andere Ansichten Abfrage, wenn IncludeSharePointSites bei Verwendung des CLIENT OAuthGrantType oder des AzureServicePrincipal AuthScheme auf „true“ festgelegt ist. |
Eigenschaft | Beschreibung |
---|---|
AzureTenant | Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Wenn nicht angegeben, wird Ihr Standardmandant verwendet. |
AzureEnvironment | Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung. |
Eigenschaft | Beschreibung |
---|---|
InitiateOAuth | Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten. |
OAuthClientId | Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthClientSecret | Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthAccessToken | Der Zugriffstoken für die Verbindung mittels OAuth. |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben. |
OAuthGrantType | Der Berechtigungstyp für den OAuth-Flow. |
OAuthVerifier | Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. |
OAuthRefreshToken | Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken. |
OAuthExpiresIn | Die Lebensdauer des OAuth AccessToken in Sekunden. |
OAuthTokenTimestamp | Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde. |
Eigenschaft | Beschreibung |
---|---|
OAuthJWTCert | Der JWT-Zertifikatspeicher. |
OAuthJWTCertType | Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält. |
OAuthJWTCertPassword | Das Passwort für das OAuth JWT-Zertifikat. |
OAuthJWTCertSubject | Der Betreff des OAuth-JWT-Zertifikats. |
Eigenschaft | Beschreibung |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
Eigenschaft | Beschreibung |
---|---|
Location | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
BrowsableSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC. |
Views | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC. |
Eigenschaft | Beschreibung |
---|---|
GroupId | Geben Sie diese GroupId an, um auf die OneNote-Dokumente für diese Gruppe zuzugreifen. |
MaxRows | Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
UserId | Geben Sie diese Benutzer-ID an, um auf die OneNote-Dokumente für diesen Benutzer zuzugreifen. |
Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der für die Verbindung mit Microsoft OneNote zu verwendende Authentifizierungstyp. |
AuthScheme
Der bei der Verbindung mit Microsoft OneNote zu verwendende Authentifizierungstyp.
Mögliche Werte
AzureAD
, AzureMSI
, AzureServicePrincipal
, AzureServicePrincipalCert
Datentyp
string
Standardwert
AzureAD
Hinweise
- Microsoft Entra ID: Legen Sie dies fest, um die Microsoft Entra ID OAuth-Authentifizierung durchzuführen.
- AzureMSI: Legen Sie dies fest, um beim Ausführen auf einer Azure-VM automatisch Anmeldeinformationen für die verwaltete Dienstidentität abzurufen.
- AzureServicePrincipal: Legen Sie dies fest, um die Authentifizierung als Microsoft Entra-Dienstprinzipal unter Verwendung eines Clientgeheimnisses durchzuführen.
- AzureServicePrincipalCert: Legen Sie dies fest, um sich mithilfe eines Zertifikats als Microsoft Entra-Dienstprinzipal zu authentifizieren.
Verbindung
Dieser Abschnitt enthält eine vollständige Liste der Verbindungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
IncludeSharePointSites | Ob Laufwerke für alle SharePoint-Sites abgerufen werden sollen, wenn die Laufwerksansicht abgefragt wird. Wenn „true“, ruft der Anbieter alle Site-IDs rekursiv ab und gibt für jede Site einen separaten Aufruf aus, um ihre Laufwerke abzurufen. Beachten Sie daher, dass das Festlegen dieser Eigenschaft auf „true“ die Leistung für die Laufwerksansicht verringern kann. Beachten Sie, dass die Verbindungseigenschaft SharePointAccessToken oder OAuthJWTCert angegeben werden muss, um die SharePointSites-Ansicht und andere Ansichten Abfrage, wenn IncludeSharePointSites bei Verwendung des CLIENT OAuthGrantType oder des AzureServicePrincipal AuthScheme auf „true“ festgelegt ist. |
SharePoint-Sites einschließen
Ob Laufwerke für alle SharePoint-Sites abgerufen werden sollen, wenn die Laufwerksansicht abgefragt wird. Wenn „true“, ruft der Anbieter alle Site-IDs rekursiv ab und gibt für jede Site einen separaten Aufruf aus, um ihre Laufwerke abzurufen. Beachten Sie daher, dass das Festlegen dieser Eigenschaft auf „true“ die Leistung für die Laufwerksansicht verringern kann. Beachten Sie, dass die Verbindungseigenschaft SharePointAccessToken oder OAuthJWTCert angegeben werden muss, um die SharePointSites-Ansicht und andere Ansichten Abfrage, wenn IncludeSharePointSites bei Verwendung des CLIENT OAuthGrantType oder des AzureServicePrincipal AuthScheme auf „true“ festgelegt ist.
Datentyp
bool
Standardwert
false
Hinweise
Diese Eigenschaft betrifft nur Laufwerksansichten.
Azure Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Azure-Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AzureTenant | Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Wenn nicht angegeben, wird Ihr Standardmandant verwendet. |
AzureEnvironment | Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung. |
AzureTenant
Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Wenn nicht angegeben, wird Ihr Standardmandant verwendet.
Datentyp
string
Standardwert
""
Hinweise
Der Microsoft Online-Mandant, der für den Datenzugriff verwendet wird. Beispiel: contoso.onmicrosoft.com. Alternativ können Sie die Mandanten-ID angeben. Dieser Wert ist die Verzeichnis-ID im Azure-Portal > Microsoft Entra ID > Eigenschaften.
Normalerweise ist es nicht notwendig, den Mandanten anzugeben. Dies kann von Microsoft automatisch ermittelt werden, wenn der OAuthGrantType verwendet wird auf CODE (Standard) eingestellt. Es kann jedoch fehlschlagen, wenn der Benutzer mehreren Mandanten angehört. Zum Beispiel, wenn ein Administrator von Domäne A einen Benutzer von Domäne B als Gastbenutzer einlädt. Der Benutzer gehört nun beiden Mandanten an. Es ist eine gute Praxis, den Mandanten anzugeben, obwohl es im Allgemeinen funktionieren sollte, ohne ihn angeben zu müssen.
AzureTenant
ist beim Festlegen von OAuthGrantType erforderlich zu CLIENT. Bei der Verwendung von Client-Anmeldeinformationen gibt es keinen Benutzerkontext. Die Anmeldeinformationen werden aus dem Kontext der App selbst übernommen. Microsoft erlaubt zwar weiterhin den Abruf von Client-Anmeldeinformationen ohne Angabe des Mandanten, aber die Wahrscheinlichkeit, den spezifischen Mandanten auszuwählen, mit dem Sie arbeiten möchten, ist viel geringer. Aus diesem Grund benötigen wir AzureTenant
muss bei allen Client-Anmeldeinformationen-Verbindungen explizit angegeben werden, um sicherzustellen, dass Sie Anmeldeinformationen erhalten, die für die Domäne gelten, mit der Sie eine Verbindung herstellen möchten.
Azure-Umgebung
Die beim Herstellen einer Verbindung zu verwendende Azure-Umgebung.
Mögliche Werte
GLOBAL
, CHINA
, USGOVT
, USGOVTDOD
Datentyp
string
Standardwert
GLOBAL
Hinweise
In den meisten Fällen funktioniert es, die Umfeld auf global eingestellt zu lassen. Wenn Ihr Azure-Konto jedoch einer anderen Umfeld hinzugefügt wurde, wird die AzureEnvironment
kann verwendet werden, um die Umfeld anzugeben. Die verfügbaren Werte sind GLOBAL, CHINA, USGOVT, USGOVTDOD.
OAuth
Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
InitiateOAuth | Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten. |
OAuthClientId | Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthClientSecret | Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthAccessToken | Der Zugriffstoken für die Verbindung mittels OAuth. |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben. |
OAuthGrantType | Der Berechtigungstyp für den OAuth-Flow. |
OAuthVerifier | Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. |
OAuthRefreshToken | Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken. |
OAuthExpiresIn | Die Lebensdauer des OAuth AccessToken in Sekunden. |
OAuthTokenTimestamp | Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde. |
OAuth initiieren
Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
Mögliche Werte
OFF
, GETANDREFRESH
, REFRESH
Datentyp
string
Standardwert
OFF
Hinweise
Folgende Optionen stehen zur Verfügung:
OFF
: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.GETANDREFRESH
: Gibt an, dass der gesamte OAuth-Flow vom Connector verarbeitet wird. Wenn derzeit kein Token vorhanden ist, wird es durch eine entsprechende Aufforderung an den Benutzer über den Browser abgerufen. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.REFRESH
: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessToken übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessToken und des OAuthRefreshToken übernehmen.
OAuthClientId
Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Datentyp
string
Standardwert
""
Hinweise
Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId
-Wert, manchmal auch Consumer-Schlüssel genannt, und ein Client-Geheimnis, das OAuthClientSecret.
OAuthClientSecret
Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Datentyp
string
Standardwert
""
Hinweise
Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId, auch Consumer-Schlüssel genannt. Sie erhalten außerdem ein Client-Geheimnis, auch Consumer-Geheimnis genannt. Legen Sie das Client-Geheimnis im OAuthClientSecret
Eigentum.
OAuth-Zugriffstoken
Der Zugriffstoken für die Verbindung per OAuth.
Datentyp
string
Standardwert
""
Hinweise
Der OAuthAccessToken
Eigenschaft wird für die Verbindung über OAuth verwendet. Die OAuthAccessToken
wird im Rahmen des Authentifizierungsprozesses vom OAuth-Server abgerufen. Es hat ein serverabhängiges Timeout und kann zwischen Anfragen wiederverwendet werden.
Das Zugriffstoken wird anstelle Ihres Benutzernamens und Passworts verwendet. Das Zugriffstoken schützt Ihre Anmeldeinformationen, indem es sie auf dem Server speichert.
OAuthSettingsLocation
Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'
.
Datentyp
string
Standardwert
%APPDATA%\OneNote Data Provider\OAuthSettings.txt
Hinweise
Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH
oder REFRESH
, der Connector speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.
Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit beginnt 'memory://'
gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_props
Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.
Der Standardspeicherort ist „%APPDATA%\OneNote Data Provider\OAuthSettings.txt“ mit %APPDATA%
auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.
Die folgende Tabelle listet den Wert von auf %APPDATA%
nach Operationssystem:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
Rückruf-URL
Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
Datentyp
string
Standardwert
""
Hinweise
Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
OAuthGrantType
Der Berechtigungstyp für den OAuth-Flow.
Mögliche Werte
CODE
, CLIENT
Datentyp
string
Standardwert
CLIENT
Hinweise
Folgende Optionen stehen zur Verfügung: CODE,CLIENT
OAuthVerifier
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
Datentyp
string
Standardwert
""
Hinweise
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.
Authentifizierung auf Headless-Maschinen
Siehe, um die zu erhalten OAuthVerifier
Wert.
OAuthSettingsLocation festlegen zusammen mit OAuthVerifier
. Beim Verbinden tauscht der Connector die OAuthVerifier
für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.
Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier
aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.
Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.
OAuthRefreshToken
Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
Datentyp
string
Standardwert
""
Hinweise
Der OAuthRefreshToken
Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.
OAuthLäuftAbIn
Die Lebensdauer des OAuth AccessToken in Sekunden.
Datentyp
string
Standardwert
""
Hinweise
Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann der AccessToken abläuft.
OAuthTokenTimestamp
Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.
Datentyp
string
Standardwert
""
Hinweise
Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.
JWT OAuth
Dieser Abschnitt enthält eine vollständige Liste der JWT OAuth-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
OAuthJWTCert | Der JWT-Zertifikatspeicher. |
OAuthJWTCertType | Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält. |
OAuthJWTCertPassword | Das Passwort für das OAuth JWT-Zertifikat. |
OAuthJWTCertSubject | Der Betreff des OAuth-JWT-Zertifikats. |
OAuthJWTCert
Der JWT-Zertifikatspeicher.
Datentyp
string
Standardwert
""
Hinweise
Der Name des Zertifikatspeichers für das Client-Zertifikat.
Der OAuthJWTCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an OAuthJWTCert
. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in OAuthJWTCertPassword an.
OAuthJWTCert
wird in Verbindung mit OAuthJWTCertSubject verwendet
Feld, um Client-Zertifikate anzugeben. Wenn OAuthJWTCert
hat einen Wert und OAuthJWTCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Bitte beachten Sie das OAuthJWTCertSubject für weitere Einzelheiten.
Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.
Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:
Eigenschaft | Beschreibung |
---|---|
MY | Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält. |
CA | Zertifikate der Zertifizierungsstelle. |
ROOT | Stammzertifikate. |
SPC | Zertifikate von Softwareherstellern. |
In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.
Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei (d. h. PKCS12-Zertifikatsspeicher) gesetzt werden.
OAuthJWTCertType
Der Typ des Schlüsselspeichers, der das JWT-Zertifikat enthält.
Datentyp
string
Standardwert
USER
Hinweise
Diese Eigenschaft kann einen der folgenden Werte annehmen:
Eigenschaft | Beschreibung |
---|---|
USER | Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar. |
MACHINE | Für Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Hinweis: Dieser Speichertyp ist in Java nicht verfügbar. |
PFXFILE | Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält. |
PFXBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt. |
JKSFILE | Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Hinweis: Dieser Speichertyp ist nur in Java verfügbar. |
JKSBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im Java Key Store-Format (JKS) darstellt. Hinweis: Dieser Speichertyp ist nur in Java verfügbar. |
PEMKEY_FILE | Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PEMKEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
PUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
SSHPUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält. |
SSHPUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält. |
P7BFILE | Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält. |
PPKFILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen PPK (PuTTY Private Key) enthält. |
XMLFILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält. |
XMLBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält. |
OAuthJWTCertPasswort
Das Passwort für das OAuth JWT-Zertifikat.
Datentyp
string
Standardwert
""
Hinweise
Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort anzugeben, damit der Zertifikatspeicher geöffnet werden kann.
OAuthJWTCertSubject
Der Betreff des OAuth JWT-Zertifikats.
Datentyp
string
Standardwert
*
Hinweise
Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu lokalisieren.
Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten.
Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und kein Zertifikat ausgewählt.
Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.
Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Zum Beispiel „CN=www.server.com, OU=test, C=US, E=example@jbexample.com“. Allgemeine Felder und ihre Bedeutungen werden unten angezeigt.
Feld | Bedeutung |
---|---|
CN | Allgemeiner Name. Dies ist normalerweise ein Host wie www.server.com. |
O | Organisation |
OU | Organisationseinheit |
L | Ort |
S | Staat |
C | Land |
E | Email Adresse |
Wenn ein Feldwert ein Komma enthält, muss es in Anführungszeichen gesetzt werden.
SSL
Dieser Abschnitt enthält eine vollständige Liste der SSL-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
SSLServerCert
Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.
Datentyp
string
Standardwert
""
Hinweise
Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.
Diese Eigenschaft kann folgende Formen annehmen:
Beschreibung | Beispiel |
---|---|
Ein vollständiges PEM-Zertifikat (Beispiel der Kürze halber gekürzt) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
Ein Pfad zu einer lokalen Datei, die das Zertifikat enthält | C:\\cert.cer |
Der öffentliche Schlüssel (Beispiel der Kürze halber gekürzt) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
Der MD5-Fingerabdruck (Hexadezimalwerte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) | ecadbdda5a1529c58a1e9e09828d70e4 |
Der SHA1-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Wenn nicht angegeben, wird jedes vom Computer vertrauenswürdige Zertifikat akzeptiert.
Zertifikate werden vom Computer basierend auf dem Trust Store des Systems als vertrauenswürdig validiert. Der verwendete Trust Store ist der für das System angegebene Wert „javax.net.ssl.trustStore“. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Standard-Trust Store von Java verwendet (z. B. JAVA_HOME\lib\security\cacerts).
Verwenden Sie „*“, um anzugeben, dass alle Zertifikate akzeptiert werden. Beachten Sie, dass dies aus Sicherheitsgründen nicht empfohlen wird.
Schema
Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Location | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
BrowsableSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC. |
Views | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC. |
Standort
Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
Datentyp
string
Standardwert
%APPDATA%\OneNote Data Provider\Schema
Hinweise
Der Pfad zu einem Verzeichnis, das die Schema für den Connector enthält (.rsd-Dateien für Tabellen und Ansichten, .rsb-Dateien für gespeicherte Prozeduren). Der Ordnerspeicherort kann ein relativer Pfad vom Speicherort der ausführbaren Datei sein. Der Location
-Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen möchten (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.
Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\OneNote Data Provider\Schema“ mit %APPDATA%
wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
DurchsuchbareSchemas
Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Datentyp
string
Standardwert
""
Hinweise
Das Auflisten der Schemata aus Datenbanken kann aufwändig sein. Die Bereitstellung einer Liste von Schemata in der Verbindungszeichenfolge verbessert die Leistung.
Tabellen
Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC.
Datentyp
string
Standardwert
""
Hinweise
Das Auflisten der Tabellen aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Tabellen in der Verbindungszeichenfolge verbessert die Leistung des Connectors.
Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.
Geben Sie die gewünschten Tabellen in einer durch Kommas getrennten Liste an. Jede Tabelle sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.
Ansichten
Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC.
Datentyp
string
Standardwert
""
Hinweise
Das Auflisten der Ansichten aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Ansichten in der Verbindungszeichenfolge verbessert die Leistung des Connectors.
Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.
Geben Sie die gewünschten Ansichten in einer durch Kommas getrennten Liste an. Jede Ansicht sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.
Verschiedenes
Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
GroupId | Geben Sie diese GroupId an, um auf die OneNote-Dokumente für diese Gruppe zuzugreifen. |
MaxRows | Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
UserId | Geben Sie diese Benutzer-ID an, um auf die OneNote-Dokumente für diesen Benutzer zuzugreifen. |
Gruppen-ID
Geben Sie diese Gruppen-ID an, um auf die OneNote-Dokumente für diese Gruppe zuzugreifen.
Datentyp
string
Standardwert
""
Hinweise
Geben Sie diese Gruppen-ID an, um auf die OneNote-Dokumente für diese Gruppe zuzugreifen.
MaxRows
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Datentyp
int
Standardwert
-1
Hinweise
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Andere
Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
Datentyp
string
Standardwert
""
Hinweise
Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.
Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.
Integration und Formatierung
Eigenschaft | Beschreibung |
---|---|
DefaultColumnSize | Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000. |
ConvertDateTimeToGMT | Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen. |
RecordToFile=filename | Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei. |
Pseudospalten
Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
Datentyp
string
Standardwert
""
Hinweise
Diese Einstellung ist besonders hilfreich im Entity Framework, da Sie dort keinen Wert für eine Pseudospalte festlegen können, es sei denn, es handelt sich um eine Tabellenspalte. Der Wert dieser Verbindungseinstellung hat das Format „Tabelle1=Spalte1, Tabelle1=Spalte2, Tabelle2=Spalte3“. Sie können das Zeichen „*“ verwenden, um alle Tabellen und alle Spalten einzuschließen, z. B. „*=*“.
Zeitüberschreitung
Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
Datentyp
int
Standardwert
60
Hinweise
Wenn Timeout
= 0, Operationen werden nicht abgebrochen. Die Operationen werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.
Wenn Timeout
abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.
BenutzerdefinierteAnsichten
Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.
Datentyp
string
Standardwert
""
Hinweise
Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json
. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.
Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews
Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.
Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:
- Jedes Stammelement definiert den Namen einer Ansicht.
- Jedes Stammelement enthält ein untergeordnetes Element namens
query
, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.
Zum Beispiel:
{
"MyView": {
"query": "SELECT * FROM Notebooks WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie die UserDefinedViews
Verbindungseigenschaft zur Angabe des Speicherorts Ihrer JSON-Konfigurationsdatei. Beispiel:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.
Benutzer-ID
Geben Sie diese Benutzer-ID an, um auf die OneNote-Dokumente für diesen Benutzer zuzugreifen.
Datentyp
string
Standardwert
""
Hinweise
Geben Sie diese Benutzer-ID an, um auf die OneNote-Dokumente für diesen Benutzer zuzugreifen.