Get-SPSite

Retorna todos os conjuntos de sites que coincidem com os critérios especificados.

Syntax

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>]

Description

Este cmdlet contém mais de um conjunto de parâmetros. Você só pode usar parâmetros de um único conjunto de parâmetros; além disso, não é possível combinar parâmetros de diferentes conjuntos. Para obter mais informações sobre como usar conjuntos de parâmetros, confira Conjuntos de parâmetros de Cmdlets.

O cmdlet Get-SPSite retorna um único site que corresponde ao parâmetro Identity ou todos os sites que correspondem ao parâmetro Filter para o escopo especificado. Os escopos são os parâmetros WebApplication, ContentDatabase e SiteSubscription. Caso nenhum desses escopos seja fornecido, o escopo será o farm. Se o escopo for especificado sem o parâmetro Filter, todos os sites desse escopo serão retornados.

O parâmetro Identity também oferece suporte para fornecer uma URL parcial que termina em um caractere curinga (*). Todos os conjuntos de sites 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 conjunto de sites com uma URL fornecida no escopo determinado que corresponda à expressão será retornado.

O parâmetro Filter é um filtro do servidor para determinadas propriedades do conjunto de sites armazenadas no banco de dados de conteúdo; sem o parâmetro Filter, a filtragem dessas propriedades é um processo lento. Essas propriedades do conjunto de sites são Owner, SecondaryOwner e LockState. O parâmetro Filter é um bloco de script que usa a mesma sintaxe da declaração Where-Object, mas é executada no servidor para obter resultados mais rápidos.

Os valores válidos para LockState são: Unlock, NoAdditions, ReadOnly, NoAccess.

É importante observar que cada conjunto de sites retornado pelo cmdlet Get-SPSite é destruído automaticamente no fim do pipeline. Para armazenar os resultados de Get-SPSite 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-SPSite 'https://<site name>' | Get-SPWeb -Limit All | Select Title

Este exemplo obtém a coleção de títulos de subweb na coleção de sites em https://< nome> do local.

------------------EXEMPLO 2---------------------

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

Este exemplo obtém um subconjunto de dados de todos os sites do banco de dados de conteúdo b399a366-d899-4cff-8a9b-8c0594ee755f.

------------------EXEMPLO 3---------------------

Start-SPAssignment -Global

$s = Get-SPSite -Identity https://<MyApp>/Sites/Site1

$s.Url

Stop-SPAssignment -Global

Este exemplo obtém os sites especificados pelo parâmetro Identity e insere os resultados na variável s.

O exemplo anterior usa o método Global do conjunto de atribuições. O método Global é mais fácil de usar, mas os conteúdos desse objeto crescem muito rapidamente. Tenha cuidado para não executar um comando Get-SPSite que retorna muitos resultados quando a atribuição global está habilitada.

------------------EXEMPLO 4---------------------

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

Este exemplo obtém os 50 primeiros sites pertencentes ao usuário DOMAIN\JDow usando uma consulta do servidor e os atribui a uma variável local.

Este exemplo usa métodos avançados do conjunto de atribuições.

------------------EXEMPLO 5---------------------

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

Este exemplo mostra um comando que retorna a soma do uso de espaço em disco para todos os sites de um determinado aplicativo Web.

------------------EXEMPLO 6---------------------

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

Este exemplo retorna todos os sites que correspondem à expressão regular determinada.

As Cotas do parâmetro Identity serão obrigatórias quando o parâmetro Regex for usado.

------------------EXEMPLO 7---------------------

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

Este exemplo obtém até 100 dos sites na URL https://sitename/sites/teams.

------------------EXEMPLO 8---------------------

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

Este exemplo obtém a quantidade de armazenamento usada por um conjunto de sites, usando o campo de armazenamento da propriedade .UsageInfo.

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

Get-SPSite -Limit all -CompatibilityLevel 14

Este exemplo retorna todas as coleções de sites de modo do SharePoint Server.

Parâmetros

-AssignmentCollection

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-CompatibilityLevel

Especifica a versão dos modelos a serem usados ao criar um novo objeto SPSite. Este valor define o valor CompatibilityLevel inicial para o conjunto de sites. Os valores para esse parâmetro podem ser SharePoint Server ou SharePoint Server. Quando este parâmetro não é especificado, o CompatibilityLevel será padrão para a maior versão possível do aplicativo Web dependendo da configuração SiteCreationMode.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Confirm

Solicita sua confirmação antes de executar o comando. Para saber mais, digite o seguinte comando: 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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ContentDatabase

Especifica o GUID do banco de dados de conteúdo a partir do qual são listados conjuntos de sites.

O tipo deve ser um nome de banco de dados válido, no formato SPContentDB01 ou um GUID válido (por exemplo, 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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Filter

Especifica o bloco de scripts do filtro do servidor a ser aplicado.

O tipo deve ser um nome de filtro válido e um valor no formulário {$_PropertyName <operador> "filterValue"}.

Os operadores válidos são: 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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

Especifica a URL ou o GUID do conjunto de sites a ser obtido.

O tipo deve ser uma URL válida, no formato https://server_name ou https://server_name/sites/sitename ou um GUID válido (por exemplo, 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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Limit

Limita o número máximo de conjuntos de sites a serem retornados. O valor padrão é 200.

O tipo deve ser um número não negativo válido. Especifique ALL para retornar todos os conjuntos de sites para o escopo determinado.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-NeedsB2BUpgrade

Especifica se o site precisa ser atualizado.

Os valores válidos são True e False.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2016, SharePoint Server 2019

-Regex

Quando usada, a URL fornecida para o parâmetro Identity é tratada como uma expressão regular.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-SiteSubscription

Especifica a assinatura a partir da qual serão obtidos os conjuntos de sites.

O tipo deve ser uma URL válida, no formato https://server_name ou um GUID válido (por exemplo, 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 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WebApplication

Especifica a URL, o GUID ou o nome do aplicativo Web pelo qual listar sites.

O tipo deve ser uma URL válida, no formato https://server_name, um GUID válido (por exemplo, 12345678-90ab-cdef-1234-567890bcdefgh) ou o nome do aplicativo Web (por exemplo, WebApplication1212).

Type:SPWebApplicationPipeBind
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019