SharePoint Online のカスタムユーザープロファイルプロパティの一括更新

[アーティクル]
04/08/2023

Client Side Object Model (CSOM) バージョン (4622.1208 以降) の一部として、SharePoint にカスタムユーザープロファイルプロパティを一括インポートする機能が加わりました。これより前のリリースでは、唯一のオプションは、個々のユーザープロファイルに固有のプロパティを更新するためのユーザープロファイル CSOM 操作を活用することでした。ただし、このアプローチは非効率的で時間がかかりすぎます (特に、何千ものプロファイルを処理する場合)。

多数の企業がカスタム属性を SharePoint ユーザープロファイルサービスにレプリケートする必要があるため、さらに効率のよいユーザープロファイル一括 API (UserProfile.BatchUpdate.API) がリリースされました。

ユーザープロファイル一括更新プロセスの概要

UPA 一括更新フロー

次のリストで、ユーザープロファイル一括更新プロセスの流れを説明します。

ユーザー属性は、会社の Active Directory から Azure Active Directory (Azure AD) に同期されます。オンプレミスと Azure 間で、どの属性がレプリケートされるかを選択できます。
標準化された属性セットが Azure AD から Office 365 内の SharePoint Online ユーザープロファイルストアにレプリケートされます。オンプレミスの SharePoint とは異なり、これらの属性をカスタマイズすることはできません。
カスタム同期ツールで一括更新 API が利用されます。このツールは JSON ファイルを Office 365 テナントにアップロードし、インポートプロセスをキューに登録します。このツールは、マネージコード (.NET) を使用して実装することも、CSOM API を使用する PowerShell スクリプトとして実装することもできます。
基幹業務 (LOB) システムまたは任意の外部システムが JSON ファイル内の情報のソースです。これは Active Directory および任意の外部システムからのデータを組み合わせることもできます。 API の観点では、LOB システムをオンプレミスの SharePoint ファームにさえできることに注意してください。
SharePoint Online で実行しているすぐに使えるサーバー側タイマージョブが、キューに登録されたインポート要求をチェックして、API 呼び出しと付属の JSON ファイル内の情報に基づいて実際のインポート操作を実行します。
拡張ユーザープロファイル情報は、ユーザープロファイルから入手して、SharePoint Online のすぐに使える機能またはカスタム機能に使用できます。

注:

インポートは、エンドユーザーが編集できるように設定されていないユーザープロファイルプロパティにのみ機能します。これは、ユーザープロファイルのインポートプロセスによって、既にエンドユーザーが更新した情報が上書きされるのを防ぐためです。さらに、インポートは、Active Directory のコアプロパティではないカスタムプロパティのみを許可します。これらは、Azure AD と同期する必要があります。これらのコアディレクトリプロパティの一覧については、後述する FAQ セクションに記載されている表を参照してください。

マネージコード (.NET) と PowerShell の両方から CSOM API UserProfile.BatchUpdate.API を使用する方法を示す短いビデオを以下に示します。

ユーザープロファイルプロパティのインポートプロセス

完全なプロセスを以下に示します。

