Get-SPWeb

リファレンス

モジュール:: sharepoint-server

適用対象:: SharePoint Server Subscription Edition

特定の条件と一致するすべてのサブサイトを取得します。

構文

Get-SPWeb
   [[-Identity] <SPWebPipeBind>]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-Filter <ScriptBlock>]
   [-Limit <String>]
   [-Regex]
   [-Site <SPSitePipeBind>]
   [-WhatIf]
   [<CommonParameters>]

説明

Get-SPWeb コマンドレットでは、Identity パラメーターで指定した範囲と一致するすべてのサブサイトを取得します。条件と一致するすべてのサブサイトが取得されます。

Identity には、完全な URL または相対パスを指定できます。相対パスを指定する場合は、Site パラメーターも指定して、サブサイトの取得元のサイトコレクションを特定する必要があります。

Identity パラメーターには、ワイルドカード文字 (*) で終わる部分的な URL を指定することもできます。指定した範囲でこの部分的な URL と一致するすべてのサブサイトが取得されます。さらに、Regex パラメーターを指定した場合、Identity パラメーターは正規表現として扱われ、指定した範囲でこの式と一致する URL を持つすべてのサブ Web が取得されます。

Filter パラメーターは、コンテンツデータベースに格納されている特定のサブサイトプロパティのサーバー側フィルターです。Filter パラメーターがない場合、これらのプロパティに対するフィルター処理は遅いプロセスです。これらのサブサイトプロパティは Template と Title です。 Filter パラメーターは、Where-Object ステートメントと同じ構文を使用するスクリプトブロックですが、より高速な結果を得るにはサーバー側で実行されます。

Get-SPWeb コマンドレットで取得されたすべてのサイトコレクションは、パイプラインの最後で自動的に破棄されます。 Get-SPWeb の結果をローカル変数に格納するには、メモリリークを防ぐために Start-SPAssignment コマンドレットと Stop-SPAssignment コマンドレットを使用する必要があります。

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

例

-------------------- 例 1 ----------------------

Get-SPWeb -site https://sitename/sites/site1

この例では、特定のサイトコレクション内のすべてのサブ Web を取得します。

-------------------- 例 2 ----------------------

Get-SPWeb -Site https://sitename/sites/site1  -filter {$_.Template -eq "STS#0"}

この例では、"STS#0" テンプレートを使用するすべてのサブサイトを表示します。

-------------------- 例 3 ----------------------

Start-SPAssignment -Global
$w = Get-SPWeb https://sitename
$w.set_SiteLogoUrl("https://PathToImage/test.jpg")
$w.Update()
Stop-SPAssignment -Global

この例では、サブサイトを変数として保存し、 SPAssignment オブジェクトのオブジェクトモデルメソッドを呼び出す方法を示します。

パラメーター

-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 Subscription Edition

-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 Subscription Edition

-Filter

指定した範囲に対して使用するサーバー側のフィルターを指定します。

型は、{filterName <演算子> "filterValue"} という形式の有効なフィルターである必要があります。

Type:	ScriptBlock
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

サブサイトの名前、完全な URL、または部分的な URL を指定します。相対パスを使用する場合は、 Site パラメーターを指定する必要があります。

http://<サーバー名> という形式の有効な URL、または /SubSites/MySubSite という形式の相対パス。

Type:	SPWebPipeBind
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Limit

取得するサブサイトの最大数を制限します。既定値は 200 です。すべてのサイトを取得するには、「 ALL 」と入力します。

この型は、0 よりも大きい有効な数値または ALL であることが必要です。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Regex

Identity パラメーターで指定された URL が正規表現として扱われることを指定します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Site

サブサイトをリストするサイトコレクションの URL または GUID を指定します。

型は、 https://server_name有効な URL である必要があります。GUID は、フォーム 1234-5678-9807、または SPSite オブジェクトです。

Type:	SPSitePipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-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 Subscription Edition