Get-EntraContact
Obtém um contato de Microsoft Entra ID.
Sintaxe
GetQuery (Default)
Get-EntraContact
[-Filter <String>]
[-All]
[-Top <Int32>]
[-Property <String[]>]
[-HasErrorsOnly]
[<CommonParameters>]
GetById
Get-EntraContact
-OrgContactId <String>
[-All]
[-Property <String[]>]
[-HasErrorsOnly]
[<CommonParameters>]
Description
O Get-EntraContact cmdlet obtém um contato de Microsoft Entra ID.
Para cenários delegados envolvendo contas corporativas ou de estudante, o usuário conectado deve ter uma função de Microsoft Entra com suporte ou uma função personalizada com as permissões necessárias. As seguintes funções com privilégios mínimos dão suporte a esta operação:
- Leitores de diretório: ler propriedades básicas
- Leitor Global
- Gravadores de diretório
- Administrador do Intune
- Administrador de usuários
Exemplos
Exemplo 1: recuperar todos os objetos de contato no diretório
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2
Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3
Este exemplo recupera todos os objetos de contato no diretório.
Exemplo 2: recuperar objeto de contato específico no diretório
Connect-Entra -Scopes 'OrgContact.Read.All'
$contact = Get-EntraContact -Filter "displayName eq 'Contoso Contact'"
Get-EntraContact -OrgContactId $contact.Id
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Este exemplo recupera o contato especificado no diretório.
-
-OrgContactIdo parâmetro especifica a ID de contato.
Exemplo 3: recuperar todos os objetos de contatos no diretório
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -All
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2
Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3
Este exemplo recupera todos os contatos no diretório.
Exemplo 4: recuperar os dois principais objetos de contatos no diretório
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -Top 2
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Este exemplo recupera os dois principais contatos no diretório. Você pode usar -Limit como um alias para -Top.
Exemplo 5: recuperar todos os objetos de contatos no filtro de diretório por DisplayName
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -Filter "displayName eq 'Contoso Contact'"
DisplayName Id Mail MailNickname
----------- -- ---- ------------
Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact
Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1
Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2
Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3
Este exemplo recupera contatos com o nome de exibição especificado.
Exemplo 6: recuperar contatos com erros de provisionamento de serviço
Connect-Entra -Scopes 'OrgContact.Read.All'
Get-EntraContact -HasErrorsOnly
DisplayName Id Mail ServiceProvisioningErrors
----------- -- ---- -------------------------
Failed Contact eeeeeeee-4444-5555-6666-ffffffffffff contact-error@contoso.com {@{ErrorDetail=...}}
Este exemplo recupera apenas os contatos que têm erros de provisionamento de serviço.
Parâmetros
-All
Listar todas as páginas.
Propriedades do parâmetro
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor padrão: | False |
| 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
Especifica uma instrução de filtro OData v4.0. Esse parâmetro controla quais objetos são retornados.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetQuery
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-HasErrorsOnly
Retorna somente contatos que têm erros de provisionamento de serviço.
Propriedades do parâmetro
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor padrão: | False |
| 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 |
-OrgContactId
Especifica a ID de um contato no Microsoft Entra ID.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | IdentificadorDeObjeto |
Conjuntos de parâmetros
GetById
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Property
Especifica as propriedades a serem retornadas.
Propriedades do parâmetro
| Tipo: | System.String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | Select |
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 |
-Top
Especifica o número máximo de registros a serem retornados.
Propriedades do parâmetro
| Tipo: | System.Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | Limit |
Conjuntos de parâmetros
GetQuery
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| 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, consulte about_CommonParameters.