ユーザーを Office 365 テナントで作成するか、関連する Azure AD に同期します。
- ユーザーを Azure AD に同期すると、標準化された属性セットも SharePoint Online User Profile Service に同期されます。
User Profile Service 内で必要なすべてのカスタムプロパティを作成します。
- カスタムプロパティを User Profile Service で作成するリモート API は存在しないため、この手順は、カスタムユーザープロファイルプロパティが必要なテナントごとに手動で実行する必要があります (これはテナントごとに 1 回だけ実行する必要があります)。
- インポートできるのは “エンドユーザーによる編集が許可” されていないユーザープロファイルプロパティのみです。 JSON オブジェクトプロパティを “エンドユーザーによる編集が可能” とマークされているユーザープロファイルプロパティにインポートしようとすると、CSOM API が呼び出されたときに例外が発生します。
JSON ファイルを作成して Office 365 テナントにアップロードします。
- 更新対象の情報を含む JSON データファイルを Office 365 テナントにアップロードする必要があります。
- インポートプロセスで例外が発生した場合、同じドキュメントライブラリに保存される追加のログ情報が SharePoint によって提供されます。このライブラリでは、新しいサブフォルダーにファイルが保存されます。
- ログファイルと JSON ファイルのクリーニングは、自動的には行われず、API を使用したカスタムソリューションによって行われます。実装では、これらのファイルのライフサイクルについて検討する必要があります。これらのファイルはドキュメントライブラリに保存されるため、サイトコレクションに割り当てられたストレージの一部を消費することになります。
インポートジョブをキュー登録するための UPA 一括インポート API を呼び出します。
- CSOM API を使用してインポートプロセスをキューに登録します。これは、マネージコード (.NET) または PowerShell を使用して CSOM コードを実行することにより、実現されます。
- ジョブをキューに登録するメソッドには、プロパティマッピング情報とデータファイルの場所が必要です。実際のインポートプロセスがキューに登録されるため、このメソッドはすぐに実行されます。実際のインポートプロセスが、その後で、SharePoint Online のバックエンドプロセスの一部として実行されます。
インポートジョブの状態を確認します。
- また、リモート API を使用して、特定のインポートジョブまたは最近のインポートジョブのすべての状態を確認できます。特定のコールの状態を確認できるようにするには、ジョブがキューに登録されたときに返される値として受け取った一意のジョブ ID を格納する必要があります。

JSON ファイルを作成してアップロードする

インポートプロセスでは、プロパティとその値を含む JSON ファイルが使用されます。このファイルの予想構造を以下に示します。

{
   "value": [
     {
       "<IdName>": "<UserIdValue_1>",
       "<AttributeName_1>": "<User1_AttributeValue_1>",
       "<AttributeName_2>": "<User1_AttributeValue_2>",
     },
     {
       "<IdName>": "<UserIdValue_2>",
       "<AttributeName_1>": "<User2_AttributeValue_1>",
       "<AttributeName_2>": "<User2_AttributeValue_2>",
     },
     {
       "<IdName>": "<UserIdValue_n>",
       "<AttributeName_1>": "<Usern_AttributeValue_1>",
       "<AttributeName_2>": "<Usern_AttributeValue_2>",
     }
   ]
}

例

以前のサンプルの形式を使用した単純なファイルの例を以下に示します。この例では、ID 解決が IdName プロパティに基づいており、更新対象の City と Office という 2 つのプロパティがあります。ファイルには、テナント内の 4 つの異なるアカウントの情報が含まれています。コード内で正しいプロパティマッピングが指定されているため、ソースファイルで使用されるプロパティ名は、SharePoint Online User Profile Service で使用されているものと同じとは限りません。

{
  "value": [
    {
      "IdName": "vesaj@contoso.com",
      "City": "Helsinki",
      "Office": "Viper"
    },
    {
      "IdName": "bjansen@contoso.com",
      "City": "Brussels",
      "Office": "Beetle"
    },
    {
      "IdName": "unknowperson@contoso.com",
      "City": "None",
      "Office": ""
    },
    {
      "IdName": "erwin@contoso.com",
      "City": "Stockholm",
      "Office": "Elite"
    }
  ]
}

ソースデータファイルの制限

個々のソースデータファイルに対する制限を以下に示します。

最大ファイルサイズ: 2 GB
最大プロパティ数: 500,000
プロパティ値の円記号 () は、別の円記号でプリペンドしてエスケープする必要があります
ソースファイルはプロセスを開始する同じ SharePoint Online テナントにアップロードする必要があります

注:

更新ファイルの中に既定の西ヨーロッパ言語エンコード (iso-8859-1) に含まれない文字がある場合は、更新ファイルにバイトオーダーマーク (BOM) が指定されている必要があります。既定のエンコードでは各国語文字が正しく解釈されない場合があるため、UTF-8 エンコードを使用することをお勧めします。このエンコードの BOM は、16 進数で 'EF BB BF' です。これは、ファイルストリーム作成時にファイルのバイト配列の先頭に配置されます。テキストエディターを使用する場合、保存する前に、エンコードの種類として UTF-8 を選択してください。

