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-адресом для заданной области действия, подходящий под условия выражения.

Параметр Filter — это серверный фильтр для определенных свойств дочернего сайта, хранящихся в базе данных контента. Без параметра Filter фильтрация по этим свойствам выполняется медленно. К этим свойствам дочернего сайта относятся Шаблон и Заголовок. Параметр Filter — это блок скрипта, который использует тот же синтаксис, что и инструкция Where-Object, но выполняется на стороне сервера для ускорения результатов.

Важно отметить, что каждое семейство веб-сайтов, возвращаемое командлетом Get-SPWeb, автоматически помещается в конец конвейера. Чтобы сохранить результаты командлета Get-SPWeb в локальной переменной, необходимо использовать командлеты Start-SPAssignment и Stop-SPAssignment для предотвращения утечек памяти.

Сведения о разрешениях и актуальную информацию о Windows PowerShell для продуктов SharePoint см. в сетевой документации о командлетах SharePoint Server.

Примеры

--------------------------ПРИМЕР 1------------------------

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

В данном примере кода возвращаются все дочерние веб-сайты в заданном семействе веб-сайтов.

--------------------------ПРИМЕР 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 вы можете назначить объекты переменной и освободить память, удалив ненужные объекты. Объекты SPWeb, SPSite или SPSiteAdministration после использования удаляются автоматически, если коллекция назначения или параметр Global не применяются.

Если применяется параметр 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 <operator> "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-адрес дочернего сайта. При использовании относительного пути необходимо задать параметр Site.

Допустимый URL-адрес в формате http://имя_сервера или относительный путь в формате /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

Указывает, что URL-адрес, заданный параметром Identity, должен считаться регулярным выражением.

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 семейства веб-сайтов, из которого необходимо брать список дочерних сайтов.

Тип должен быть допустимым URL-адресом в виде https://server_name; 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