Get-SPSite

リファレンス

モジュール:: sharepoint-server

適用対象:: SharePoint Server Subscription Edition

指定した条件と一致するすべてのサイトコレクションを取得します。

構文

Get-SPSite
   [-Identity] <SPSitePipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CompatibilityLevel <Int32>]
   [-Confirm]
   [-Filter <ScriptBlock>]
   [-Limit <String>]
   [-Regex]
   [-WhatIf]
   [<CommonParameters>]

Get-SPSite
   -ContentDatabase <SPContentDatabasePipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CompatibilityLevel <Int32>]
   [-Confirm]
   [-Filter <ScriptBlock>]
   [-Limit <String>]
   [-WhatIf]
   [-NeedsB2BUpgrade]
   [<CommonParameters>]

Get-SPSite
   -SiteSubscription <SPSiteSubscriptionPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CompatibilityLevel <Int32>]
   [-Confirm]
   [-Filter <ScriptBlock>]
   [-Limit <String>]
   [-WhatIf]
   [<CommonParameters>]

Get-SPSite
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CompatibilityLevel <Int32>]
   [-Confirm]
   [-Filter <ScriptBlock>]
   [-Limit <String>]
   [-WebApplication <SPWebApplicationPipeBind>]
   [-WhatIf]
   [<CommonParameters>]

説明

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

Get-SPSite コマンドレットでは、Identity パラメーターに一致する単一のサイト、または指定された範囲で Filter パラメーターに一致するすべてのサイトを取得します。範囲は、WebApplication パラメーター、ContentDatabase パラメーター、および SiteSubscription パラメーターで指定します。これらの範囲のいずれも指定しない場合の範囲はファームとなります。 Filter パラメーターを使用しないで範囲を指定した場合、この範囲に含まれるすべてのサイトが返されます。

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

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

LockState の有効な値は、Unlock、NoAdditions、ReadOnly、および NoAccess です。

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

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

例

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

Get-SPSite 'https://<site name>' | Get-SPWeb -Limit All | Select Title

次の使用例は、サイトコレクション内のサブ Web タイトルのコレクション https://< サイト名で取得します>。

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

Get-SPSite -ContentDatabase "b399a366-d899-4cff-8a9b-8c0594ee755f" | Format-Table -Property Url, Owner, SecondaryContact

この例では、コンテンツデータベース b399a366-d899-4cff-8a9b-8c0594ee755f 内のすべてのサイトからデータのサブセットを取得します。

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

Start-SPAssignment -Global
$s = Get-SPSite -Identity https://<MyApp>/Sites/Site1
$s.Url
Stop-SPAssignment -Global

この例では、Identity パラメーターで指定したサイトを取得し、その結果を変数 s に挿入します。

前の例では、割り当てコレクションの Global メソッドを使用しています。 Global メソッドは簡単に使用できますが、サイズが急激に大きくなります。グローバル割り当てが有効な場合、多数の結果を返す Get-SPSite コマンドは実行しないでください。

------------------ 例 4 ---------------------

$GC = Start-SPAssignment
$Sites = $GC | Get-SPSite -Filter {$_.Owner -eq "DOMAIN\JDow"} -Limit 50
Stop-SPAssignment $GC

この例では、サーバー側のクエリを使用して、ユーザー DOMAIN\JDow が所有する最初の 50 個のサイトを取得し、それをローカル変数に割り当てます。

この例では、高度な割り当てコレクションメソッドを使用しています。

------------------ 例 5 ---------------------

Get-SPWebApplication https://<site name> | Get-SPSite -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.Usage.Storage }{$sum}

この例では、指定した Web アプリケーションのすべてのサイトについてディスク領域の使用状況の集計結果を取得するコマンドを示します。

------------------ 例 6 ---------------------

Get-SPSite -Identity "https://localserver/(my|personal)/sites" -Regex

この例では、指定した正規表現と一致するすべてのサイトを取得します。

Regex パラメーターを使用する場合は、Identity パラメーターで引用符を使用する必要があります。

------------------ 例 7 ---------------------

Get-SPSite https://<site name>/sites/teams/* -Limit 100

この例では、URL の下にあるサイトの最大 100 個を取得します https://sitename/sites/teams.

------------------ 例 8 ---------------------

Get-SPSite | select url, @{Expression={$_.Usage.Storage}}

この例では、.UsageInfo プロパティの Storage フィールドを使用して、サイトコレクションによって使用されている記憶域の量を取得します。

------------------EXAMPLE 9---------------------

Get-SPSite -Limit all -CompatibilityLevel 14

次の使用例は、すべての SharePoint Server モードサイトコレクションを返します。

パラメーター

-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

-CompatibilityLevel

新しい SPSite オブジェクトを作成するとき、使用するテンプレートのバージョンを指定します。この値は、サイトコレクションの CompatibilityLevel の初期値を設定します。このパラメーターの値は、SharePoint Server または SharePoint Server のいずれかです。このパラメーターが指定されない場合、CompatibilityLevel は、SiteCreationMode 設定に基づいて、Web アプリケーションの最新なバージョンになります。

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

-ContentDatabase

サイトコレクションの一覧を取得するコンテンツデータベースの GUID を指定します。

この型は、SPContentDB01 という形式の有効なデータベース名であるか、または有効な GUID (12345678-90ab-cdef-1234-567890bcdefgh など) であることが必要です。

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

-Filter

適用するサーバー側フィルターのスクリプトブロックを指定します。

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

有効な演算子は、EQ、NE、LIKE、および NOTLIKE です。

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 または GUID を指定します。

この型は、http://<サーバー名> または http://<サーバー名>/sites/<サイト名> という形式の有効な URL であるか、有効な GUID (12345678-90ab-cdef-1234-567890bcdefgh など) であることが必要です。

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

-Limit

取得するサイトコレクションの最大数を指定します。既定値は 200 です。

この型は、負ではない有効な数値であることが必要です。 ALL を指定すると、指定範囲に該当するすべてのサイトコレクションが取得されます。

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

-NeedsB2BUpgrade

サイトをアップグレードする必要があるかどうかを指定します。

有効な値は True と False です。

Type:	SwitchParameter
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

-SiteSubscription

サイトコレクションを取得するサイト購読を指定します。

この型は、http://<サーバー名> という形式の有効な URL であるか、有効な GUID (12345678-90ab-cdef-1234-567890bcdefgh など) であることが必要です。

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

-WebApplication

サイトのリストを作成する URL、GUID、または Web アプリケーションの名前を指定します。

この型は、http://<サーバー名> という形式の有効な URL であるか、有効な GUID (12345678-90ab-cdef-1234-567890bcdefgh など) であるか、Web アプリケーションの名前 (WebApplication1212 など) であることが必要です。

Type:	SPWebApplicationPipeBind
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