Get-EntraContact
Recebo um contacto da Microsoft Entra ID.
Sintaxe
GetQuery (Predefinição)
Get-EntraContact
[-Filter <String>]
[-All]
[-Top <Int32>]
[-Property <String[]>]
[-HasErrorsOnly]
[<CommonParameters>]
GetById
Get-EntraContact
-OrgContactId <String>
[-All]
[-Property <String[]>]
[-HasErrorsOnly]
[<CommonParameters>]
Descrição
O Get-EntraContact cmdlet recebe um contacto da Microsoft Entra ID.
Para cenários delegados envolvendo contas de trabalho ou escola, o utilizador iniciado deve ter uma função Microsoft Entra suportada ou uma função personalizada com as permissões necessárias. Os seguintes papéis de menor privilégio apoiam esta operação:
- Leitores do Diretório: Leiam propriedades básicas
- Leitor Global
- Escritores de Diretórios
- Administrador do Intune
- Administrador de usuários
Exemplos
Exemplo 1: Recuperar todos os objetos de contacto 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 contacto no diretório.
Exemplo 2: Recuperar um objeto de contacto 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 contacto especificado no diretório.
-
-OrgContactIdo parâmetro especifica o ID do contacto.
Exemplo 3: Recuperar todos os objetos contactos 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 contactos do diretório.
Exemplo 4: Recuperar os dois principais objetos de contactos 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 contactos principais do diretório. Você pode usar -Limit como um alias para -Top.
Exemplo 5: Recuperar todos os objetos contactos 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 contactos com o nome de exibição especificado.
Exemplo 6: Recuperar contactos com erros de provisionamento de serviços
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 contactos que apresentam erros de provisionamento de serviços.
Parâmetros
-All
Liste todas as páginas.
Propriedades dos parâmetros
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Filter
Especifica uma instrução de filtro OData v4.0. Este parâmetro controla quais os objetos que são devolvidos.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
GetQuery
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-HasErrorsOnly
Só devolve contactos que apresentam erros de provisionamento de serviço.
Propriedades dos parâmetros
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-OrgContactId
Especifica o ID de um contacto no Microsoft Entra ID.
Propriedades dos parâmetros
| Tipo: | System.String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | IdentificadorDoObjeto |
Conjuntos de parâmetros
GetById
| Posto: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-Property
Especifica propriedades a devolver.
Propriedades dos parâmetros
| Tipo: | System.String[] |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Select |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Top
Especifica o número máximo de registos a devolver.
Propriedades dos parâmetros
| Tipo: | System.Int32 |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Limit |
Conjuntos de parâmetros
GetQuery
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | 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.