Compartilhar via

Get-SecurityPrincipal

  • Referência
Módulo:
ExchangePowerShell
Aplica-se a:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.

Use o cmdlet Get-SecurityPrincipal para retornar uma lista das entidades de segurança. Entidades de segurança são entidades, como usuários ou grupos de segurança, que podem receber permissões e direitos de usuário.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

Get-SecurityPrincipal
   [[-Identity] <ExtendedSecurityPrincipalIdParameter>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IncludeDomainLocalFrom <SmtpDomain>]
   [-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
   [-ResultSize <Unlimited>]
   [-RoleGroupAssignable]
   [-Types <MultiValuedProperty>]
   [<CommonParameters>]

Description

O cmdlet Get-SecurityPrincipal é usado pelo centro de administração do Exchange para preencher campos que exibem informações do destinatário.

Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com

Este exemplo recupera entidades de segurança da UO People.

Exemplo 2

Get-SecurityPrincipal -Filter "Department -eq 'Legal'"

Este exemplo recupera entidades de segurança do departamento Legal, usando o parâmetro Filter. Apenas as entidades de segurança correspondentes à condição do filtro são recuperadas.

Exemplo 3

Get-SecurityPrincipal -Identity Administrator

Este exemplo recupera uma única entidade de segurança especificada explicitamente, usando o parâmetro Identity.

Exemplo 4

Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize

Este exemplo recupera entidades de segurança conhecidas e exibe apenas as propriedades Name e SID nos resultados.

Parâmetros

-DomainController

Este parâmetro está disponível somente no Exchange local.

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.

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

-Filter

O parâmetro Filter usa a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. Os critérios de pesquisa usam a sintaxe "Property -ComparisonOperator 'Value'".

  • Inclua todo o filtro OPATH nas aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo, $true, $falseou $null), use aspas individuais ' ' em vez disso. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também pode usar chaves { }, mas somente se o filtro não contiver variáveis.
  • A propriedade é uma propriedade filtrada. Para obter mais informações sobre as propriedades filtradas no servidor exchange e Exchange Online, consulte Propriedades filtreáveis para o parâmetro Filter.
  • ComparisonOperator é um operador de comparação OPATH (por exemplo -eq , para iguais e -like para comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators.
  • Valor é o valor da propriedade a ser pesquisado. Inclua valores e variáveis de texto em aspas individuais ('Value' ou '$Variable'). Se um valor variável contiver aspas individuais, você precisará identificar (escapar) as aspas individuais para expandir a variável corretamente. Por exemplo, em vez de '$User', use '$($User -Replace "'","''")'. Não inclua inteiros ou valores do sistema entre aspas (por exemplo, use 500, $true, $falseou $null em vez disso).

Você pode encadear vários critérios de pesquisa usando os operadores lógicos -and e -or. Por exemplo: "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".

Para obter informações detalhadas sobre filtros OPATH no Exchange, consulte Informações adicionais de sintaxe OPATH.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Identity

O parâmetro Identity especifica a entidade de segurança. Quando a entidade de segurança for especificada explicitamente usando esse parâmetro, nenhuma entidade de segurança adicional será retornada.

Type:ExtendedSecurityPrincipalIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-IncludeDomainLocalFrom

Este parâmetro está disponível somente no Exchange local.

O parâmetro IncludeDomainLocalFrom especifica se deve retornar grupos locais de domínio do FQDN do domínio do Active Directory especificado (por exemplo, contoso.com) nos resultados.

Não use esse parâmetro com os parâmetros Filter ou Identity.

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

-OrganizationalUnit

O parâmetro OrganizationalUnit filtra os resultados com base na localização do objeto no Active Directory. Somente objetos que existem na localização especificada são retornados. A entrada válida para esse parâmetro é uma OU (unidade organizacional) ou domínio retornado pelo cmdlet Get-OrganizationalUnit. É possível usar qualquer valor que identifique a UO ou o domínio com exclusividade. Por exemplo:

  • Nome
  • Nome
  • Nome diferenciado (DN)
  • GUID
Type:ExtendedOrganizationalUnitIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-ResultSize

O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-RoleGroupAssignable

O switch RoleGroupAssignable filtra entidades de segurança retornando somente os objetos que podem ser atribuídos a um grupo de funções RBAC. Não é preciso especificar um valor com essa opção.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Types

O parâmetro Types filtra os resultados por tipo de objeto. Os valores válidos são:

  • Computador
  • GlobalSecurityGroup
  • Grupo
  • UniversalSecurityGroup
  • User
  • WellknownSecurityPrincipal

Vários valores, separados por vírgulas, podem ser especificados.

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

Entradas

Input types

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.