如何使用 Python SDK 通过“站点”API 获取/列出我的 SharePoint 站点

Question

我需要一些帮助来了解如何管理 SharePoint 网站的存储库。

假设我的网站 URL 为“https://mycompanyname.sharepoint.com/sites/mysitename” 我首先要“访问”该站点以获得其ID，以便稍后获取该站点下的驱动器并管理存储库。 我想在这里解决的问题是获取站点以便访问其元数据及其 ID。

到目前为止我尝试过，但没有成功：

import os
import jwt
from typing import Optional, Literal
from azure.identity.aio import ClientSecretCredential
from msgraph import GraphServiceClient
from msgraph.generated.models.drive_item import DriveItem
from msgraph.generated.models.folder import Folder
from msgraph.generated.drives.item.items.item.content.content_request_builder import ContentRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
from msgraph.generated.models.o_data_errors.o_data_error import ODataError
from src.config.loader import CONFIG
import aiofiles
from src.utils.logger import get_logger

logger = get_logger(CONFIG.logging.name, CONFIG.logging.level)

class GraphClientSingleton():
    _client = None
    _credentials = None

    @classmethod
    def get_client(cls):
        if cls._client is None:
            # cls._authority = 'login.microsoftonline.com'
            cls._credentials = ClientSecretCredential(
                tenant_id = CONFIG.msgraph.tenant_id_sharepoint,
                client_id = CONFIG.msgraph.client_id_sharepoint,
                client_secret = CONFIG.msgraph.client_secret_sharepoint,
            )
            cls._scopes = ['https://graph.microsoft.com/.default']

            cls._client = GraphServiceClient(credentials=cls._credentials, scopes=cls._scopes)
        return cls._client

    @classmethod
    async def decode_token(cls):
        token = await cls.get_access_token()
        decoded_token = jwt.decode(token, options={"verify_signature": False})
        return decoded_token

    @classmethod
    async def get_access_token(cls):
        if cls._credentials is None:
            cls.get_client()
        
        token = await cls._credentials.get_token(*cls._scopes)
        return token.token
    
class SharePointDAO:
    def __init__(self):
        self.client = GraphClientSingleton.get_client()
        
if __name__ == "__main__":
    async def test_api():
        token = await GraphClientSingleton.decode_token()
        sp_dao = SharePointDAO()
        # Example 1
        from msgraph.generated.sites.sites_request_builder import SitesRequestBuilder
        from kiota_abstractions.base_request_configuration import RequestConfiguration
        # To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
        query_params = SitesRequestBuilder.SitesRequestBuilderGetQueryParameters(
            select = ["siteCollection", "webUrl"],
            filter = "siteCollection/root ne null",
        )
        request_configuration = RequestConfiguration(
            query_parameters = query_params,
        )
        sites = await sp_dao.client.sites.get(request_configuration = request_configuration)
        # Example 2 (not sure how to map the "real" URL with the needed url here)
        site_request_builder = sp_dao.client.sites.with_url(
            "https://graph.microsoft.com/v1.0/sites/mycompanyname.sharepoint.com:/mysitename"
        )
        site = await site_request_builder.get()
        # Example 3 (return empty list under "value")
        sites = await sp_dao.client.sites.get()
        # Example 4 (return 403 error "Access Denied")
        sites = await sp_dao.client.sites.get_all_sites.get()
        logger.info(sites)
    import asyncio
    asyncio.run(test_api())

Answer 1

如果您使用像

Sites.Read.All

这样的应用程序权限，您可以调用

getAllSites

端点并按

webUrl

过滤站点。

from msgraph import GraphServiceClient
from msgraph.generated.sites.get_all_sites.get_all_sites_request_builder import GetAllSitesRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration

graph_client = GraphServiceClient(credentials, scopes)

query_params = GetAllSitesRequestBuilder.GetAllSitesRequestBuilderGetQueryParameters(
        filter = "webUrl eq 'https://mycompanyname.sharepoint.com/sites/mysitename'",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.sites.get_all_sites.get(request_configuration = request_configuration)

或者使用

$search

查询参数：

from msgraph import GraphServiceClient
from msgraph.generated.sites.sites_request_builder import SitesRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration

graph_client = GraphServiceClient(credentials, scopes)

query_params = SitesRequestBuilder.SitesRequestBuilderGetQueryParameters(
        search = "\"https://mycompanyname.sharepoint.com/sites/mysitename\"",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.sites.get(request_configuration = request_configuration)