SharePoint モダン化スキャナーを使い始めるGetting started with the SharePoint modernization scanner

SharePoint モダン化スキャナーを使用すると、従来のサイトでモダン化の準備が行えます。Using the SharePoint Modernization scanner you can prepare your classic sites for modernization. スキャナーは、以下のモダン化の作業の準備を行います。The scanner will help you prepare for the following modernization efforts:

  • モダン リストとライブラリの使用状況の最適化Optimizing the usage of modern list and libraries
  • これらのサイトを Office 365 のグループに接続するConnecting these sites to an Office 365 group
  • モダン サイト ページを作成して Wiki ページと Web パーツ ページをモダン化するModernizing the wiki and web part pages by creating modern site pages
  • クラシック発行ポータルをモダン発行ポータルとして再構築するRebuilding classic publishing portals as modern publishing portals

このスキャナーは、サイトをモダン化する場合の難易度を実際のデータで示すことができるため、クラシック サイトをモダン化する準備のために使用する中心的なツールです。This scanner is a key tool to use if you want to prepare for modernizing your classic sites as it will give you factual data about how easy it is to modernize your sites. スキャナーで生成されたダッシュボードを使用すると、サイトの「モダン化の準備状態」を正確に把握し、必要な対策の計画を適宜立てることができます。Using the dashboards generated by the scanner you'll be able to drill down on the "modernization readiness" of your sites and plan the needed remediation work where needed.

注意

SharePoint モダン化スキャナーは、SharePoint Online に対して実行するためにのみサポートされています。The SharePoint modernization scanner only is supported for running against SharePoint Online.

手順 1: SharePoint モダン化スキャナーの最新バージョンを入手するStep 1: Get the latest version of the SharePoint modernization scanner

SharePoint Online はより多くのモダン機能を追加しながら継続的に進化しているため、スキャナーの最新バージョンを常時ダウンロードする必要があります。Since SharePoint Online continuously evolves and more and more modern capabilities are added it's important to always download the latest version of the scanner. ダウンロードは次の手順で簡単に行えます。Downloading is as simple as:

手順 2: スキャンの準備Step 2: Preparing for a scan

一般的なスキャンでは、すべてのサイト コレクションをスキャンする必要があるため、テナント スコープのアクセス許可を持つアプリ専用プリンシパルを使用してスキャンすることをお勧めします。Since a typical scan needs to be able to scan all site collections it's recommended to use an app-only principal with tenant scoped permissions for the scan. この方法を使うと、スキャナーはすべてのサイトに確実アクセスできます。アカウント (例: SharePoint テナント管理者アカウント) を使用する場合は、スキャナーがアクセスできるサイトはこのアカウントがアクセスできるサイトに限られます。  This approach will ensure the scanner always has access, if you use an account (e.g. your SharePoint tenant admin account) then the scanner can only access the sites where this user also has access. アプリ専用アクセス許可を付与するには、Azure AD アプリケーションまたは SharePoint アプリケーション プリンシパルを使用できます。You can either use a an Azure AD application or a SharePoint app principal for app-only access:

準備作業が完了したら、スキャンの実行に進みます。Once the preparation work is done, let's continue with doing a scan.

手順 3: ユーザー インターフェイスのオプションを使用してスキャンを起動するStep 3: Launch a scan using the user interface option

最も簡単な方法は、スキャナーに備わっている UI を使用して SharePoint.Modernization.Scanner.exe を起動する方法です。The easiest approach is to simply launch SharePoint.Modernization.Scanner.exe as the scanner does have a UI. 別の方法として、(PowerShell) コマンド プロンプトを起動して同フォルダーに移動し、コマンド ラインでスキャナーを使用する方法もあります。Alternatively you can start a (PowerShell) command prompt and navigate to that folder so that you can use the scanner via command line. この章では、UI を使用して標準的なフル スキャンを行う手順を説明します。This chapter will walk you through the UI option taking a typical full scan. 最初に、SharePoint.Modernization.Scanner.exe を起動します。Start by launching the the SharePoint.Modernization.Scanner.exe.

1 ページ目: スキャナー認証の構成Page 1: Scanner authentication configuration

Azure AD アプリ専用経由での認証Authenticate via Azure AD app-only

