Get-SPSite
Возвращает все семейства веб-сайтов, удовлетворяющие заданному условию.
Синтаксис
AllSitesInIdentity
Get-SPSite
[-Identity] <SPSitePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-CompatibilityLevel <Int32>]
[-Confirm]
[-Filter <ScriptBlock>]
[-Limit <String>]
[-Regex]
[-WhatIf]
[<CommonParameters>]
AllSitesInContentDB
Get-SPSite
-ContentDatabase <SPContentDatabasePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-CompatibilityLevel <Int32>]
[-Confirm]
[-Filter <ScriptBlock>]
[-Limit <String>]
[-WhatIf]
[-NeedsB2BUpgrade]
[<CommonParameters>]
AllSitesInSiteSubscription
Get-SPSite
-SiteSubscription <SPSiteSubscriptionPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-CompatibilityLevel <Int32>]
[-Confirm]
[-Filter <ScriptBlock>]
[-Limit <String>]
[-WhatIf]
[<CommonParameters>]
AllSitesInWebApplication
Get-SPSite
[-AssignmentCollection <SPAssignmentCollection>]
[-CompatibilityLevel <Int32>]
[-Confirm]
[-Filter <ScriptBlock>]
[-Limit <String>]
[-WebApplication <SPWebApplicationPipeBind>]
[-WhatIf]
[<CommonParameters>]
Описание
Этот командлет содержит несколько наборов параметров. Можно использовать параметры только из одного набора параметров; использование параметров из разных наборов не допускается. Дополнительные сведения об использовании наборов параметров см. в статье Наборы параметров командлета.
Командлет Get-SPSite возвращает один сайт, соответствующий параметру Identity, или все сайты, соответствующие параметру Filter для заданной области. Область задается параметрами WebApplication, ContentDatabase и SiteSubscription. Если не указан ни один из них, областью является ферма. Если область указана без параметра фильтра Filter, возвращаются все сайты в данной области.
В параметре Identity можно указать частичный URL-адрес, заканчивающийся подстановочным знаком (*). Возвращаются все семейства сайтов, соответствующие этому частичному URL-адресу, для заданной области. Кроме того, если указан параметр Regex, параметр Identity считается регулярным выражением и возвращаются все семейства сайтов с указанным URL-адресом в заданной области, соответствующие этому выражению.
Параметр Filter — это серверный фильтр для определенных свойств семейства веб-сайтов, хранящихся в базе данных контента. Без параметра Filter фильтрация по этим свойствам выполняется медленно. Эти свойства семейства веб-сайтов: Owner, SecondaryOwner и LockState. Параметр Filter — это блок скрипта, который использует тот же синтаксис, что и инструкция Where-Object, но выполняется на сервере для ускорения результатов.
Возможные значения свойства LockState: Unlock, NoAdditions, ReadOnly и NoAccess.
Важно помнить, что все результаты (семейства веб-сайтов), возвращаемые командлетом Get-SPSite, автоматически удаляются в конце конвейера. Чтобы сохранить результаты командлета Get-SPSite в локальной переменной, необходимо использовать командлеты Start-SPAssignment и Stop-SPAssignment, позволяющие избежать утечек памяти.
Сведения о разрешениях и актуальную информацию о Windows PowerShell для продуктов SharePoint см. в сетевой документации о командлетах SharePoint Server.
Примеры
ПРИМЕР 1
Get-SPSite 'https://<site name>' | Get-SPWeb -Limit All | Select Title
В этом примере возвращается коллекция заголовков вложенных веб-сайтов в семействе веб-сайтов с именем> https://< сайта.
ПРИМЕР 2
Get-SPSite -ContentDatabase "b399a366-d899-4cff-8a9b-8c0594ee755f" | Format-Table -Property Url, Owner, SecondaryOwner
В этом примере возвращается подмножество данных со всех сайтов в базе данных контента 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
В этом примере с помощью серверного запроса возвращаются первые 50 сайтов, владельцем которых является пользователь DOMAIN\JDow, а результаты присваиваются локальной переменной.
В примере используются расширенные методы семейства назначений.
ПРИМЕР 5
Get-SPWebApplication https://<site name> | Get-SPSite -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.Usage.Storage }{$sum}
В этом примере показана команда, возвращающая суммарный объем используемого дискового пространства для всех сайтов в заданном веб-приложении.
ПРИМЕР 6
Get-SPSite -Identity "https://localserver/(my|personal)/sites" -Regex
В этом примере возвращаются все сайты, соответствующие заданному регулярному выражению.
Кавычки в параметре Identity необходимы, когда используется параметр Regex.
ПРИМЕР 7
Get-SPSite https://<site name>/sites/teams/* -Limit 100
В этом примере по URL-адресу показано до 100 сайтов. https://sitename/sites/teams.
ПРИМЕР 8
Get-SPSite | select url, @{Expression={$_.Usage.Storage}}
В этом примере возвращается объем пространства, занятого семейством сайтов, для чего используется поле storage свойства .UsageInfo.
ПРИМЕР 9
Get-SPSite -Limit all -CompatibilityLevel 14
В этом примере возвращаются все семейства веб-сайтов в режиме sharePoint Server.
Параметры
-AssignmentCollection
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Позволяет корректно удалять объекты. При использовании объектов таких типов, как SPWeb или SPSite, возможен захват больших объемов памяти, и работа с такими объектами в скриптах Windows PowerShell требует точного управления памятью. С помощью объекта SPAssignment вы можете назначить объекты переменной и освободить память, удалив ненужные объекты. Объекты SPWeb, SPSite или SPSiteAdministration после использования удаляются автоматически, если коллекция назначения или параметр Global не применяются.
Если применяется параметр Global, то все объекты размещаются в глобальной области памяти. Если объекты не используются сразу же или не удаляются командой Stop-SPAssignment, может возникнуть ситуация нехватки памяти.
Свойства параметра
| Тип: | SPAssignmentCollection |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-CompatibilityLevel
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Определяет версию шаблонов, которая используется при создании нового объекта SPSite. Это значение устанавливает начальный уровень совместимости для семейства сайтов. Значения для этого параметра могут быть: SharePoint Server или SharePoint Server. Если он не указан, для CompatibilityLevel по умолчанию задается последняя доступная версия веб-приложения в соответствии с параметром SiteCreationMode.
Свойства параметра
| Тип: | Int32 |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Предлагает подтвердить выполнение команды.
Чтобы получить дополнительные сведения, введите следующую команду: get-help about_commonparameters
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ContentDatabase
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Задает идентификатор GUID базы данных контента, для которой требуется вернуть семейства сайтов.
Тип значения: допустимое имя базы данных, например SPContentDB01, или допустимый идентификатор GUID в формате 12345678-90ab-cdef-1234-567890bcdefgh.
Свойства параметра
| Тип: | SPContentDatabasePipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AllSitesInContentDB
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Filter
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Задает блок сценария фильтра на стороне сервера, который требуется применить.
Тип должен быть допустимым именем и значением фильтра в формате {$_PropertyName <оператор> "filterValue"}.
Допустимые операторы: EQ, NE, LIKE, NOTLIKE.
Свойства параметра
| Тип: | ScriptBlock |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Задает URL-адрес или идентификатор GUID семейства сайтов, которое требуется получить.
Тип должен быть допустимым URL-адресом в форме https://server_name или https://server_name/sites/sitenameили допустимым ИДЕНТИФИКАТОРом GUID (например, 12345678-90ab-cdef-1234-567890bcdefgh).
Свойства параметра
| Тип: | SPSitePipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AllSitesInIdentity
| Position: | 1 |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Limit
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Задает максимальное число возвращаемых семейств сайтов. Значение по умолчанию: 200.
Тип значения: допустимое неотрицательное число. Чтобы вернуть все семейства сайтов в заданной области, укажите значение ALL.
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-NeedsB2BUpgrade
Применимо: SharePoint Server 2016, SharePoint Server 2019
Определяет, следует ли обновлять веб-сайт.
Допустимые значения: True и False.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AllSitesInContentDB
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Regex
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Если задан этот параметр, URL-адрес, указанный в параметре Identity, считается регулярным выражением.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AllSitesInIdentity
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SiteSubscription
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Указывает подписку, для которой требуется вернуть семейства сайтов.
Тип должен быть допустимым URL-адресом в форме https://server_name или допустимым идентификатором GUID (например, 12345678-90ab-cdef-1234-567890bcdefgh).
Свойства параметра
| Тип: | SPSiteSubscriptionPipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AllSitesInSiteSubscription
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WebApplication
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Определяет URL-адрес, идентификатор GUID или имя веб-приложения, для которого требуется вернуть сайты.
Тип должен быть допустимым URL-адресом в формате https://server_name, допустимым ИДЕНТИФИКАТОРом (например, 12345678-90ab-cdef-1234-567890bcdefgh); или именем веб-приложения (например, WebApplication1212).
Свойства параметра
| Тип: | SPWebApplicationPipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
AllSitesInWebApplication
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Применимо: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Отображает описание команды. При этом сама команда не выполняется.
Чтобы получить дополнительные сведения, введите следующую команду: get-help about_commonparameters
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.