インポートプロセスをキューに登録する

一括インポートプロセスの CSOM API は、Office365Tenant オブジェクトに配置された QueueImportProfileProperties メソッドを呼び出することにより、キューに登録することができます。これは非同期呼び出しのため、ソースデータがダウンロードされたり、インポートが実行されたりせず、単に後で実行する作業項目がキューに追加されるだけです。

メソッドの完全署名を以下に示します。

public ClientResult<Guid> QueueImportProfileProperties(
                          ImportProfilePropertiesUserIdType idType,
                          string sourceDataIdProperty,
                          IDictionary<string, string> propertyMap,
                          string sourceUri);

パラメーター

idType: ImportProfilePropertiesUserIdType

ユーザープロファイルを検索する場合に使用する ID の種類。使用可能な値は Email、CloudId、および PrincipalName です。種類に関係なく、インポートが機能するためには、ユーザーが User Profile Service 内に既に存在している必要があることに注意してください。一意性を確保するには、CloudId の値を使用することをお勧めします。

ID の種類と Azure AD プロパティ間のプロパティマッピング:

UPA 一括インポート ID の種類 Azure AD 属性

CloudId ObjectID

PrincipalName userPrincipalName

Email mail
sourceDataIdProperty: System.String

ソースデータ内の ID プロパティの名前。ソースデータからのプロパティの値がユーザーの検索に使用されます。検索に使用される User Profile Service プロパティは、idType の値に依存します。
propertyMap: IDictionary<string, string>

ソースプロパティ名から User Profile Service プロパティ名へのマップ。 User Profile Service プロパティは既に存在している必要があることに注意してください。キーはソースファイルで使用されるプロパティ名で、値は User Profile Service で使用されるプロパティ名です。
sourceUri: System.String

インポートするソースデータファイルの URI。しばらくたってからダウンロードが始まる可能性があるため、ファイルをすぐに移動または削除しないでください。

UPA 一括インポート ID の種類	Azure AD 属性
CloudId	ObjectID
PrincipalName	userPrincipalName
Email	mail

戻り値

キューに登録されたインポートジョブを識別する GUID。

例

以前のサンプル入力ファイルを使用することにより、プロセスを開始する C# を使用した例を以下に示します。

// Create an instance of the Office 365 Tenant object. Loading this object is not technically needed for this operation.
Office365Tenant tenant = new Office365Tenant(ctx);
ctx.Load(tenant);
ctx.ExecuteQuery();

// Type of user identifier ["PrincipalName", "Email", "CloudId"] in the
// user profile service. In this case, we use Email as the identifier at the UPA storage
ImportProfilePropertiesUserIdType userIdType =
      ImportProfilePropertiesUserIdType.Email;

// Name of the user identifier property within the JSON file
var userLookupKey = "IdName";

var propertyMap = new System.Collections.Generic.Dictionary<string, string>();

// The key is the property in the JSON file
// The value is the user profile property Name in the user profile service
// Notice that we have 2 custom properties in UPA called 'City' and 'OfficeCode'
propertyMap.Add("City", "City");
propertyMap.Add("Office", "OfficeCode");

// Returns a GUID that can be used to check the status of the execution and the end results
var workItemId = tenant.QueueImportProfileProperties(
      userIdType, userLookupKey, propertyMap, fileUrl
      );

ctx.ExecuteQuery();

インポートジョブの状態を確認する

CSOM API を使用して、User Profile Service インポートジョブの状態を確認することができます。テナントオブジェクトにはこのためのメソッドが 2 つあります。

個々のインポートジョブの状態を確認するには、GetImportProfilePropertyJob メソッドを使用します。
すべてのインポートジョブの状態を確認するには、GetImportProfilePropertyJobs メソッドを使用します。

個々のインポートジョブ

Office365Tenant オブジェクトに配置された GetImportProfilePropertyJob メソッドを使用することにより、個々のインポートジョブの状態を確認できます。このメソッドへのパラメーターとして、特定のインポートジョブの一意識別子を指定する必要があります。

