Erstellen von Python-Apps mit Microsoft Graph

Artikel
Developer (Anfänger)
29 Minuten bis zum Abschluss

In diesem Tutorial erfahren Sie, wie Sie eine Python-Konsolen-App erstellen, die die Microsoft Graph-API verwendet, um im Auftrag eines Benutzers auf Daten zuzugreifen.

Hinweis

Informationen zur Verwendung von Microsoft Graph für den Zugriff auf Daten mithilfe der reinen App-Authentifizierung finden Sie in diesem Tutorial zur reinen App-Authentifizierung.

In diesem Lernprogramm wird Folgendes vermittelt:

Tipp

Alternativ zu diesem Tutorial können Sie den vollständigen Code über das Schnellstarttool herunterladen, das die App-Registrierung und -Konfiguration automatisiert. Der heruntergeladene Code funktioniert ohne Änderungen.

Sie können auch das GitHub-Repository herunterladen oder klonen und die Anweisungen in der INFODATEI befolgen, um eine Anwendung zu registrieren und das Projekt zu konfigurieren.

Voraussetzungen

Bevor Sie mit diesem Tutorial beginnen, sollten Python und pip auf Ihrem Entwicklungscomputer installiert sein.

Sie sollten auch über ein Microsoft-Geschäfts-, Schul- oder Unikonto mit einem Exchange Online-Postfach verfügen. Wenn Sie nicht über einen Microsoft 365-Mandanten verfügen, können Sie sich über das Microsoft 365-Entwicklerprogramm für einen mandantenfähigen Mandanten qualifizieren. Weitere Informationen finden Sie in den häufig gestellten Fragen. Alternativ können Sie sich für eine kostenlose 1-monatige Testversion registrieren oder einen Microsoft 365-Plan erwerben.

Hinweis

Dieses Tutorial wurde mit Python-Version 3.10.4 und pip-Version 20.0.2 geschrieben. Die Schritte in diesem Leitfaden funktionieren möglicherweise mit anderen Versionen, die jedoch nicht getestet wurden.

Registrieren der App im Portal

28 Minuten verbleibend

In dieser Übung registrieren Sie eine neue Anwendung in Azure Active Directory, um die Benutzerauthentifizierung zu aktivieren. Sie können eine Anwendung über das Microsoft Entra Admin Center oder mithilfe des Microsoft Graph PowerShell SDK registrieren.

Registrieren der Anwendung für die Benutzerauthentifizierung

In diesem Abschnitt registrieren Sie eine Anwendung, die die Benutzerauthentifizierung mithilfe des Gerätecodeflows unterstützt.

Microsoft Entra Admin Center
PowerShell

Öffnen Sie einen Browser, navigieren Sie zum Microsoft Entra Admin Center , und melden Sie sich mit einem globalen Administratorkonto an.
Wählen Sie im linken Navigationsbereich Microsoft Entra ID aus, erweitern Sie Identität, erweitern Sie Anwendungen, und wählen Sie dann App-Registrierungen aus.
Wählen Sie Neue Registrierung aus. Geben Sie einen Namen für Ihre Anwendung ein, Graph User Auth Tutorialz. B. .

Legen Sie unterstützte Kontotypen wie gewünscht fest. Mögliche Optionen:

Option	Wer kann sich anmelden?
Nur Konten in diesem Organisationsverzeichnis	Nur Benutzer in Ihrer Microsoft 365-Organisation
Konten in einem beliebigen Organisationsverzeichnis	Benutzer in einer beliebigen Microsoft 365-Organisation (Geschäfts-, Schul- oder Unikonten)
Konten in einem beliebigen Organisationsverzeichnis ... und persönliche Microsoft-Konten	Benutzer in jeder Microsoft 365-Organisation (Geschäfts-, Schul- oder Unikonten) und persönliche Microsoft-Konten

Lassen Sie URI umleiten leer.
Wählen Sie Registrieren aus. Kopieren Sie auf der Seite Übersicht der Anwendung den Wert der Anwendungs-ID (Client-ID), und speichern Sie ihn. Sie benötigen ihn im nächsten Schritt. Wenn Sie nur Konten in diesem Organisationsverzeichnis für Unterstützte Kontotypen ausgewählt haben, kopieren Sie auch die Verzeichnis-ID (Mandant), und speichern Sie sie.
Wählen Sie unter Verwalten die Option Authentifizierung aus. Suchen Sie den Abschnitt Erweiterte Einstellungen , und ändern Sie die Umschaltfläche Öffentliche Clientflows zulassen auf Ja, und wählen Sie dann Speichern aus.