モダン化スキャナー ウィザードの最初のページで、認証情報を求められます。The first page of the modernization scanner wizard asks you for authentication information. スキャナーでは 3 つのオプションが利用可能です。次に示すように、目的のオプションを選択して必要な情報を入力します。The scanner supports three options, select the one you need and fill in the needed information as described below. スキャンする必要があるサイトすべてにスキャナーがアクセスできるように、アプリ専用モデルの使用をお勧めします。Note that ideally you use an app-only model as that will ensure the scanner has access to all sites it needs to scan.

Azure AD アプリ専用

Azure AD アプリ専用経由でアクセス権を設定した場合、Azure アプリが作成され、アクセスの証明書が構成されます。If you've setup access via Azure AD App-Only you do have created an Azure App and configured a certificate for accessing it. この情報をツールに提供する必要がありあります。This information needs to be provided to the tool:

  • Azure AD アプリケーション ID: Azure AD 環境で作成されたアプリケーションの IDAzure AD Application ID: ID of the created application in your Azure AD environment
  • Azure AD ドメイン名: Azure AD 環境の既定のドメイン。Azure AD Domain name: the default domain of your Azure AD environment. この情報は、Azure AD 管理ポータルの [概要] ページから確認することができます。You can find this from the overview page of the Azure AD management portal
  • 証明書ファイル: Azure AD に対してアプリ専用アクセスを許可する証明書。証明書ファイルは、パスワード保護された PFX ファイルとして提供する必要があります。Certificate file: the certificate that you granted app-only access to the Azure AD app, this needs to be presented as a password protected PFX file
  • PFX ファイルのパスワード: 以前に提供した PFX ファイルを保護するために使用したパスワードPassword for the PFX file: the password used to secure the previously provided PFX file

SharePoint AD アプリ専用経由での認証Authenticate via SharePoint AD app-only

SharePoint アプリ専用

従来型の SharePoint アプリ専用を使用する方法を選択した場合は、次の情報を指定する必要があります。In case you used the "classic" SharePoint App-Only approach then you need to specify:

  • Azure ACS クライアント ID: 作成されたアプリ専用プリンシパルの IDAzure ACS Client ID: the ID of the created app-only principal
  • Azure ACS クライアント シークレット: アプリケーション プリンシパルを作成したときに取得したシークレットAzure ACS Client Secret: the secret that you got when you created the app principal

資格情報による認証Authenticate via credentials

資格情報 標準のユーザー名とパスワードの組み合わせを使用します (提供したユーザーが必要なアクセス許可を持っていることが前提です)。Credentials Using a regular user/password combo works fine as well, assuming the provided user does have the needed permissions

2 ページ目: スキャナーのサイト範囲の構成Page 2: Scanner site scope configuration

テナント全体をスキャンするScan full tenant

このページでは、スキャン対象のサイトを定義できます。This page allows you to define which sites are being scanned. スキャナーでは、テナント全体のスキャンから、個別に選択したサイト コレクションのスキャンまでサポートされています。The scanner supports scanning the full tenant up to individually selected site collections.

テナント全体

テナントの完全なスキャンを行うとモダン化レポートが作成されるため、多くの場合この方法が推奨されます。Scanning the complete tenant is often the recommended approach as that will give you modernization reports for all. この方法を選択する場合は、テナント名を入力するだけで済みます。If that's your choice then simply fill your tenant name. テナントが "sharepoint.com" で終わらない URL を使用している場合はこの方法は利用できません。該当する場合は、以下の 2 つの方法のうちいずれかを使用する必要があります。Note that this approach does not work if you're tenant is using URL's that do not end on sharepoint.com, if that's the case you need to use one of the two below options.

定義されたサイト コレクションの一覧をスキャンするScan a defined list of site collections

ワイルドカード URL

このオプションでは、次のうちどちらかを提供して 1 つまたは複数のサイト コレクションを選択できます。This option makes it possible to select one or more site collections by either providing

  • スキャン対象のサイト コレクションの完全修飾 URLThe fully qualified URL of the site collection(s) that need need(s) to be scanned
  • ワイルドカード URL: アスタリスクで終わる URL を追加すると、そのフィルターに一致するすべてのサイトを含められます。A wildcard URL: by adding an URL that ends on an star you'll include all sites that match that filter. アスタリスクで終わるワイルドカード URLのみを利用できます。Only ending on an star is a supported wildcard