メソッドの完全署名を以下に示します。

public ImportProfilePropertiesJobInfo GetImportProfilePropertyJob(Guid jobId);

パラメーター

jobID: System.Guid

全体的な状態を取得するジョブの ID。

戻り値

指定されたジョブに関する全体的な状態情報を含む ImportProfilePropertiesJobStatus オブジェクト。

例

保存された識別子を使用して、特定のインポートジョブの状態を取得する C# を使用した例を以下に示します。

// Check the status of a specific request based on the job id received when we queued the job
Office365Tenant tenant = new Office365Tenant(ctx);
var job = tenant.GetImportProfilePropertyJob(workItemId);
ctx.Load(job);
ctx.ExecuteQuery();

すべてのインポートジョブ

Office365Tenant オブジェクトに配置された GetImportProfilePropertyJobs メソッドを使用することにより、すべてのインポートジョブの状態を確認できます。

メソッドの完全署名を以下に示します。

public ImportProfilePropertiesJobStatusCollection GetImportProfilePropertyJobs();

パラメーター

インポートの状態情報とともに返される ImportProfilePropertiesJobInfo オブジェクトには、次のプロパティがあります。

JobId: System.Guid

インポートジョブの ID。
State: ImportProfilePropertiesJobState

次の値を持つ列挙型:
- Unknown - ジョブの状態を判断できません。
- Submitted - ジョブはシステムに送信されました。
- Processing - ジョブは処理中です。
- Queued - ジョブは検証に合格して、UPA へのインポート用のキューに登録されています。
- Succeeded - ジョブはエラーなしで完了しました。
- Error - ジョブがエラーで完了しました。
SourceUri: System.String

データソースファイルへの URI。
Error: ImportProfilePropertiesJobError

潜在的なエラーを表す列挙型:
- NoError - エラーは見つかりませんでした。
- InternalError - サービスの障害によりエラーが発生しました。
- DataFileNotExist - データソースファイルが見つかりませんでした。
- DataFileNotInTenant - データソースファイルが同じテナントに属していませんでした。
- DataFileTooBig - データファイルのサイズが大きすぎます。
- InvalidDataFile - データソースファイルが検証に合格しませんでした (ログファイルに追加の詳細が存在する場合があります)。
- ImportCompleteWithError - データはインポートされましたが、エラーが発生しました。
ErrorMessage: System.String

エラーメッセージ。
LogFileUri: System.String

ログの書き込み先フォルダーへの URI。

戻り値

各ジョブに関する全体的な状態情報を含む ImportProfilePropertiesJobStatus オブジェクトのコレクションである、ImportProfilePropertiesJobStatusCollection オブジェクト。

例

現在テナントに保存されているすべてのインポートジョブの状態を取得する C# を使用した例を以下に示します。これらのジョブは既に処理されているか、キューに登録されている可能性があります。

// Load all import jobs – old and queued ones
Office365Tenant tenant = new Office365Tenant(ctx);
var jobs = tenant.GetImportProfilePropertyJobs();
ctx.Load(jobs);
ctx.ExecuteQuery();
foreach (var item in jobs)
{
   // Check whatever properties needed
   var state = item.State;
}

PowerShell からインポート API を呼び出す

PowerShell を使用することにより、User Profile Service の一括インポート API を利用できます。つまり、PowerShell スクリプトで必要なパラメーターを指定して直接 CSOM コードを使用します。これには最新の CSOM 再頒布可能パッケージを、スクリプトを実行するコンピューターにインストールしておく必要があります。

PowerShell を使用すると、Visual Studio 内のコードをコンパイルする必要はありません。これは、一部の顧客にとってより適切なモデルとなる場合があります。

または、PnP PowerShell を使用して、システムに追加のライブラリをインストールしなくても、ユーザープロファイルサービスの一括インポート API を利用できます。

CSOM ライブラリを使用した PowerShell スクリプトの例

上記コードと同じ操作を実行する PowerShell スクリプトのサンプルを以下に示します。

