Set-SPProfileServiceApplication

User Profile Service アプリケーションのプロパティを設定します。

構文

Set-SPProfileServiceApplication
   [-Identity] <SPServiceApplicationPipeBind>
   [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-GetNonImportedObjects <Boolean>]
   [-MySiteHostLocation <SPSitePipeBind>]
   [-ProfileDBCredentials <PSCredential>]
   [-ProfileSyncDBCredentials <PSCredential>]
   [-ProfileSyncDBFailoverServer <String>]
   [-PurgeNonImportedObjects <Boolean>]
   [-SocialDBCredentials <PSCredential>]
   [-SocialDBFailoverServer <String>]
   [-Name <String>]
   [-UseOnlyPreferredDomainControllers <Boolean>]
   [-WhatIf]
   [-ProfileDBFailoverServer <String>]
   [<CommonParameters>]
Set-SPProfileServiceApplication
   [-Identity] <SPServiceApplicationPipeBind>
   [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-GetNonImportedObjects <Boolean>]
   -MySiteHostLocation <SPSitePipeBind>
   [-MySiteManagedPath <SPPrefixPipeBind>]
   [-ProfileDBCredentials <PSCredential>]
   [-ProfileSyncDBCredentials <PSCredential>]
   [-ProfileSyncDBFailoverServer <String>]
   [-PurgeNonImportedObjects <Boolean>]
   [-SiteNamingConflictResolution <String>]
   [-SocialDBCredentials <PSCredential>]
   [-SocialDBFailoverServer <String>]
   [-Name <String>]
   [-UseOnlyPreferredDomainControllers <Boolean>]
   [-WhatIf]
   [-ProfileDBFailoverServer <String>]
   [<CommonParameters>]

説明

このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。

Set-SPProfileServiceApplication コマンドレットでは、ユーザー プロファイル サービス アプリケーションのプロパティを設定します。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。

---------------例---------------------

$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'}
Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true

次の使用例は、ユーザー プロファイルのインポートのスコープ内にないプロファイル データベースからオブジェクトを消去します。

パラメーター

-ApplicationPool

サービス アプリケーション用の Web サービスを実行するための既存の IIS アプリケーション プールを指定します。

この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、アプリケーション プールの有効な名前 (AppPoolName1 など) であるか、有効な IISWebServiceApplicationPool オブジェクト インスタンスであることが必要です。

Type:SPIisWebServiceApplicationPoolPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Confirm

コマンドを実行する前に確認メッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-GetNonImportedObjects

インポート パイプラインから取得されておらず、削除対象としてマークされるユーザーに通知するかどうかを指定します。 削除対象としてマークされたユーザーの一覧がコンソール ウィンドウに表示されます。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

更新するユーザー プロファイル サービス アプリケーションを指定します。

この型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID であるか、購読設定サービス アプリケーションの有効な名前 (SubscriptionSettingsApp1 など) であるか、有効な SPServiceApplication オブジェクト インスタンスであることが必要です。

Type:SPServiceApplicationPipeBind
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-MySiteHostLocation

個人用サイトを設定するサイト コレクションを指定します。

型は、フォーム https://server_nameの有効な URL である必要があります。有効な GUID は、12345678-90ab-cdef-1234-567890bcdefgh、サイト サブスクリプションの有効な名前 (SiteSubscription1 など)、または有効な SiteSubscription オブジェクトのインスタンスです。

Type:SPSitePipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-MySiteManagedPath

個人用サイトの場所の管理パスを指定します。

型は、フォーム内の有効な URL である必要があります https://server_name.

Type:SPPrefixPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Name

新しいユーザー プロファイル サービス アプリケーションの表示名を指定します。 このファーム内で一意であるユーザー プロファイル サービス アプリケーションの名前を使用する必要があります。 名前の長さは、英数字で最大 128 文字です。

この型は、ユーザー プロファイル サービス アプリケーションの有効な名前 (UserProfileSvcApp1 など) であることが必要です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ProfileDBCredentials

このコマンドレットで作成するユーザー プロファイル データベースに接続するためのセキュリティ資格情報のセット (ユーザー名とパスワードなど) を指定します。

この型は、有効な PSCredential オブジェクトであることが必要です。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ProfileDBFailoverServer

プロファイル データベースのフェイルオーバー SQL Server の名前を指定します。 この名前は、プロファイル データベースの接続文字列を作成する際に使用されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ProfileSyncDBCredentials

ProfileSyncDBName パラメーターで指定したプロファイル同期データベースに接続するためのセキュリティ資格情報のセット (ユーザー名とパスワードなど) を指定します。

この型は、有効な PSCredential オブジェクトであることが必要です。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ProfileSyncDBFailoverServer

プロファイル データベースのフェイルオーバー SQL Server の名前を指定します。 この名前は、プロファイル データベースの接続文字列を作成する際に使用されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-PurgeNonImportedObjects

プロファイル ストアにインポートされていないユーザーを削除対象としてマークするかどうかを指定し、インポート パイプラインから取得されておらず、削除対象としてマークされるユーザーに通知します。 削除対象としてマークされたユーザーの一覧がコンソール ウィンドウに表示されます。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SiteNamingConflictResolution

個人用サイトに名前を付ける際に使用する形式を指定します。

次のいずれかの整数値を使用します。

1-個人用サイト コレクションは、競合解決なしでユーザー名に基づく必要があります。 たとえば、https://portal_site/location/username/ のように指定します。

2- 個人用サイト コレクションは、ドメイン名を使用して競合解決を行うユーザー名に基づく必要があります。 例: .../<ユーザー名>/ または .../<ドメイン ユーザー名>/

3 競合を回避するために、ドメインとユーザー名を常に使用して個人用サイト コレクションの名前を付ける必要があります。 たとえば、https://portal_site/location/domain_username/ のように指定します。

既定値は 1 (競合を解決しない) です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SocialDBCredentials

このコマンドレットで作成するソーシャル データベースに接続するためのセキュリティ資格情報のセット (ユーザー名とパスワードなど)。

この型は、有効な PSCredential オブジェクトであることが必要です。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SocialDBFailoverServer

ソーシャル データベースのフェイルオーバー SQL Server の名前を指定します。 この名前は、ソーシャル データベースの接続文字列を作成する際に使用されます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-UseOnlyPreferredDomainControllers

プロファイルの同期の通信を特定のドメイン コントローラーに制限します。

有効な値は、$True または $False です。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WhatIf

コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。 詳細については、次のコマンドを入力します。get-help about_commonparameters

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019