Get-SecurityPrincipal
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e definições podem ser exclusivos de um ambiente ou outro.
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.
Sintaxe
Default (Default)
Get-SecurityPrincipal
[[-Identity] <ExtendedSecurityPrincipalIdParameter>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IncludeDomainLocalFrom <SmtpDomain>]
[-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-RoleGroupAssignable]
[-Types <MultiValuedProperty>]
[<CommonParameters>]
Description
O cmdlet Get-SecurityPrincipal é utilizado pelo centro de administração do Exchange para preencher os campos que apresentam as informações dos destinatários.
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. 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
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Propriedades do parâmetro
| Tipo: | Fqdn |
| 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 |
-Filter
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local
O parâmetro Filter utiliza a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. Os critérios de pesquisa utilizam a sintaxe "Property -ComparisonOperator 'Value'".
- Coloque todo o filtro OPATH entre aspas " ". Se o filtro contiver valores de sistema (por exemplo,
$true,$falseou$null), utilize aspas únicas ' ' em vez disso. Embora este parâmetro seja uma cadeia (não um bloco de sistema), também pode utilizar chavetas { }, mas apenas se o filtro não contiver variáveis. - A propriedade é uma propriedade filtráveis. Para obter mais informações sobre as propriedades filtráveis no servidor Exchange e Exchange Online, veja Propriedades filtráveis para o parâmetro Filter.
- ComparisonOperator é um operador de comparação OPATH (por exemplo
-eq, para igual e-likepara comparação de cadeias). Para obter mais informações sobre operadores de comparação, veja about_Comparison_Operators. - Valor é o valor da propriedade a procurar. Coloque os valores de texto e as variáveis entre plicas (
'Value'ou'$Variable'). Se um valor de variável contiver aspas únicas, terá de identificar (escape) as aspas únicas para expandir a variável corretamente. Por exemplo, em vez de'$User', utilize'$($User -Replace "'","''")'. Não coloque números inteiros ou valores do sistema entre aspas (por exemplo, utilize500,$true,$falseou$nullem alternativa).
Pode encadear múltiplos critérios de pesquisa em conjunto com 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, veja Informações adicionais sobre sintaxe OPATH.
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 |
-Identity
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local
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.
Atenção: o valor $null ou um valor inexistente para o parâmetro Identidade devolve todos os objetos como se tivesse executado o comando Get- sem o parâmetro Identity. Verifique se as listas de valores do parâmetro Identity estão corretas e não contêm valores de $null inexistentes.
Propriedades do parâmetro
| Tipo: | ExtendedSecurityPrincipalIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-IncludeDomainLocalFrom
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
O parâmetro IncludeDomainLocalFrom especifica se pretende devolver 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.
Propriedades do parâmetro
| Tipo: | SmtpDomain |
| 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 |
-OrganizationalUnit
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local
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 este parâmetro é uma unidade organizacional (UO) ou domínio que é devolvido 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
Propriedades do parâmetro
| Tipo: | ExtendedOrganizationalUnitIdParameter |
| 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 |
-ResultSize
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local
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.
Propriedades do parâmetro
| Tipo: | Unlimited |
| 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 |
-RoleGroupAssignable
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local
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.
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 |
-Types
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local
O parâmetro Types filtra os resultados por tipo de objeto. Os valores válidos são:
- Computador
- GlobalSecurityGroup
- Group
- UniversalSecurityGroup
- Usuário
- WellknownSecurityPrincipal
Vários valores, separados por vírgulas, podem ser especificados.
Propriedades do parâmetro
| Tipo: | MultiValuedProperty |
| 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 |
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.
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.