# Get needed information from the end user
$adminUrl = Read-Host -Prompt 'Enter the admin URL of your tenant'
$userName = Read-Host -Prompt 'Enter your user name'
$pwd = Read-Host -Prompt 'Enter your password' -AsSecureString
$importFileUrl = Read-Host -Prompt 'Enter the URL to the file located in your tenant'

# Get instances to the Office 365 tenant using CSOM
$uri = New-Object System.Uri -ArgumentList $adminUrl
$context = New-Object Microsoft.SharePoint.Client.ClientContext($uri)

$context.Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userName, $pwd)
$o365 = New-Object Microsoft.Online.SharePoint.TenantManagement.Office365Tenant($context)
$context.Load($o365)

# Type of user identifier ["Email", "CloudId", "PrincipalName"] in the user profile service
$userIdType=[Microsoft.Online.SharePoint.TenantManagement.ImportProfilePropertiesUserIdType]::Email

# Name of user identifier property in the JSON
$userLookupKey="idName"

# Create property mapping between the source file property name and the Office 365 property name
# Notice that we have here 2 custom properties in UPA called 'City' and 'OfficeCode'
$propertyMap = New-Object -type 'System.Collections.Generic.Dictionary[String,String]'
$propertyMap.Add("City", "City")
$propertyMap.Add("Office", "OfficeCode")

# Call to queue UPA property import
$workItemId = $o365.QueueImportProfileProperties($userIdType, $userLookupKey, $propertyMap, $importFileUrl);

# Execute the CSOM command for queuing the import job
$context.ExecuteQuery();

# Output the unique identifier of the job
Write-Host "Import job created with the following identifier:" $workItemId.Value

PnP PowerShell を使用してSharePoint Online ユーザープロファイルの更新

ユーザープロファイルのプロパティを Azure Active Directory から SharePoint Online ユーザープロファイルに同期するには、PnP PowerShell コマンドレット Sync-PnPSharePointUserProfilesFromAzureActiveDirectory を利用できます。

または、別のソースからユーザープロファイルプロパティを同期する場合は、 New-PnPUPABulkImportJob を使用できます。

一括インポートジョブの処理状態を確認するには、Get-PnPUPABulkImportStatusを使用できます。

注:

PnP PowerShell はオープンソースソリューションであり、アクティブなコミュニティでサポートが提供されています。 Microsoft からのオープンソースツールのサポート SLA はありません。

例外の処理

この API を使用する場合の検証レベルは 2 つあります。 CSOM を使用してインポートプロセスをキューに登録した場合は、指定された値の初期レベルの検証が行われます。これには、指定されたマッピングプロパティが User Profile Service 内に存在し、エンドユーザーがこれらのプロパティを編集できないことの確認が含まれます。キュー API が呼び出されると、初期レベルの検証のみが適用され、指定した情報の最終検証は、インポートジョブが実際に実行されるときに実行されます。

実際のインポートジョブの実行中に例外が発生した場合は、追加の詳細を含むログファイルが、インポートファイルと同じドキュメントライブラリに生成されます。特定のインポートジョブのログファイルは、そのインポートジョブの一意識別子を使用して名前が付けられたサブフォルダーに保存されます。

インポートジョブの実行結果の例を以下に示します。次の図では、インポートファイルが保存されるドキュメントライブラリに作成された 2 つの異なる実行のための 2 つのサブフォルダーを確認できます。

ジョブ例外のサブフォルダー

実際のログファイルはサブフォルダーに保存され、詳細な分析のためにこれを Office 365 からダウンロードできます。

ジョブ例外のログファイル

一般的な例外

次の表に、User Profile Service 一括 API の使用を開始したときに発生する可能性がある一般的な例外を示します。

