サイトを一覧表示する

[アーティクル]
04/04/2024

名前空間: microsoft.graph

organizationで使用可能なすべてのサイトを一覧表示します。

特定のフィルター条件とクエリオプションもサポートされ、以下で説明します。

Filter ステートメント	Select ステートメント	説明
`siteCollection/root ne null`	`siteCollection,webUrl`	organization内のすべてのルートレベルのサイトコレクションをListsします。各地域のホームサイトを検出するのに役立ちます。

さらに、コレクションに対して $search クエリを使用して、特定の /sites キーワードに一致するサイトを検索できます。すべての地域のすべてのサイトを一覧表示する場合は、「 getAllSites」を参照してください。

スキャン目的でサイト検出を使用するアプリケーションを構築する方法の詳細については、「ファイルを検出し、大規模な変更を検出するためのベストプラクティス」を参照してください。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

すべてのサイトコレクションを一覧表示する

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	サポートされていません。
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Sites.Read.All、Sites.ReadWrite.All

各地域のホームサイトを検出する

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Sites.Read.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Sites.Read.All、Sites.ReadWrite.All

HTTP 要求

organizationで使用可能なすべてのサイトを一覧表示するには:

GET /sites

organization内のすべてのルートレベルのサイトコレクションを一覧表示するには:

GET /sites?$filter=siteCollection/root ne null

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。

例

例 1: クエリパラメーターを使用してサイトを一覧表示する

要求

GET https://graph.microsoft.com/v1.0/sites?$select=siteCollection,webUrl&$filter=siteCollection/root%20ne%20null


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Sites.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "siteCollection","webUrl" };
	requestConfiguration.QueryParameters.Filter = "siteCollection/root ne null";
});



mgc sites list --filter "siteCollection/root ne null" --select "siteCollection,webUrl"



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphsites "github.com/microsoftgraph/msgraph-sdk-go/sites"
	  //other-imports
)


requestFilter := "siteCollection/root ne null"

requestParameters := &graphsites.SitesRequestBuilderGetQueryParameters{
	Select: [] string {"siteCollection","webUrl"},
	Filter: &requestFilter,
}
configuration := &graphsites.SitesRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
sites, err := graphClient.Sites().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SiteCollectionResponse result = graphClient.sites().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"siteCollection", "webUrl"};
	requestConfiguration.queryParameters.filter = "siteCollection/root ne null";
});


const options = {
	authProvider,
};

const client = Client.init(options);

let sites = await client.api('/sites')
	.filter('siteCollection/root ne null')
	.select('siteCollection,webUrl')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Sites\SitesRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new SitesRequestBuilderGetRequestConfiguration();
$queryParameters = SitesRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["siteCollection","webUrl"];
$queryParameters->filter = "siteCollection/root ne null";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->sites()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Sites

Get-MgSite -Property "siteCollection,webUrl" -Filter "siteCollection/root ne null"


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
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,
)

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

応答

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740",
      "name": "Contoso USA",
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com",
        "dataLocationCode": "NAM",
        "root": { }
      },
      "webUrl": "https://contoso.sharepoint.com"
    },
    {
      "id": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851851",
      "name": "Contoso Japan",
      "root": { },
      "siteCollection": {
        "hostname": "contoso-jp.sharepoint.com",
        "dataLocationCode": "JPN",
        "root": { }
      },
      "webUrl": "https://contoso-jp.sharepoint.com"
    }
  ]
}

例 2: すべてのサイトを一覧表示する

要求

GET https://graph.microsoft.com/v1.0/sites


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Sites.GetAsync();



mgc sites list



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
sites, err := graphClient.Sites().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SiteCollectionResponse result = graphClient.sites().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let sites = await client.api('/sites')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->sites()->get()->wait();


Import-Module Microsoft.Graph.Sites

Get-MgSite


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.sites.get()

応答

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "contoso.sharepoint.com,bf6fb551-d508-4946-a439-b2a6154fc1d9,65a04b8b-1f44-442b-a1fc-9e5852fb946c",
      "name": "Root Site",
      "isPersonalSite": false,
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com",
        "dataLocationCode": "NAM",
        "root": { }
      },
      "webUrl": "https://contoso.sharepoint.com"
    },
    {
      "id": "contoso.sharepoint.com,d9ecf079-9b13-4376-ac5d-f242dda55626,746dbcc1-fa2b-4120-b657-2670bae5bb6f",
      "name": "Site A",
      "isPersonalSite": false,
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com"
      },
      "webUrl": "https://contoso.sharepoint.com/sites/siteA"
    },
    {
      "id": "contoso.sharepoint.com,fd1a778f-263e-4c43-acdf-d5c2519d80eb,c06016db-dfec-4f79-83a1-09c6dbfd7022",
      "name": "Site B",
      "isPersonalSite": false,
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com"
      },
      "webUrl": "https://contoso.sharepoint.com/sites/siteB"
    }
  ]
}

次の方法で共有

サイトを一覧表示する

アクセス許可

すべてのサイトコレクションを一覧表示する

各地域のホームサイトを検出する

HTTP 要求

要求ヘッダー

例

例 1: クエリパラメーターを使用してサイトを一覧表示する

要求

応答

例 2: すべてのサイトを一覧表示する

要求

応答

フィードバック

その他のリソース

次の方法で共有

サイトを一覧表示する

アクセス許可

すべてのサイト コレクションを一覧表示する

各地域のホーム サイトを検出する

HTTP 要求

要求ヘッダー

例

例 1: クエリ パラメーターを使用してサイトを一覧表示する

要求

応答

例 2: すべてのサイトを一覧表示する

要求

応答

フィードバック

その他のリソース

すべてのサイトコレクションを一覧表示する

各地域のホームサイトを検出する

例 1: クエリパラメーターを使用してサイトを一覧表示する