Set-SPAppPrincipalPermission

  • リファレンス
モジュール:
SharePointServer
適用対象:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

特定のアプリケーション プリンシパルに対するアクセス許可を設定します。

構文

Set-SPAppPrincipalPermission
   -AppPrincipal <SPAppPrincipal>
   -Right <SPCmdletAppPrincipalPermissionKind>
   -Scope <SPCmdletAppPrincipalPermissionScope>
   -Site <SPWebPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-WhatIf]
   [-EnableAppOnlyPolicy]
   [<CommonParameters>]

説明

コマンドレットを Set-SPAppPrincipalPermission 使用して、特定のスコープ (テナント、サイト コレクション、Web) と特定のレベル (読み取り、書き込み、管理、フル コントロール) の特定のアプリ プリンシパルに対するアクセス許可を設定します。

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

例

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

$clientID = "11111111-2222-3333-4444-555555555555"
$site = Get-SPSite https://siteUrl
$realm = Get-SPAuthenticationRealm -ServiceContext $site
$appIdentifier = $clientID + "@" + $realm
$appPrincipal = Get-SPAppPrincipal -NameIdentifier $appIdentifier -Site $site.RootWeb
Set-AppPrincipalPermission -AppPrincipal $appPrincipal -Site $site.RootWeb -Scope Site -Level Manage

次の使用例は、サイトのスコープを持つ [管理] にアプリ プリンシパルのアクセス許可を設定します。

パラメーター

-AppPrincipal

AppPrincipal オブジェクトを指定します。

Type:SPAppPrincipal
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to: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 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 2013, SharePoint Server 2016, SharePoint Server 2019

-EnableAppOnlyPolicy

アプリ プリンシパルに対してアプリ専用ポリシーが有効かどうかを指定します。

有効な値は True と False です。 既定値は False です。

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

-Right

プリンシパル オブジェクトのアクセス許可レベルを指定します。

値は次のいずれかのレベルです。

--読む

--書き込み

--管理

--Full Control

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

-Scope

プリンシパル アクセス許可を適用するスコープを指定します。

値には、以下の範囲のいずれかを指定します。

--Site

--SiteCollection

--SiteSubscription

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

-Site

AppPrincipalPermission が設定されているサイト (つまり SPWeb オブジェクト) を指定します。

Type:SPWebPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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 2013, SharePoint Server 2016, SharePoint Server 2019