例外の例	詳細
プロパティ名 [AboutMe] はユーザーによる編集が可能です。	これは、ジョブをテナントへ送信する場合の ExecuteQuery メソッドを呼び出した場合に、CSOM API からスローされます。 API が、現在マッピングされているすべてのプロパティがユーザー編集不可になっていることを確認します。例外によって、使用できないプロパティが明らかになります。この例では、JSON プロパティを User Profile Service プロパティ内の AboutMe プロパティにマッピングしようとしていますが、AboutMe はユーザー編集可能なプロパティのため、これは許可されません。
InvalidProperty - vesaj@contoso.com プロパティ 'AboutMe' は、ユーザープロファイルアプリケーションのどのプロパティにもマップされません。	SharePoint Online 内の User Profile Service プロパティにマッピングされていないプロパティを含む JSON データファイル。つまり、ソースデータファイルには propertyMap パラメーターでマッピングが指定されなかったプロパティが含まれています。 JSON データオブジェクト内のプロパティごとに、マッピング定義が存在する必要があります。
MissingIdentity - ユーザーオブジェクトに ID がありません	ユーザーオブジェクトの ID プロパティが見つかりませんでした。最も可能性のある原因は、QueueImportProfileProperties メソッドの sourceDataIdProperty 属性が誤って設定されていることです。 JSON ソースファイルに正しいプロパティがあることと、コードまたはスクリプトでこの属性が適切に割り当てられていることを確認します。
IdentityNotResolvable unknown@contoso.com ユーザー ID を解決できません	データファイルに ID が含まれていますが、解決できなかったか、User Profile Service 内に存在しませんでした。この場合、電子メールの unknown@contoso.com 付いたユーザープロファイルをユーザープロファイルサービスに配置できませんでした。
DataFileNotJson - JsonToken EndObject は、JsonType 配列を閉じるには無効です。パス 'value', line 8, position 10.	インポートファイル形式が有効な JSON ではなく、予期された形式とも一致しません。

よく寄せられる質問

アプリ専用/アドイン専用のアクセス許可を使用してコードを実行できますか。

はい、ファイルの実際のインポートは呼び出し元の ID と同期して行われないため、これは問題なくアプリ専用コンテキストで機能します。

SharePoint アドインモデルでアプリ専用コンテキストを使用するには、このガイダンスに従って API を実行できるようにクライアント ID とシークレットを登録する必要があります。さらに、SharePoint アドインを登録するときに、次の XML スニペットを使用して権限を付与する必要があります。

<AppPermissionRequests AllowAppOnlyPolicy="true">
  <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
  <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="FullControl" />
</AppPermissionRequests>

重要

SharePoint Online 用の Azure ACS (Access Control Services) の使用は、2023 年 11 月 27 日の時点で廃止されました。詳細については、完全な廃止のお知らせをご覧ください。 SharePoint のコンテキストの外部で Azure ACS を使用することは、2018 年 11 月 7 日に既に廃止されており、現在は終了です。

廃止とは、機能が新しい投資を受け取ることを意味しますが、まだサポートされています。有効期間が終了すると、この機能は廃止され、使用できなくなります。

Azure Active Directory に登録されたアプリケーションでアプリ専用を使用するには、アプリケーションを登録し、認証用の X.509 証明書を提供する必要があります。これは、Azure Active Directory 内の SharePoint Online アプリ専用の認証の要件であり、アプリケーションの SharePoint Online アクセス許可スコープを付与します: Sites.FullControl.All および User.ReadWrite.All。

この API によって User Profile Service 内のプロパティは更新されますが、テナント内ではこれらのプロパティをどのように作成できますか。

カスタムユーザープロファイルプロパティをプログラムで作成するリモート API はないため、これは手動で操作し、指定のテナントごとに実行する必要があります。これらのカスタムプロパティを作成する方法については、「SharePoint Online でユーザープロファイルプロパティを追加して編集する」を参照してください。

この機能はオンプレミスの SharePoint で利用できますか。

この機能は、現時点では SharePoint Online 専用です。オンプレミスの SharePoint では、この機能があれば役立ちますが、オンプレミスの User Profile Service アプリケーションで属性マッピングを変更できるため、それほど重要ではありません。 SharePoint 2013 の Business Connectivity Service (BCS) を使用して、ユーザープロファイル属性をインポートすることもできます。ただし、このオプションは SharePoint 2016 では使用できません。つまり、現時点で SharePoint 2016 用の唯一のオプションは、ユーザープロファイル Web サービスを利用するカスタマイズを実装することです。

