Set-SPAppPrincipalPermission
特定のアプリケーション プリンシパルに対するアクセス許可を設定します。
構文
Default (既定)
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
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
AppPrincipal オブジェクトを指定します。
パラメーターのプロパティ
| 型: | SPAppPrincipal |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AssignmentCollection
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。
Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
パラメーターのプロパティ
| 型: | SPAssignmentCollection |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
コマンドを実行する前に確認メッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EnableAppOnlyPolicy
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
アプリ プリンシパルに対してアプリ専用ポリシーが有効かどうかを指定します。
有効な値は True と False です。 既定値は False です。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Right
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
プリンシパル オブジェクトのアクセス許可レベルを指定します。
値は次のいずれかのレベルです。
--Read
--write
--管理
--フルコントロール
パラメーターのプロパティ
| 型: | SPCmdletAppPrincipalPermissionKind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
プリンシパル アクセス許可を適用するスコープを指定します。
値には、以下の範囲のいずれかを指定します。
--Site
--SiteCollection
--SiteSubscription
パラメーターのプロパティ
| 型: | SPCmdletAppPrincipalPermissionScope |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Site
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
AppPrincipalPermission が設定されるサイト (つまり、SPWeb オブジェクト) を指定します。a
パラメーターのプロパティ
| 型: | SPWebPipeBind |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。