"sharepoint.com" で終わらない URL (いわゆる、「バニティ URL」) を使用する場合、テナント管理センター サイトの URL も指定する必要があります。(例: https://admin-sharepoint.contoso.com).)If you're using URL's that do not end on sharepoint.com (so called vanity URL's) you'll also need to specify the URL of your tenant admin center site (e.g. https://admin-sharepoint.contoso.com).

CSV ファイルで定義されているサイト コレクションの一覧をスキャンするScan a list of site collections defined in a CSV file

CSV ファイル

3 番目のオプションでは、スキャン対象のサイト コレクションを一覧表示する CSV ファイルをスキャナーに提供します。As a third option you can provide the scanner with a CSV file listing the site collections to scan.

3 ページ目: スキャナー モードの構成Page 3: Scanner mode configuration

SharePoint モダン化スキャナーでは複数のモードが利用できます。モダン化のモードの合わせて、スキャンする範囲を一部の場所に限ったり、または単純に全体をスキャンしたりできます。The SharePoint modernization scanner does support multiple modes, depending on your modernization mode you might want to scope the scan to a certain area or alternatively simply do a full scan.

スキャナー モード

ドロップダウン リストで目的のオプションを選択すると、選択したスキャンに含まれるコンポーネントのチェック ボックスがオンになります。Select the option you want in the dropdown and then the checkboxes will show which components will be included in the scan. なお、「Office 365 グループ接続の準備状態」コンポーネントは中心的なコンポーネントであるため、すべてのスキャン モードに含まれます。Note that the "Office 365 Group connection readiness" component is the main component which will be included all scan modes.

4 ページ目: スキャナーのオプションPage 4: Scanner options

最後のステップでは、スキャナー オプションの詳細を調整することができます。As a last step you can tweak the scanner options. 先ほど選択したスキャナーのモードによっては、一部のオプションが無効になっている場合があります。Depending on the earlier chosen scanner mode some options might be disabled.

スキャナーのオプション

次のスキャン オプションが使用できます。Following scan options are available:

  • スレッド数: 実行されるスキャンはマルチ スレッドで既定値は 10ですが、大規模なスキャンではスレッド数を 20 - 30 にするとパフォーマンスが上がります (効果にばらつきがある場合があります)Number of threads: the scan is multi-threaded, default is 10 but for larger scans 20-30 threads delivers a better scan performance (your mileage might vary)
  • 検索を使用しない: ページやサイトの使用状況の情報が必要ない場合は、このオプションを選択できます。Don't use search: if you're not interested in page/site usage information then you can select this option. サイト コレクションごとに検索クエリが 1 つ減るので、スキャンがわずかに高速化します。As this removes one search query per site collection it will make the scan slightly faster
  • ユーザー情報を含めない: 作成されたデータにユーザー情報 (ユーザー名) 表示する必要がない場合はこのボックスをオンにします。Don't include user information: check this box if you're not interested in seeing user information (user names) as part of the produced data
  • 除外リスト: [モダン リストとライブラリ エクスペリエンス] スキャンでは、アウトオブボックス に関する理由だけでブロックされているリストを除外することができます。Exclude lists: For the "Modern list and library experience" scan you can exclude lists which are only blocked due to an OOB reason
  • ページの詳細をエクスポート: Web パーツの詳細情報 (Web パーツ プロパティ) のデータセットは巨大になる場合があるので、既定ではスキャンからエクスポートされません。Export page details: By default the scan is not exporting detailed web part information (web part properties) as that dataset can be huge. Web パーツ オプションの完全なデータが必要な場合は、このボックスをオンにします。Check this box if you would like to have the full web part option data
  • レポートを生成しない: 既定では、スキャンは Excel ベースのダッシュボードを出力しますが、生の CSV ファイルのみが必要な場合は、Excel レポートを省略できます。Don't generate reports: by default you get Excel based dashboards as scan output, but you can skip these if you're only interested in the raw CSV files
  • フィードバックを無効にする: スキャナーは、スキャナーの性能を向上させる目的で Microsoft に匿名のフィードバックを送信します。Disable feedback: the scanner will send anonymous feedback to Microsoft to help improve the scanner. 希望しない場合は、このボックスをオンにします。If you don't like that then feel free to check this box
  • 区切り記号: 生成された CSV ファイルの既定の区切り記号はコンマですが、希望する場合はこれをセミコロンに変更できます。Separator: the default separator for the generated CSV files is a comma, but you can change this to semi-colon if you would prefer that

手順 4: コマンドラインを使用してスキャンを起動するStep 4: Launch a scan using command line

以下に、ほとんどのお客様にご利用いただける、ツールの既定の使用方法を示します。モード、テナント名、作成されたクライアント ID、およびシークレットを指定します。Below option is the default usage of the tool for most customers: you specify the mode, your tenant name and the created client id and secret:

SharePoint.Modernization.Scanner.exe -t <tenant> -i <clientid> -s <clientsecret>

実例:A real life sample:

SharePoint.Modernization.Scanner.exe -t contoso -i 7a5c1615-997a-4059-a784-db2245ec7cc1 -s eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=

上記の使い方ではスキャンのオプションがすべて実行されますが、Modeパラメーター (-m) を使用してスキャンの対象を絞ることもできます。The above use will run all scanning options, but you can also target the scan via the Mode parameter (-m):

SharePoint.Modernization.Scanner.exe -m <mode> -t <tenant> -i <clientid> -s <clientsecret>

実例:A real life sample:

SharePoint.Modernization.Scanner.exe -m GroupifyOnly -t contoso -i 7a5c1615-997a-4059-a784-db2245ec7cc1 -s eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=

利用できるスキャナー モードSupported scanner modes

モードMode 説明Description
Full すべてのコンポーネントが含まれます。-m を省略しても同じ結果が得られます。All components will be included, omitting -m has the same result
GroupifyOnly Office 365 グループ接続の準備状態コンポーネントのみを使用します。このコンポーネントは、各スキャンの一部です。Only use the Office 365 group connection readiness component, this component is part of each scan
ListOnly リストの詳細スキャンおよび Office 365 グループ接続の準備状態コンポーネントが含まれます。Includes a deep list scan + includes the Office 365 group connection readiness component
PageOnly Wiki ページ と Web パーツ ページのスキャンおよび Office 365 グループ接続の準備状態コンポーネントが含まれます。Includes a scan from wiki and web part pages + includes the Office 365 group connection readiness component
PublishingOnly サイト レベルおよび Web レベルでのクラシック発行ポータルのスキャンおよび Office 365 グループ接続の準備状態コンポーネントが含まれます。Includes a classic publishing portal scan at site and web level + includes the Office 365 group connection readiness component
PublishingWithPagesOnly サイト レベル、Web レベル、およびページ レベルでのクラシック発行ポータルのスキャンおよび Office 365 グループ接続の準備状態コンポーネントが含まれます。Includes a classic publishing portal scan at site,web and page level + includes the Office 365 group connection readiness component

コマンド ライン パラメーターの概要Command line parameter overview

SharePoint PnP Modernization scanner 2.2.0.0
Copyright (C) 2018 SharePoint PnP
==========================================================

See the sp-dev-modernization repo for more information at:
https://github.com/SharePoint/sp-dev-modernization/tree/master/Tools/SharePoint.Modernization

Let the tool figure out your urls (works only for SPO MT):
==========================================================
Using Azure AD app-only:
SharePoint.Modernization.Scanner.exe -t <tenant> -i <your client id> -z <Azure AD domain> -f <PFX file> -x <PFX file
password>
e.g. SharePoint.Modernization.Scanner.exe -t contoso -i e5808e8b-6119-44a9-b9d8-9003db04a882 -z conto.onmicrosoft.com
-f apponlycert.pfx -x pwd

Using app-only:
SharePoint.Modernization.Scanner.exe -t <tenant> -i <your client id> -s <your client secret>
e.g. SharePoint.Modernization.Scanner.exe -t contoso -i 7a5c1615-997a-4059-a784-db2245ec7cc1 -s
eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=

Using credentials:
SharePoint.Modernization.Scanner.exe -t <tenant> -u <your user id> -p <your user password>

e.g. SharePoint.Modernization.Scanner.exe -t contoso -u spadmin@contoso.onmicrosoft.com -p pwd

Specifying url to your sites and tenant admin (needed for SPO with vanity urls):
================================================================================
Using Azure AD app-only:
SharePoint.Modernization.Scanner.exe -r <wildcard urls> -a <tenant admin site>  -i <your client id> -z <Azure AD
domain> -f <PFX file> -x <PFX file password>
e.g. SharePoint.Modernization.Scanner.exe -r "https://teams.contoso.com/sites/*,https://my.contoso.com/personal/*" -a
https://contoso-admin.contoso.com -i e5808e8b-6119-44a9-b9d8-9003db04a882 -z conto.onmicrosoft.com  -f apponlycert.pfx
-x pwd

Using app-only:
SharePoint.Modernization.Scanner.exe -r <wildcard urls> -a <tenant admin site> -i <your client id> -s <your client
secret>
e.g. SharePoint.Modernization.Scanner.exe -r "https://teams.contoso.com/sites/*,https://my.contoso.com/personal/*" -a
https://contoso-admin.contoso.com -i 7a5c1615-997a-4059-a784-db2245ec7cc1 -s
eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=

Using credentials:
SharePoint.Modernization.Scanner.exe -r <wildcard urls> -a <tenant admin site> -u <your user id> -p <your user
password>
e.g. SharePoint.Modernization.Scanner.exe -r "https://teams.contoso.com/sites/*,https://my.contoso.com/personal/*" -a
https://contoso-admin.contoso.com -u spadmin@contoso.com -p pwd


  -m, --mode                               (Default: Full) Execution mode. Use following modes: full, GroupifyOnly,
                                           ListOnly, PageOnly, PublishingOnly, PublishingWithPagesOnly. Omit or use
                                           full for a full scan

  -b, --exportwebpartproperties            (Default: False) Export the web part property data

  -c, --skipusageinformation               (Default: False) Don't use search to get the site/page usage information and
                                           don't export that data

  -j, --skipuserinformation                (Default: False) Don't include user information in the exported data

  -k, --skiplistsonlyblockedbyoobreaons    (Default: False) Exclude lists which are blocked due to out of the box
                                           reasons: base template, view type of field type

  -d, --skipreport                         (Default: False) Don't generate an Excel report for the found data

  -g, --exportpaths                        List of paths (e.g. c:\temp\636529695601669598,c:\temp\636529695601656430)
                                           containing scan results you want to add to the report

  -n, --disabletelemetry                   (Default: False) We use telemetry to make this a better tool...but you're
                                           free to disable that

  -i, --clientid                           Client ID of the app-only principal used to scan your site collections

  -s, --clientsecret                       Client Secret of the app-only principal used to scan your site collections

  -u, --user                               User id used to scan/enumerate your site collections

  -p, --password                           Password of the user used to scan/enumerate your site collections

  -z, --azuretenant                        Azure tenant (e.g. contoso.microsoftonline.com)

  -f, --certificatepfx                     Path + name of the pfx file holding the certificate to authenticate

  -x, --certificatepfxpassword             Password of the pfx file holding the certificate to authenticate

  -a, --tenantadminsite                    Url to your tenant admin site (e.g. https://contoso-admin.contoso.com): only
                                           needed when your not using SPO MT

  -t, --tenant                             Tenant name, e.g. contoso when your sites are under
                                           https://contoso.sharepoint.com/sites. This is the recommended model for
                                           SharePoint Online MT as this way all site collections will be scanned

  -r, --urls                               List of (wildcard) urls (e.g.
                                           https://contoso.sharepoint.com/*,https://contoso-my.sharepoint.com,https://co
                                           ntoso-my.sharepoint.com/personal/*) that you want to get scanned

  -o, --includeod4b                        (Default: False) Include OD4B sites in the scan

  -v, --csvfile                            CSV file name (e.g. input.csv) which contains the list of site collection
                                           urls that you want to scan

  -h, --threads                            (Default: 10) Number of parallel threads, maximum = 100

  -e, --separator                          (Default: ,) Separator used in output CSV files (e.g. ";")

  --help                                   Display this help screen.