この API を使用して、オンプレミスの SharePoint ファームから SharePoint Online にユーザープロファイルのプロパティ値を同期できますか。

はい。他のソースシステムと同じようにオンプレミスの SharePoint を使用できます。ユーザープロファイル値をオンプレミスの SharePoint から JSON ファイル形式にエクスポートする必要があり、そのプロセスは任意の他のシステムから値をインポートする場合とまったく同じになります。

文字列に基づく複数値プロパティをインポートできますか。

いいえ。現在この API ではサポートされていません。

この API を実行するためにどんなアクセス許可が必要ですか。

アプリ専用の認証コンテキストを使用する場合を除き、現在、グローバル管理者権限が必要です。 SharePoint 管理者では十分ではありません。

分類に基づくプロパティをインポートできますか。

いいえ。現在この API ではサポートされていません。

使用されていないコードでマッピングを定義したり、マッピングされていない JSON ファイル内のプロパティを使用したりするとどうなりますか。

コードまたはスクリプトで使用されていないマッピングを定義した場合やデータファイルにそのマッピングのプロパティが含まれていない場合は、実行が例外なしで続行され、マッピングされたプロパティに基づいてインポートが適用されます。ただし、マッピングされていない JSON ファイル内にプロパティが存在する場合は、インポートプロセスが中断され、その特定のジョブ実行に関するログファイルに例外の詳細が記録されます。

この一括 API のサイズ制限を超える (つまり、2 GB のファイルまたは 500,000 個のプロパティを上回る) カスタムプロパティを更新する必要がある場合はどうなりますか。

複数のジョブを順にトリガーする (つまり、この API の上限までジョブを 1 回に 1 つずつ実行する) ことにより、ジョブを一括処理する必要があります。このような高帯域幅のインポートには、完了まで時間がかかることが予想されます。また、カスタムプロファイルプロパティでは、すべてのジョブの値セット全体をインポートするのではなく、変更の差分のみについてインポートジョブを最適化する必要があります。

既定では、どの Azure AD 属性が SharePoint Online ユーザープロファイルに同期されますか。

Azure AD と SharePoint Online User Profile Service の間で同期される属性とそのマッピングの公式なリストについては、次の表を参照してください。

Azure ディレクトリ属性	SharePoint Online のプロファイルプロパティ
ObjectSid	SPS-SavedSID
msonline-UserPrincipalName	UserName
msonline-UserPrincipalName	AccountName
msonline-UserPrincipalName	SPS-ClaimID
msonline-UserPrincipalName	SPS-UserPrincipalName
GivenName	FirstName
sn	LastName
Manager	Manager
DisplayName	PreferredName
telephoneNumber	WorkPhone
proxyAddresses	WorkEmail
proxyAddresses	SPS-SIPAddress
PhysicalDeliveryOfficeName	Office
Title	タイトル
Title	SPS-JobTitle
Department	Department
Department	SPS-Department
ObjectGuid	ADGuid
WWWHomePage	PublicSiteRedirect
DistinguishedName	SPS-DistinguishedName
msOnline-ObjectId	msOnline-ObjectId
PreferredLanguage	SPS-MUILanguages
msExchHideFromAddressList	SPS-HideFromAddressLists
msExchRecipientTypeDetails	SPS-RecipientTypeDetails
msonline-groupType	IsUnifiedGroup
msOnline-IsPublic	IsPublic
msOnline-ObjectId	msOnline-ObjectId
msOnline-UserType	SPS-UserType
GroupType	GroupType
SPO-IsSharePointOnlineObject	SPO-IsSPO

次の方法で共有

SharePoint Online のカスタムユーザープロファイルプロパティの一括更新

ユーザープロファイル一括更新プロセスの概要

ユーザープロファイルプロパティのインポートプロセス

JSON ファイルを作成してアップロードする

例

ソースデータファイルの制限

インポートプロセスをキューに登録する

