Get-SPWeb
Retorna todos os subsites que correspondem aos critérios fornecidos.
Sintaxe
Default (Padrão)
Get-SPWeb
[[-Identity] <SPWebPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Filter <ScriptBlock>]
[-Limit <String>]
[-Regex]
[-Site <SPSitePipeBind>]
[-WhatIf]
[<CommonParameters>]
Description
O cmdlet Get-SPWeb retorna todos os subsites que correspondem ao escopo fornecido pelo parâmetro Identity. Todos os subsites que atendem aos critérios são retornados.
O parâmetro Identity pode ser a URL completa ou um caminho relativo. Se você especificar um caminho relativo, também deverá especificar o parâmetro Site para identificar o conjunto de sites a partir do qual retornar o subsite.
O parâmetro Identity também oferece suporte para fornecer uma URL parcial que termina em um caractere curinga (*). Todos os subsites que correspondem a essa URL parcial para o escopo especificado são retornados. Além disso, se o parâmetro Regex for fornecido, o parâmetro Identity será tratado como uma expressão regular e qualquer subweb com uma URL fornecida no escopo determinado que corresponde à expressão será retornada.
O parâmetro Filter é um filtro do lado do servidor para determinadas propriedades de subsite que são armazenadas no banco de dados de conteúdo; sem o parâmetro Filter, a filtragem nessas propriedades é um processo lento. Essas propriedades de subsite são Template e Title. O parâmetro Filter é um bloco de scripts que usa a mesma sintaxe que uma instrução Where-Object, mas é executada do lado do servidor para obter resultados mais rápidos.
É importante observar que cada conjunto de sites retornado pelo cmdlet Get-SPWeb é descartado no fim do pipeline. Para armazenar os resultados de Get-SPWeb em uma variável local, os cmdlets Start-SPAssignment e Stop-SPAssignment devem ser usados para evitar perdas de memória.
Para obter as permissões e informações mais recentes sobre o Windows PowerShell para Produtos SharePoint, confira a documentação online em Cmdlets do SharePoint Server.
Exemplos
EXEMPLO 1
Get-SPWeb -site https://sitename/sites/site1
Este exemplo retorna todas as subwebs em um determinado conjunto de sites.
EXEMPLO 2
Get-SPWeb -Site https://sitename/sites/site1 -filter {$_.Template -eq "STS#0"}
Este exemplo exibe todos os subsites que usam o modelo "STS#0".
EXEMPLO 3
Start-SPAssignment -Global
C:\PS>$w = Get-SPWeb https://sitename
C:\PS>$w.set_SiteLogoUrl("https://PathToImage/test.jpg")
C:\PS>$w.Update()
Stop-SPAssignment -Global
Este exemplo demonstra como salvar um subsite como uma variável e chamar métodos de modelo de objeto no objeto SPAssignment.
Parâmetros
-AssignmentCollection
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Gerencia objetos para o devido descarte. O uso de objetos como SPWeb ou SPSite pode consumir grandes quantidades de memória e o uso desses objetos em scripts do Windows PowerShell requer gerenciamento de memória adequado. Usando o objeto SPAssignment, você poderá atribuir objetos a uma variável e descartar os objetos após o uso para liberar memória. Quando objetos SPWeb, SPSite ou SPSiteAdministration são usados, os objetos são automaticamente descartados se um conjunto de atribuições ou o parâmetro Global não forem usados.
Quando o parâmetro Global é usado, todos os objetos estão contidos no repositório global. Se os objetos não forem usados imediatamente ou forem descartados usando o comando Stop-SPAssignment, um cenário de falta de memória poderá ocorrer.
Propriedades do parâmetro
| Tipo: | SPAssignmentCollection |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Solicita sua confirmação antes de executar o comando.
Para saber mais, digite o seguinte comando: get-help about_commonparameters
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Filter
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Especifica o filtro do lado do servidor a ser usado para o escopo especificado.
O tipo tem de ser um filtro válido no formulário {filterName <operador> "filterValue"}.
Propriedades do parâmetro
| Tipo: | ScriptBlock |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Identity
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Especifica o nome ou a URL completa ou parcial do subsite. Se você usar um caminho relativo, especifique o parâmetro Site.
Uma URL válida no formato https://server_name ou um caminho relativo no formato /SubSites/MySubSite.
Propriedades do parâmetro
| Tipo: | SPWebPipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Limit
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Limita o número máximo de subsites a serem retornados. O valor padrão é 200. Para retornar todos os sites, insira ALL.
O tipo deve ser um número válido maior que 0 ou ALL.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Regex
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Especifica se a URL fornecida pelo parâmetro Identity deve ser tratada como uma expressão regular.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Site
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Especifica a URL ou o GUID do conjunto de sites a partir do qual listar subsites.
O tipo deve ser uma URL válida, no formato https://server_name; um GUID, no formato 1234-5678-9807, ou um objeto SPSite.
Propriedades do parâmetro
| Tipo: | SPSitePipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-WhatIf
Aplicável: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Exibe uma mensagem que descreve o efeito do comando em vez de executar o comando.
Para saber mais, digite o seguinte comando: get-help about_commonparameters
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.