使用 Microsoft Graph 建置 Python 應用程式
本教學課程會教導您如何建置使用 Microsoft Graph API 來代表使用者存取數據的 Python 控制台應用程式。
注意
若要瞭解如何使用 Microsoft Graph 來存取使用僅限應用程式驗證的數據,請參閱本 僅限應用程式的驗證教學課程。
在本教學課程中,您將:
提示
除了遵循本教學課程,您可以透過 快速入 門工具下載已完成的程序代碼,以自動化應用程式註冊和設定。 下載的程式代碼不需要修改即可運作。
您也可以下載或複製 GitHub 存放庫 ,並遵循自述檔中的指示來註冊應用程式並設定專案。
必要條件
開始本教學課程之前,您應該已在開發計算機上安裝 Python 和 pip 。
您也應該有具有 Exchange Online 信箱Microsoft公司或學校帳戶。 如果您沒有Microsoft 365 租使用者,您可能有資格透過 Microsoft 365 開發人員計劃;如需詳細資訊,請參閱 常見問題。 或者,您可以 註冊 1 個月的免費試用版,或購買Microsoft 365 方案。
注意
本教學課程是使用 Python 3.10.4 版和 pip 20.0.2 版所撰寫。 本指南中的步驟可能適用於其他版本,但尚未經過測試。
在入口網站中註冊應用程式
在此練習中,您將在 Azure Active Directory 中註冊新的應用程式,以啟用 用戶驗證。 您可以使用 Microsoft Entra 系統管理中心或使用 Microsoft Graph PowerShell SDK 來註冊應用程式。
註冊應用程式以進行用戶驗證
在本節中,您將使用 裝置程式代碼流程註冊支援使用者驗證的應用程式。
開啟瀏覽器並流覽至 Microsoft Entra 系統管理中心 ,並使用全域系統管理員帳戶登入。
選Microsoft左側導覽中的 [Entra ID ],依序展開 [ 身分識別]、[ 應用程式],然後選取 [ 應用程式註冊]。
選取 [新增註冊]。 輸入應用程式名稱,例如
Graph User Auth Tutorial
。視需要設定 支持的帳戶類型 。 選項如下:
選項 誰可以登入? 僅限此組織目錄中的帳戶 只有您Microsoft 365 組織中的使用者 任何組織目錄中的帳戶 任何Microsoft 365 組織中的使用者 (公司或學校帳戶) 任何組織目錄中的帳戶...和個人Microsoft帳戶 任何Microsoft 365 組織中的使用者 (公司或學校帳戶) 和個人Microsoft帳戶 將 [重新導向 URI ] 保留空白。
選取 [登錄]。 在應用程式的 [ 概觀] 頁面上,將應用程式 (用戶端的值複製 ) 標識 符並加以儲存,您將在下一個步驟中加以儲存。 如果您只針對支持的帳戶類型選擇 [此組織目錄中的帳戶],也請複製 [目錄 (租使用者) 標識符並加以儲存。
選取管理下的驗證。 找出 [ 進階設定] 區 段,並將 [ 允許公用用戶端流程 ] 切換為 [ 是],然後選擇 [ 儲存]。
注意
請注意,您未在應用程式註冊上設定任何 Microsoft Graph 許可權。 這是因為範例會使用 動態同意 來要求使用者驗證的特定許可權。
建立 Python 控制台應用程式
從建立新的 Python 檔案開始。
建立名為 main.py 的新檔案,並新增下列程序代碼。
print ('Hello world!')
儲存盤案,並使用下列命令來執行檔案。
python3 main.py
如果可以運作,應用程式應該會輸出
Hello world!
。
安裝相依性
繼續之前,請新增一些您稍後將使用的額外相依性。
- 適用於 Python 的 Azure 身分識別用戶端連結庫 ,用來驗證使用者並取得存取令牌。
- Microsoft Graph SDK for Python (預覽) 來呼叫 Microsoft Graph。
在 CLI 中執行下列命令以安裝相依性。
python3 -m pip install azure-identity
python3 -m pip install msgraph-sdk
載入應用程式設定
在本節中,您會將應用程式註冊的詳細數據新增至專案。
在與 config.cfgmain.py 相同的目錄中建立檔案,並新增下列程序代碼。
[azure] clientId = YOUR_CLIENT_ID_HERE tenantId = common graphUserScopes = User.Read Mail.Read Mail.Send
根據下表更新值。
設定 值 clientId
應用程式註冊的用戶端識別碼 tenantId
如果您選擇只允許組織中的使用者登入的選項,請將此值變更為您的租使用者識別碼。 否則,請保留為 common
。提示
您可以選擇性地在名為 config.dev.cfg 的個別檔案中設定這些值。
設計應用程式
在本節中,您將建立簡單的控制台型功能表。
建立名為 graph.py 的新檔案,並將下列程式代碼新增至該檔案。
# Temporary placeholder class Graph: def __init__(self, config): self.settings = config
此程式代碼是佔位元。 您將在下一
Graph
節中實作 類別。開 啟 main.py ,並以下列程式代碼取代其整個內容。
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)
在文件尾新增下列佔位符方法。 您將在後續步驟中實作它們。
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
新增下列程式代碼列,以在檔案尾呼叫
main
。# Run main asyncio.run(main())
這會實作基本功能表,並從命令行讀取用戶的選擇。
新增用戶驗證
在本節中,您將擴充上一個練習中的應用程式,以支援使用 Azure AD 進行驗證。 這是取得必要的 OAuth 存取令牌以呼叫 Microsoft Graph 的必要專案。 在此步驟中,您會將 適用於 Python 的 Azure 身分識別客戶端連結庫 整合到應用程式中,併為 Microsoft Graph SDK for Python (預覽版設定驗證) 。
Azure 身分識別連結庫提供數個實作 OAuth2 令牌流程的 TokenCredential
類別。 Microsoft Graph SDK 會使用這些類別來驗證對 Microsoft Graph 的呼叫。
設定 Graph 用戶端以進行用戶驗證
在本節中, DeviceCodeCredential
您將使用 類別,使用 裝置程式代碼流程來要求存取令牌。
開 啟 graph.py ,並以下列程式代碼取代其整個內容。
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)
此程式代碼會宣告兩個
DeviceCodeCredential
私用屬性:對象和GraphServiceClient
物件。 函__init__
式會建立 的新實例DeviceCodeCredential
,然後使用該實例來建立 的新實GraphServiceClient
例。 每次透過 Microsoft Graphuser_client
進行 API 呼叫時,它都會使用提供的認證來取得存取令牌。將下列函式新增至 graph.py。
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
以下列內容取代 main.py 中的空白
display_access_token
函式。async def display_access_token(graph: Graph): token = await graph.get_user_token() print('User token:', token, '\n')
建置並執行應用程式。 當系統提示您輸入選項時,請輸入
1
。 應用程式會顯示 URL 和裝置程式代碼。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.
開啟瀏覽器並瀏覽至顯示的 URL。 輸入提供的程式代碼並登入。
重要
流覽至
https://microsoft.com/devicelogin
時,請留意任何已登入瀏覽器的現有Microsoft 365 帳戶。 使用瀏覽器功能,例如配置檔、來賓模式或私人模式,以確保您驗證為您想要用於測試的帳戶。完成後,返回應用程式以查看存取令牌。
提示
僅供驗證和偵錯之用,您只能在 使用 Microsoft 的在線令牌剖析器https://jwt.ms,將公司或學校帳戶 (的使用者存取令牌譯碼) 。 如果您在呼叫 Microsoft Graph 時遇到令牌錯誤,這會很有用。 例如,確認
scp
令牌中的宣告包含預期的 Microsoft Graph 許可權範圍。
取得使用者
在本節中,您會將 Microsoft Graph 併入應用程式。 針對此應用程式,您將使用 Microsoft Graph SDK for Python (預覽) 來呼叫 Microsoft Graph。
將下列函式新增至 graph.py。
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
以下列內容取代 main.py 中的空白
greet_user
函式。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')
如果您現在執行應用程式,在您登入應用程式之後,會依名稱歡迎您。
Hello, Megan Bowen!
Email: MeganB@contoso.com
程式代碼說明
請考慮函式中的程序 get_user
代碼。 這隻是幾行,但有一些重要詳細數據需要注意。
存取 'me'
函式會建置對 Get 使用者 API 的要求。 此 API 有兩種方式可供存取:
GET /me
GET /users/{user-id}
在此情況下,程式代碼會呼叫 GET /me
API 端點。 這是在不知道使用者標識碼的情況下取得已驗證使用者的快捷方式。
注意
GET /me
因為 API 端點會取得已驗證的使用者,所以它只適用於使用使用者驗證的應用程式。 僅限應用程式的驗證應用程式無法存取此端點。
要求特定屬性
函式會使用 $select 查詢參數 來指定所需的屬性集。 Microsoft Graph 只會在回應中傳回要求的屬性。 在 get_user
中,這是使用 select
物件中的 MeRequestBuilderGetQueryParameters
參數來完成。
清單收件匣
在本節中,您將新增在使用者的電子郵件收件匣中列出訊息的功能。
將下列函式新增至 graph.py。
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
以下列內容取代 main.py 中的空白
list_inbox
函式。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')
執行應用程式、登入,然後選擇選項 2 來列出您的收件匣。
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
程式代碼說明
請考慮函式中的程序 get_inbox
代碼。
存取已知的郵件資料夾
函式會建置對 清單訊息 API 的要求。 因為它包含 mail_folders.by_mail_folder_id('inbox')
要求產生器,所以 API 只會傳回所要求郵件資料夾中的訊息。 在此情況下,由於收件匣是使用者信箱內的預設已知資料夾,因此可透過其已知名稱存取。 非預設資料夾的存取方式相同,方法是將已知名稱取代為郵件資料夾的ID屬性。 如需可用已知資料夾名稱的詳細資訊,請參閱 mailFolder 資源類型。
存取集合
不同於 get_user
上一節傳回單一物件的 函式,這個方法會傳回訊息的集合。 Microsoft Graph 中傳回集合的大部分 API 不會在單一回應中傳回所有可用的結果。 相反地,他們會使用 分頁 來傳回部分結果,同時提供方法讓用戶端要求下一個「頁面」。
默認頁面大小
使用分頁的 API 會實作預設頁面大小。 對於訊息,預設值為10。 用戶端可以使用 $top 查詢參數來要求更多 (或更少 ) 。 在 get_inbox
中,這是使用 top
物件中的 MessagesRequestBuilderGetQueryParameters
參數來完成。
注意
傳入的 $top
值是上限,而不是明確的數位。 API 會傳回一些訊息 ,最多可達 指定的值。
取得後續頁面
如果伺服器上有更多可用的結果,集合回應會包含具有 @odata.nextLink
API URL 的屬性,以存取下一頁。 Python SDK 會將此公開為 odata_next_link
集合頁面物件上的 屬性。 如果此屬性存在,則會有更多結果可供使用。
排序集合
函式會使用 $orderby 查詢參數 ,要求在收到訊息 (屬性) receivedDateTime
時排序的結果。 它包含 DESC
關鍵詞,因此會先列出最近收到的訊息。 在 get_inbox
中,這是使用 orderby
物件中的 MessagesRequestBuilderGetQueryParameters
參數來完成。
傳送郵件
在本節中,您將新增以已驗證使用者身分傳送電子郵件訊息的功能。
將下列函式新增至 graph.py。
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)
以下列內容取代 main.py 中的空白
send_mail
函式。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')
執行應用程式、登入,然後選擇選項 3 將電子郵件傳送給您自己。
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.
注意
如果您使用 Microsoft 365 開發人員計劃中的開發人員租用戶進行測試,您傳送的電子郵件可能不會傳遞,而且您可能會收到未傳遞的報告。 如果您遇到這種情況,請透過 Microsoft 365 系統管理中心連絡支持人員。
若要確認已收到訊息,請選擇選項 2 以列出您的收件匣。
程式代碼說明
請考慮函式中的程序 send_mail
代碼。
傳送郵件
函式會使用 user_client.me.send_mail
要求產生器,以建置傳 送郵件 API 的要求。
建立物件
不同於先前對僅讀取數據的 Microsoft Graph 呼叫,此呼叫會建立數據。 若要使用用戶端連結庫來執行這項操作,請建立代表要求承載的字典,設定所需的屬性,然後在 API 呼叫中傳送它。 因為呼叫正在傳送資料,所以 post
會使用 方法, get
而不是 。
選擇性:新增您自己的程序代碼
在本節中,您會將自己的 Microsoft Graph 功能新增至應用程式。 這可能是來自 Microsoft Graph 檔 或 Graph 總管的代碼段,或您所建立的程式碼。 此區段為選擇性。
更新應用程式
將下列函式新增至 graph.py。
async def make_graph_call(self): # INSERT YOUR CODE HERE return
以下列內容取代 main.py 中的空白
make_graph_call
函式。async def make_graph_call(graph: Graph): await graph.make_graph_call()
選擇 API
在您想要嘗試Microsoft圖形中尋找 API。 例如, 建立事件 API。 您可以使用 API 檔中的其中一個範例,或建立您自己的 API 要求。
設定許可權
請查看所選取 API 參考檔的 [許可權] 區段, 以查看支援哪些驗證方法。 例如,某些 API 不支援僅限應用程式或個人Microsoft帳戶。
- 若要使用使用者驗證呼叫 API (如果 API 支援使用者 (委派的) 驗證) ,請在 config.cfg 中新增必要的許可權範圍。
- 若要使用僅限應用程式驗證來呼叫 API,請參閱 僅限應用程式驗證 教學課程。
新增您的程序代碼
將您的程式代碼複製到 make_graph_call
graph.py 中的函式。 如果您要從檔案或 Graph 總管複製代碼段,請務必將 重新命名 GraphServiceClient
為 self.user_client
。
恭喜!
您已完成 Python Microsoft Graph 教學課程。 既然您有一個可呼叫 Microsoft Graph 的工作應用程式,您可以實驗並新增新功能。
- 瞭解如何搭配 Microsoft Graph SDK for Python 使用 僅限應用程式驗證 。
- 請造訪 Microsoft Graph 概觀 ,以查看您可以使用 Microsoft Graph 存取的所有數據。
Python 範例
在這個區段有遇到問題嗎? 如果有,請提供意見反應,好讓我們可以改善這個區段。