パラメーター

戻り値

例

インポートジョブの状態を確認する

個々のインポートジョブ

パラメーター

戻り値

例

すべてのインポートジョブ

パラメーター

戻り値

例

PowerShell からインポート API を呼び出す

CSOM ライブラリを使用した PowerShell スクリプトの例

PnP PowerShell を使用してSharePoint Online ユーザープロファイルの更新

例外の処理

一般的な例外

よく寄せられる質問

アプリ専用/アドイン専用のアクセス許可を使用してコードを実行できますか。

この API によって User Profile Service 内のプロパティは更新されますが、テナント内ではこれらのプロパティをどのように作成できますか。

この機能はオンプレミスの SharePoint で利用できますか。

この API を使用して、オンプレミスの SharePoint ファームから SharePoint Online にユーザープロファイルのプロパティ値を同期できますか。

文字列に基づく複数値プロパティをインポートできますか。

この API を実行するためにどんなアクセス許可が必要ですか。

分類に基づくプロパティをインポートできますか。

使用されていないコードでマッピングを定義したり、マッピングされていない JSON ファイル内のプロパティを使用したりするとどうなりますか。

この一括 API のサイズ制限を超える (つまり、2 GB のファイルまたは 500,000 個のプロパティを上回る) カスタムプロパティを更新する必要がある場合はどうなりますか。

既定では、どの Azure AD 属性が SharePoint Online ユーザープロファイルに同期されますか。

関連項目

その他のリソース

次の方法で共有

SharePoint Online のカスタム ユーザー プロファイル プロパティの一括更新

ユーザー プロファイル一括更新プロセスの概要

ユーザー プロファイル プロパティのインポート プロセス

JSON ファイルを作成してアップロードする

例

ソース データ ファイルの制限

インポート プロセスをキューに登録する

パラメーター

戻り値

例

インポート ジョブの状態を確認する

個々のインポート ジョブ

パラメーター

戻り値

例

すべてのインポート ジョブ

パラメーター

戻り値

例

PowerShell からインポート API を呼び出す

CSOM ライブラリを使用した PowerShell スクリプトの例

PnP PowerShell を使用してSharePoint Online ユーザープロファイルの更新

例外の処理

一般的な例外

よく寄せられる質問

アプリ専用/アドイン専用のアクセス許可を使用してコードを実行できますか。

この API によって User Profile Service 内のプロパティは更新されますが、テナント内ではこれらのプロパティをどのように作成できますか。

この機能はオンプレミスの SharePoint で利用できますか。

この API を使用して、オンプレミスの SharePoint ファームから SharePoint Online にユーザー プロファイルのプロパティ値を同期できますか。

文字列に基づく複数値プロパティをインポートできますか。

この API を実行するためにどんなアクセス許可が必要ですか。

分類に基づくプロパティをインポートできますか。

使用されていないコードでマッピングを定義したり、マッピングされていない JSON ファイル内のプロパティを使用したりするとどうなりますか。

この一括 API のサイズ制限を超える (つまり、2 GB のファイルまたは 500,000 個のプロパティを上回る) カスタム プロパティを更新する必要がある場合はどうなりますか。

既定では、どの Azure AD 属性が SharePoint Online ユーザー プロファイルに同期されますか。

関連項目

その他のリソース

SharePoint Online のカスタムユーザープロファイルプロパティの一括更新

ユーザープロファイル一括更新プロセスの概要

ユーザープロファイルプロパティのインポートプロセス

ソースデータファイルの制限

インポートプロセスをキューに登録する

インポートジョブの状態を確認する

個々のインポートジョブ

すべてのインポートジョブ

この API を使用して、オンプレミスの SharePoint ファームから SharePoint Online にユーザープロファイルのプロパティ値を同期できますか。

この一括 API のサイズ制限を超える (つまり、2 GB のファイルまたは 500,000 個のプロパティを上回る) カスタムプロパティを更新する必要がある場合はどうなりますか。

既定では、どの Azure AD 属性が SharePoint Online ユーザープロファイルに同期されますか。