Um PowerShell verwenden zu können, benötigen Sie das Microsoft Graph PowerShell SDK. Falls sie nicht vorhanden ist, finden Sie unter Installieren des Microsoft Graph PowerShell SDK Anweisungen zur Installation.

Wichtig

Das PowerShell-Skript erfordert ein Geschäfts-, Schul- oder Unikonto mit der Rolle Anwendungsadministrator, Cloudanwendungsadministrator oder Globaler Administrator. Wenn Ihr Konto über die Rolle Anwendungsentwickler verfügt, können Sie sich im Microsoft Entra Admin Center registrieren.

Erstellen Sie eine neue Datei mit dem NamenRegisterAppForUserAuth.ps1 , und fügen Sie den folgenden Code hinzu.

param(
  [Parameter(Mandatory=$true,
  HelpMessage="The friendly name of the app registration")]
  [String]
  $AppName,

  [Parameter(Mandatory=$false,
  HelpMessage="The sign in audience for the app")]
  [ValidateSet("AzureADMyOrg", "AzureADMultipleOrgs", `
  "AzureADandPersonalMicrosoftAccount", "PersonalMicrosoftAccount")]
  [String]
  $SignInAudience = "AzureADandPersonalMicrosoftAccount",

  [Parameter(Mandatory=$false)]
  [Switch]
  $StayConnected = $false
)

# Tenant to use in authentication.
# See https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-device-code#device-authorization-request
$authTenant = switch ($SignInAudience)
{
  "AzureADMyOrg" { "tenantId" }
  "AzureADMultipleOrgs" { "organizations" }
  "AzureADandPersonalMicrosoftAccount" { "common" }
  "PersonalMicrosoftAccount" { "consumers" }
  default { "invalid" }
}

if ($authTenant -eq "invalid")
{
  Write-Host -ForegroundColor Red "Invalid sign in audience:" $SignInAudience
  Exit
}

# Requires an admin
Connect-MgGraph -Scopes "Application.ReadWrite.All User.Read" -UseDeviceAuthentication -ErrorAction Stop

# Get context for access to tenant ID
$context = Get-MgContext -ErrorAction Stop

if ($authTenant -eq "tenantId")
{
  $authTenant = $context.TenantId
}

# Create app registration
$appRegistration = New-MgApplication -DisplayName $AppName -SignInAudience $SignInAudience `
 -IsFallbackPublicClient -ErrorAction Stop
Write-Host -ForegroundColor Cyan "App registration created with app ID" $appRegistration.AppId

# Create corresponding service principal
if ($SignInAudience -ne "PersonalMicrosoftAccount")
{
  New-MgServicePrincipal -AppId $appRegistration.AppId -ErrorAction SilentlyContinue `
   -ErrorVariable SPError | Out-Null
  if ($SPError)
  {
    Write-Host -ForegroundColor Red "A service principal for the app could not be created."
    Write-Host -ForegroundColor Red $SPError
    Exit
  }

  Write-Host -ForegroundColor Cyan "Service principal created"
}

Write-Host
Write-Host -ForegroundColor Green "SUCCESS"
Write-Host -ForegroundColor Cyan -NoNewline "Client ID: "
Write-Host -ForegroundColor Yellow $appRegistration.AppId
Write-Host -ForegroundColor Cyan -NoNewline "Auth tenant: "
Write-Host -ForegroundColor Yellow $authTenant

if ($StayConnected -eq $false)
{
  Disconnect-MgGraph | Out-Null
  Write-Host "Disconnected from Microsoft Graph"
}
else
{
  Write-Host
  Write-Host -ForegroundColor Yellow `
   "The connection to Microsoft Graph is still active. To disconnect, use Disconnect-MgGraph"
}

Speichern Sie die Datei.
Öffnen Sie PowerShell, und ändern Sie das aktuelle Verzeichnis in den Speicherort von RegisterAppForUserAuth.ps1.

Führen Sie den folgenden Befehl aus, und <ersetzen Sie audience-value> durch den gewünschten Wert (siehe Tabelle unten).

.\RegisterAppForUserAuth.ps1 -AppName "Graph User Auth Tutorial" -SignInAudience <audience-value>

SignInAudience-Wert	Wer kann sich anmelden?
`AzureADMyOrg`	Nur Benutzer in Ihrer Microsoft 365-Organisation
`AzureADMultipleOrgs`	Benutzer in einer beliebigen Microsoft 365-Organisation (Geschäfts-, Schul- oder Unikonten)
`AzureADandPersonalMicrosoftAccount`	Benutzer in jeder Microsoft 365-Organisation (Geschäfts-, Schul- oder Unikonten) und persönliche Microsoft-Konten
`PersonalMicrosoftAccount`	Nur persönliche Microsoft-Konten

Folgen Sie der Aufforderung, um in einem Browser zu öffnen https://microsoft.com/devicelogin , geben Sie den bereitgestellten Code ein, und schließen Sie den Authentifizierungsprozess ab.
Kopieren Sie die Werte für Client-ID und Authentifizierungsmandanten aus der Skriptausgabe. Sie benötigen diese Werte im nächsten Schritt.
```
SUCCESS
Client ID: 2fb1652f-a9a0-4db9-b220-b224b8d9d38b
Auth tenant: common
```

Hinweis

Beachten Sie, dass Sie keine Microsoft Graph-Berechtigungen für die App-Registrierung konfiguriert haben. Dies liegt daran, dass im Beispiel die dynamische Zustimmung verwendet wird, um bestimmte Berechtigungen für die Benutzerauthentifizierung anzufordern.

Erstellen einer Python-Konsolen-App

25 Minuten verbleibend

Erstellen Sie zunächst eine neue Python-Datei.

Erstellen Sie eine neue Datei mit dem Namen main.py , und fügen Sie den folgenden Code hinzu.
```
print ('Hello world!')
```
Speichern Sie die Datei, und verwenden Sie den folgenden Befehl, um die Datei auszuführen.
```
python3 main.py
```
Wenn es funktioniert, sollte die App ausgeben Hello world!.

Installieren von Abhängigkeiten

Bevor Sie mit dem Vorgang fortfahren, fügen Sie einige zusätzliche Abhängigkeiten hinzu, die Sie später verwenden werden.

Azure Identity-Clientbibliothek für Python zum Authentifizieren des Benutzers und Abrufen von Zugriffstoken.
Microsoft Graph SDK für Python (Vorschau), um Aufrufe an Microsoft Graph zu senden.

Führen Sie die folgenden Befehle in Ihrer CLI aus, um die Abhängigkeiten zu installieren.

python3 -m pip install azure-identity
python3 -m pip install msgraph-sdk

Laden von Anwendungseinstellungen

In diesem Abschnitt fügen Sie dem Projekt die Details Ihrer App-Registrierung hinzu.

Erstellen Sie eine Datei im selben Verzeichnis wie main.py namens config.cfg , und fügen Sie den folgenden Code hinzu.
```
[azure]
clientId = YOUR_CLIENT_ID_HERE
tenantId = common
graphUserScopes = User.Read Mail.Read Mail.Send
```

Aktualisieren Sie die Werte gemäß der folgenden Tabelle.

Einstellung	Wert
`clientId`	Die Client-ID Ihrer App-Registrierung
`tenantId`	Wenn Sie die Option ausgewählt haben, nur Benutzern in Ihrer Organisation die Anmeldung zu gestatten, ändern Sie diesen Wert in Ihre Mandanten-ID. Übernehmen Sie andernfalls den Wert `common`.

Tipp

Optional können Sie diese Werte in einer separaten Datei namens config.dev.cfg festlegen.

Entwerfen der App

In diesem Abschnitt erstellen Sie ein einfaches konsolenbasiertes Menü.

Erstellen Sie eine neue Datei mit dem Namen graph.py , und fügen Sie der Datei den folgenden Code hinzu.
```
# Temporary placeholder
class Graph:
    def __init__(self, config):
        self.settings = config
```
Dieser Code ist ein Platzhalter. Sie implementieren die Graph -Klasse im nächsten Abschnitt.

Öffnen Sie main.py , und ersetzen Sie den gesamten Inhalt durch den folgenden Code.

import asyncio
import configparser
from msgraph.generated.models.o_data_errors.o_data_error import ODataError
from graph import Graph

async def main():
    print('Python Graph Tutorial\n')

    # Load settings
    config = configparser.ConfigParser()
    config.read(['config.cfg', 'config.dev.cfg'])
    azure_settings = config['azure']

    graph: Graph = Graph(azure_settings)

    await greet_user(graph)

    choice = -1

    while choice != 0:
        print('Please choose one of the following options:')
        print('0. Exit')
        print('1. Display access token')
        print('2. List my inbox')
        print('3. Send mail')
        print('4. Make a Graph call')

        try:
            choice = int(input())
        except ValueError:
            choice = -1

        try:
            if choice == 0:
                print('Goodbye...')
            elif choice == 1:
                await display_access_token(graph)
            elif choice == 2:
                await list_inbox(graph)
            elif choice == 3:
                await send_mail(graph)
            elif choice == 4:
                await make_graph_call(graph)
            else:
                print('Invalid choice!\n')
        except ODataError as odata_error:
            print('Error:')
            if odata_error.error:
                print(odata_error.error.code, odata_error.error.message)

Fügen Sie am Ende der Datei die folgenden Platzhaltermethoden hinzu. Sie implementieren sie in späteren Schritten.

async def greet_user(graph: Graph):
    # TODO
    return

async def display_access_token(graph: Graph):
    # TODO
    return

async def list_inbox(graph: Graph):
    # TODO
    return

async def send_mail(graph: Graph):
    # TODO
    return

async def make_graph_call(graph: Graph):
    # TODO
    return

Fügen Sie die folgende Zeile hinzu, um am Ende der Datei aufzurufen main .
```
# Run main
asyncio.run(main())
```

Dadurch wird ein einfaches Menü implementiert und die Auswahl des Benutzers aus der Befehlszeile gelesen.

Hinzufügen der Benutzerauthentifizierung

20 Minuten verbleibend

In diesem Abschnitt erweitern Sie die Anwendung aus der vorherigen Übung, um die Authentifizierung mit Azure AD zu unterstützen. Dies ist erforderlich, um das erforderliche OAuth-Zugriffstoken zum Aufrufen von Microsoft Graph abzurufen. In diesem Schritt integrieren Sie die Azure Identity-Clientbibliothek für Python in die Anwendung und konfigurieren die Authentifizierung für das Microsoft Graph SDK für Python (Vorschau).

Die Azure Identity-Bibliothek bietet eine Reihe von TokenCredential Klassen, die OAuth2-Tokenflows implementieren. Das Microsoft Graph SDK verwendet diese Klassen, um Aufrufe von Microsoft Graph zu authentifizieren.

Konfigurieren des Graph-Clients für die Benutzerauthentifizierung

In diesem Abschnitt verwenden Sie die DeviceCodeCredential -Klasse, um mithilfe des Gerätecodeflows ein Zugriffstoken anzufordern.

Öffnen Sie graph.py , und ersetzen Sie den gesamten Inhalt durch den folgenden Code.

from configparser import SectionProxy
from azure.identity import DeviceCodeCredential
from msgraph import GraphServiceClient
from msgraph.generated.users.item.user_item_request_builder import UserItemRequestBuilder
from msgraph.generated.users.item.mail_folders.item.messages.messages_request_builder import (
    MessagesRequestBuilder)
from msgraph.generated.users.item.send_mail.send_mail_post_request_body import (
    SendMailPostRequestBody)
from msgraph.generated.models.message import Message
from msgraph.generated.models.item_body import ItemBody
from msgraph.generated.models.body_type import BodyType
from msgraph.generated.models.recipient import Recipient
from msgraph.generated.models.email_address import EmailAddress

class Graph:
    settings: SectionProxy
    device_code_credential: DeviceCodeCredential
    user_client: GraphServiceClient

    def __init__(self, config: SectionProxy):
        self.settings = config
        client_id = self.settings['clientId']
        tenant_id = self.settings['tenantId']
        graph_scopes = self.settings['graphUserScopes'].split(' ')

        self.device_code_credential = DeviceCodeCredential(client_id, tenant_id = tenant_id)
        self.user_client = GraphServiceClient(self.device_code_credential, graph_scopes)

Dieser Code deklariert zwei private Eigenschaften, ein DeviceCodeCredential -Objekt und ein GraphServiceClient -Objekt. Die __init__ -Funktion erstellt eine neue Instanz von DeviceCodeCredentialund verwendet diese Instanz dann, um eine neue Instanz von GraphServiceClientzu erstellen. Jedes Mal, wenn ein API-Aufruf an Microsoft Graph über user_clienterfolgt, werden die bereitgestellten Anmeldeinformationen verwendet, um ein Zugriffstoken abzurufen.

Fügen Sie graph.py die folgende Funktion hinzu.

async def get_user_token(self):
    graph_scopes = self.settings['graphUserScopes']
    access_token = self.device_code_credential.get_token(graph_scopes)
    return access_token.token

Ersetzen Sie die leere display_access_token Funktion in main.py durch Folgendes.

async def display_access_token(graph: Graph):
    token = await graph.get_user_token()
    print('User token:', token, '\n')

Erstellen Sie die App, und führen Sie sie aus. Geben Sie ein 1 , wenn Sie zur Eingabe einer Option aufgefordert werden. Die Anwendung zeigt eine URL und den Gerätecode an.

Python Graph Tutorial

Please choose one of the following options:
0. Exit
1. Display access token
2. List my inbox
3. Send mail
4. Make a Graph call
1
To sign in, use a web browser to open the page https://microsoft.com/devicelogin and
enter the code RB2RUD56D to authenticate.

Öffnen Sie einen Browser, und navigieren Sie zu der angezeigten URL. Geben Sie den angegebenen Code ein, und melden Sie sich an.

Wichtig

Achten Sie auf vorhandene Microsoft 365-Konten, die bei Ihrem Browser angemeldet sind, wenn Sie zu https://microsoft.com/deviceloginnavigieren. Verwenden Sie Browserfeatures wie Profile, Gastmodus oder privaten Modus, um sicherzustellen, dass Sie sich als das Konto authentifizieren, das Sie zu Testzwecken verwenden möchten.
Kehren Sie nach Abschluss des Vorgangs zur Anwendung zurück, um das Zugriffstoken anzuzeigen.

Tipp

Nur zu Validierungs- und Debugzwecken können Sie Benutzerzugriffstoken (nur für Geschäfts-, Schul- oder Unikonten) decodieren, indem Sie den Onlinetokenparser von Microsoft unter verwendenhttps://jwt.ms. Dies kann nützlich sein, wenn beim Aufrufen von Microsoft Graph Tokenfehler auftreten. Beispielsweise wird überprüft, ob der scp Anspruch im Token die erwarteten Microsoft Graph-Berechtigungsbereiche enthält.

Benutzer abrufen

15 Minuten verbleibend

In diesem Abschnitt integrieren Sie Microsoft Graph in die Anwendung. Für diese Anwendung verwenden Sie das Microsoft Graph SDK für Python (Vorschau), um Aufrufe an Microsoft Graph zu senden.

Fügen Sie graph.py die folgende Funktion hinzu.

async def get_user(self):
    # Only request specific properties using $select
    query_params = UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters(
        select=['displayName', 'mail', 'userPrincipalName']
    )

    request_config = UserItemRequestBuilder.UserItemRequestBuilderGetRequestConfiguration(
        query_parameters=query_params
    )

    user = await self.user_client.me.get(request_configuration=request_config)
    return user

Ersetzen Sie die leere greet_user Funktion in main.py durch Folgendes.

async def greet_user(graph: Graph):
    user = await graph.get_user()
    if user:
        print('Hello,', user.display_name)
        # For Work/school accounts, email is in mail property
        # Personal accounts, email is in userPrincipalName
        print('Email:', user.mail or user.user_principal_name, '\n')

Wenn Sie die App jetzt ausführen, werden Sie nach der Anmeldung in der App mit dem Namen begrüßt.

Hello, Megan Bowen!
Email: MeganB@contoso.com

Code erläutert

Betrachten Sie den Code in der get_user Funktion. Es sind nur wenige Zeilen, aber es sind einige wichtige Details zu beachten.

Zugreifen auf "me"

Die Funktion erstellt eine Anforderung an die Api zum Abrufen von Benutzern . Auf diese API kann auf zwei Arten zugegriffen werden:

GET /me
GET /users/{user-id}

In diesem Fall ruft der Code den GET /me API-Endpunkt auf. Dies ist eine Verknüpfungsmethode, um den authentifizierten Benutzer abzurufen, ohne seine Benutzer-ID zu kennen.

Hinweis

Da der GET /me API-Endpunkt den authentifizierten Benutzer abruft, ist er nur für Apps verfügbar, die die Benutzerauthentifizierung verwenden. Reine App-Authentifizierungs-Apps können nicht auf diesen Endpunkt zugreifen.

Anfordern bestimmter Eigenschaften

Die Funktion verwendet den Abfrageparameter $select , um die benötigten Eigenschaften anzugeben. Microsoft Graph gibt nur die angeforderten Eigenschaften in der Antwort zurück. In get_userwird dies mit dem select -Parameter im MeRequestBuilderGetQueryParameters -Objekt erreicht.

Posteingang auflisten

12 Minuten verbleibend

In diesem Abschnitt fügen Sie die Möglichkeit hinzu, Nachrichten im E-Mail-Posteingang des Benutzers aufzulisten.

Fügen Sie graph.py die folgende Funktion hinzu.

async def get_inbox(self):
    query_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(
        # Only request specific properties
        select=['from', 'isRead', 'receivedDateTime', 'subject'],
        # Get at most 25 results
        top=25,
        # Sort by received time, newest first
        orderby=['receivedDateTime DESC']
    )
    request_config = MessagesRequestBuilder.MessagesRequestBuilderGetRequestConfiguration(
        query_parameters= query_params
    )

    messages = await self.user_client.me.mail_folders.by_mail_folder_id('inbox').messages.get(
            request_configuration=request_config)
    return messages

Ersetzen Sie die leere list_inbox Funktion in main.py durch Folgendes.

async def list_inbox(graph: Graph):
    message_page = await graph.get_inbox()
    if message_page and message_page.value:
        # Output each message's details
        for message in message_page.value:
            print('Message:', message.subject)
            if (
                message.from_ and
                message.from_.email_address
            ):
                print('  From:', message.from_.email_address.name or 'NONE')
            else:
                print('  From: NONE')
            print('  Status:', 'Read' if message.is_read else 'Unread')
            print('  Received:', message.received_date_time)

        # If @odata.nextLink is present
        more_available = message_page.odata_next_link is not None
        print('\nMore messages available?', more_available, '\n')

Führen Sie die App aus, melden Sie sich an, und wählen Sie Option 2 aus, um Ihren Posteingang aufzulisten.

Please choose one of the following options:
0. Exit
1. Display access token
2. List my inbox
3. Send mail
4. Make a Graph call
2
Message: Updates from Ask HR and other communities
  From: Contoso Demo on Yammer
  Status: Read
  Received: 2022-04-26T19:19:05Z
Message: Employee Initiative Thoughts
  From: Patti Fernandez
  Status: Read
  Received: 2022-04-25T19:43:57Z
Message: Voice Mail (11 seconds)
  From: Alex Wilber
  Status: Unread
  Received: 2022-04-22T19:43:23Z
Message: Our Spring Blog Update
  From: Alex Wilber
  Status: Unread
  Received: 2022-04-19T22:19:02Z
Message: Atlanta Flight Reservation
  From: Alex Wilber
  Status: Unread
  Received: 2022-04-19T15:15:56Z
Message: Atlanta Trip Itinerary - down time
  From: Alex Wilber
  Status: Unread
  Received: 2022-04-18T14:24:16Z

...

More messages available? True

Code erläutert

Betrachten Sie den Code in der get_inbox Funktion.

Zugreifen auf bekannte E-Mail-Ordner

Die Funktion erstellt eine Anforderung an die API zum Auflisten von Nachrichten . Da sie den Anforderungs-Generator mail_folders.by_mail_folder_id('inbox') enthält, gibt die API nur Nachrichten im angeforderten E-Mail-Ordner zurück. Da der Posteingang in diesem Fall ein bekannter Standardordner innerhalb des Postfachs eines Benutzers ist, ist er über seinen bekannten Namen zugänglich. Auf nicht standardmäßige Ordner wird auf die gleiche Weise zugegriffen, indem der bekannte Name durch die ID-Eigenschaft des E-Mail-Ordners ersetzt wird. Ausführliche Informationen zu den verfügbaren bekannten Ordnernamen finden Sie unter mailFolder-Ressourcentyp.

Zugreifen auf eine Sammlung

Im Gegensatz zur get_user Funktion aus dem vorherigen Abschnitt, die ein einzelnes Objekt zurückgibt, gibt diese Methode eine Auflistung von Nachrichten zurück. Die meisten APIs in Microsoft Graph, die eine Sammlung zurückgeben, geben nicht alle verfügbaren Ergebnisse in einer einzigen Antwort zurück. Stattdessen wird paging verwendet, um einen Teil der Ergebnisse zurückzugeben, während clients eine Methode zum Anfordern der nächsten "Seite" bereitstellen.

Standardseitengrößen

APIs, die Paging verwenden, implementieren eine Standardseitengröße. Für Nachrichten ist der Standardwert 10. Clients können mithilfe des abfrageparameters $top mehr (oder weniger) anfordern. In get_inboxwird dies mit dem top -Parameter im MessagesRequestBuilderGetQueryParameters -Objekt erreicht.

Hinweis

Der übergebene $top Wert ist eine obere Grenze, keine explizite Zahl. Die API gibt eine Anzahl von Nachrichten bis zum angegebenen Wert zurück.

Abrufen nachfolgender Seiten

Wenn auf dem Server weitere Ergebnisse verfügbar sind, enthalten Sammlungsantworten eine @odata.nextLink Eigenschaft mit einer API-URL für den Zugriff auf die nächste Seite. Das Python SDK macht dies als odata_next_link Eigenschaft für Sammlungsseitenobjekte verfügbar. Wenn diese Eigenschaft vorhanden ist, sind weitere Ergebnisse verfügbar.

Sortieren von Sammlungen

Die Funktion verwendet den Abfrageparameter $orderby , um Ergebnisse anzufordern, die nach dem Zeitpunkt sortiert sind, zu dem die Nachricht empfangen wird (receivedDateTime -Eigenschaft). Es enthält das DESC Schlüsselwort, sodass kürzlich empfangene Nachrichten zuerst aufgeführt werden. In get_inboxwird dies mit dem orderby -Parameter im MessagesRequestBuilderGetQueryParameters -Objekt erreicht.

Nachrichten senden

8 Minuten verbleibend

In diesem Abschnitt fügen Sie die Möglichkeit hinzu, eine E-Mail-Nachricht als authentifizierten Benutzer zu senden.

Fügen Sie graph.py die folgende Funktion hinzu.

async def send_mail(self, subject: str, body: str, recipient: str):
    message = Message()
    message.subject = subject

    message.body = ItemBody()
    message.body.content_type = BodyType.Text
    message.body.content = body

    to_recipient = Recipient()
    to_recipient.email_address = EmailAddress()
    to_recipient.email_address.address = recipient
    message.to_recipients = []
    message.to_recipients.append(to_recipient)

    request_body = SendMailPostRequestBody()
    request_body.message = message

    await self.user_client.me.send_mail.post(body=request_body)

Ersetzen Sie die leere send_mail Funktion in main.py durch Folgendes.

async def send_mail(graph: Graph):
    # Send mail to the signed-in user
    # Get the user for their email address
    user = await graph.get_user()
    if user:
        user_email = user.mail or user.user_principal_name

        await graph.send_mail('Testing Microsoft Graph', 'Hello world!', user_email or '')
        print('Mail sent.\n')

Führen Sie die App aus, melden Sie sich an, und wählen Sie Option 3 aus, um eine E-Mail an sich selbst zu senden.
```
Please choose one of the following options:
0. Exit
1. Display access token
2. List my inbox
3. Send mail
4. Make a Graph call
3
Mail sent.
```
Hinweis

Wenn Sie mit einem Entwicklermandanten aus dem Microsoft 365-Entwicklerprogramm testen, wird die von Ihnen gesendete E-Mail möglicherweise nicht zugestellt, und Sie erhalten möglicherweise einen Nichtzustellbarkeitsbericht. Wenden Sie sich in diesem Fall über das Microsoft 365 Admin Center an den Support.
Um zu überprüfen, ob die Nachricht empfangen wurde, wählen Sie Option 2 aus, um Ihren Posteingang aufzulisten.

Code erläutert

Betrachten Sie den Code in der send_mail Funktion.

Senden von E-Mails

Die Funktion verwendet den Anforderungs-Generator user_client.me.send_mail , der eine Anforderung an die API zum Senden von E-Mails erstellt.

Erstellen von Objekten

Im Gegensatz zu den vorherigen Aufrufen von Microsoft Graph, die nur Daten lesen, werden mit diesem Aufruf Daten erstellt. Um dies mit der Clientbibliothek zu tun, erstellen Sie ein Wörterbuch, das die Anforderungsnutzlast darstellt, legen Sie die gewünschten Eigenschaften fest und senden sie dann im API-Aufruf. Da der Aufruf Daten sendet, wird die post -Methode anstelle von getverwendet.

Optional: Fügen Sie Ihren eigenen Code hinzu.

5 Minuten verbleibend

In diesem Abschnitt fügen Sie der Anwendung Ihre eigenen Microsoft Graph-Funktionen hinzu. Dies kann ein Codeausschnitt aus der Microsoft Graph-Dokumentation oder graph-Explorer oder code sein, den Sie erstellt haben. Dieser Abschnitt ist optional.

Aktualisieren der App

Fügen Sie graph.py die folgende Funktion hinzu.

async def make_graph_call(self):
    # INSERT YOUR CODE HERE
    return

Ersetzen Sie die leere make_graph_call Funktion in main.py durch Folgendes.

async def make_graph_call(graph: Graph):
    await graph.make_graph_call()

Auswählen einer API

Suchen Sie eine API in Microsoft Graph, die Sie ausprobieren möchten. Beispiel: Die Api zum Erstellen eines Ereignisses . Sie können eines der Beispiele in der API-Dokumentation verwenden oder Eine eigene API-Anforderung erstellen.

Konfigurieren von Berechtigungen

Überprüfen Sie den Abschnitt Berechtigungen der Referenzdokumentation für Die ausgewählte API, um zu sehen, welche Authentifizierungsmethoden unterstützt werden. Einige APIs unterstützen z. B. keine reinen Apps oder persönlichen Microsoft-Konten.

Um eine API mit Benutzerauthentifizierung aufzurufen (wenn die API die Benutzerauthentifizierung (delegierte) unterstützt), fügen Sie den erforderlichen Berechtigungsbereich in config.cfg hinzu.
Informationen zum Aufrufen einer API mit nur app-Authentifizierung finden Sie im Tutorial zur reinen App-Authentifizierung .

Fügen Sie Ihren Code hinzu

Kopieren Sie Ihren Code in die make_graph_call Funktion in graph.py. Wenn Sie einen Codeausschnitt aus der Dokumentation oder dem Graph-Explorer kopieren, müssen Sie den GraphServiceClientself.user_clientin umbenennen.

Freigeben über

Erstellen von Python-Apps mit Microsoft Graph

Voraussetzungen

Registrieren der App im Portal

Registrieren der Anwendung für die Benutzerauthentifizierung

Erstellen einer Python-Konsolen-App

Installieren von Abhängigkeiten

Laden von Anwendungseinstellungen

Entwerfen der App

Hinzufügen der Benutzerauthentifizierung

Konfigurieren des Graph-Clients für die Benutzerauthentifizierung

Benutzer abrufen

Code erläutert

Zugreifen auf "me"

Anfordern bestimmter Eigenschaften

Posteingang auflisten

Code erläutert

Zugreifen auf bekannte E-Mail-Ordner

Zugreifen auf eine Sammlung

Standardseitengrößen

Abrufen nachfolgender Seiten

Sortieren von Sammlungen

Nachrichten senden

Code erläutert

Senden von E-Mails

Erstellen von Objekten

Optional: Fügen Sie Ihren eigenen Code hinzu.

Aktualisieren der App

Auswählen einer API

Konfigurieren von Berechtigungen

Fügen Sie Ihren Code hinzu

Herzlichen Glückwunsch!

Python-Beispiele