Get-EntraContact

Módulo:
Microsoft.Entra.DirectoryManagement Module v1.3

Obtiene un contacto de Microsoft Entra ID.

Sintaxis

GetQuery (valor predeterminado) 

Get-EntraContact

    [-Filter <String>]
    [-All]
    [-Top <Int32>]
    [-Property <String[]>]
    [-HasErrorsOnly]
    [<CommonParameters>]

GetById 

Get-EntraContact

    -OrgContactId <String>
    [-All]
    [-Property <String[]>]
    [-HasErrorsOnly]
    [<CommonParameters>]

Description

El Get-EntraContact cmdlet obtiene un contacto de Microsoft Entra ID.

Para escenarios delegados que implican cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener un rol de Microsoft Entra compatible o un rol personalizado con los permisos necesarios. Los siguientes roles con privilegios mínimos admiten esta operación:

  • Lectores de directorios: leer propiedades básicas
  • Lector universal
  • Escritores de directorios
  • Administrador de Intune
  • Administrador de usuarios

Ejemplos

Ejemplo 1: Recuperar todos los objetos de contacto del directorio

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

En este ejemplo se recuperan todos los objetos de contacto del directorio .

Ejemplo 2: Recuperar un objeto de contacto específico en el directorio

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

En este ejemplo se recupera el contacto especificado en el directorio .

  • -OrgContactId el parámetro especifica el identificador de contacto.

Ejemplo 3: Recuperar todos los objetos de contactos del directorio

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

En este ejemplo se recuperan todos los contactos del directorio .

Ejemplo 4: Recuperar los dos principales objetos de contactos en el directorio

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

En este ejemplo se recuperan los dos primeros contactos del directorio. Puede usar -Limit como alias para -Top.

Ejemplo 5: Recuperar todos los objetos de contactos en el filtro de directorio 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

En este ejemplo se recuperan los contactos que tienen el nombre para mostrar especificado.

Ejemplo 6: Recuperación de contactos con errores de aprovisionamiento de servicios

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=...}}

En este ejemplo solo se recuperan los contactos que tienen errores de aprovisionamiento de servicios.

Parámetros

-All

Enumera todas las páginas.

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Filter

Especifica una instrucción de filtro de OData v4.0. Este parámetro controla qué objetos se devuelven.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

GetQuery
Posición:Named
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-HasErrorsOnly

Devuelve solo los contactos que tienen errores de aprovisionamiento del servicio.

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-OrgContactId

Especifica el identificador de un contacto en Microsoft Entra ID.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:ObjectId (identificador de objeto)

Conjuntos de parámetros

GetById
Posición:Named
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Property

Especifica las propiedades que se van a devolver.

Propiedades de parámetro

Tipo:

System.String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Select

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Top

Especifica el número máximo de registros que se van a devolver.

Propiedades de parámetro

Tipo:System.Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Limit

Conjuntos de parámetros

GetQuery
Posición:Named
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.