Get-Recipient

  • Riferimento
Modulo:
ExchangePowerShell
Si applica a:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

Questo cmdlet è disponibile in Exchange locale e nel servizio basato su cloud. Alcuni parametri e impostazioni possono essere esclusivi di singoli ambienti.

Utilizzare il cmdlet Get-Recipient per visualizzare gli oggetti destinatario esistenti nell'organizzazione. Il cmdlet restituisce tutti gli oggetti abilitati alla posta elettronica (ad esempio, cassette postali, utenti e contatti di posta elettronica e gruppi di distribuzione).

Nota: in Exchange Online PowerShell è consigliabile usare il cmdlet Get-EXORecipient anziché questo cmdlet. Per ulteriori informazioni, vedere Connessione a Exchange Online PowerShell.

Negli ambienti cloud, per restituire Gruppi di Microsoft 365, è necessario usare il parametro RecipientTypeDetails con il valore GroupMailbox.

Per informazioni sui set di parametri nella sezione Sintassi, vedere Sintassi del cmdlet di Exchange.

Sintassi

Get-Recipient
   [-Anr <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Database <DatabaseIdParameter>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [[-Identity] <RecipientIdParameter>]
   [-AuthenticationType <AuthenticationType>]
   [-BookmarkDisplayName <String>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeBookmarkObject <Boolean>]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [-Database <DatabaseIdParameter>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-IncludeSoftDeletedRecipients] [<CommonParameters>]
   [<CommonParameters>]
Get-Recipient
   [-RecipientPreviewFilter <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Capabilities <MultiValuedProperty>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [<CommonParameters>]

Descrizione

Il cmdlet Get-Recipient potrebbe non restituire tutte le proprietà specifiche di un destinatario. Per visualizzare le proprietà specifiche di un oggetto del destinatario, è necessario utilizzare il cmdlet corrispondente in base al tipo di oggetto (ad esempio, Get-Mailbox, Get-MailUser, o Get-DistributionGroup).

È necessario disporre delle autorizzazioni prima di poter eseguire questo cmdlet. Sebbene in questo argomento vengano elencati tutti i parametri relativi al cmdlet, si potrebbe non avere accesso ad alcuni di essi qualora non siano inclusi nelle autorizzazioni assegnate. Per individuare le autorizzazioni necessarie per eseguire cmdlet o parametri nell'organizzazione, vedere Trovare le autorizzazioni necessarie per eseguire i cmdlet di Exchange.

Esempio

Esempio 1

Get-Recipient -ResultSize unlimited

Questo esempio consente di recuperare un elenco riepilogativo di tutti i destinatari nell'organizzazione.

Esempio 2

Get-Recipient -Identity "Marketing Department" | Format-List

In questo esempio vengono restituite informazioni dettagliate per il destinatario denominato Marketing Department.

Esempio 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

Con questo esempio vengono recuperate le informazioni su tutti i contatti di posta elettronica all'interno dell'organizzazione, ordinati in base all'ufficio.

Parametri

-Anr

Il parametro Anr consente di specificare una stringa in cui eseguire la ricerca per la risoluzione dei nomi ambigui (ANR). È possibile specificare una stringa parziale e cercare gli oggetti con un attributo che corrisponda alla stringa. Gli attributi predefiniti ricercati sono i seguenti:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • Alias
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

-AuthenticationType

Questo parametro è disponibile solamente nel servizio basato su cloud.

Il parametro AuthenticationType consente di specificare il destinatario in base al tipo di autenticazione. Utilizzare uno dei seguenti valori:

  • Federati
  • Gestione
Type:AuthenticationType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance, Exchange Online Protection

-BookmarkDisplayName

Questo parametro è riservato all'uso interno da parte di Microsoft.

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

-Capabilities

Questo parametro è disponibile solamente nel servizio basato su cloud.

Questo parametro è riservato all'uso interno da parte di Microsoft.

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

-Credential

Questo parametro è disponibile solo in Exchange locale.

Il parametro Credential consente di specificare il nome utente e la password usati per eseguire questo comando. In genere questo parametro viene utilizzato negli script o quando occorre fornire credenziali diverse con le autorizzazioni necessarie.

Un valore per questo parametro richiede il cmdlet Get-Credential. Per sospendere questo comando e visualizzare la richiesta di immissione delle credenziali, usare il valore (Get-Credential). In alternativa, prima di eseguire questo comando, archiviare le credenziali in una variabile (ad esempio, $cred = Get-Credential) e quindi usare il nome della variabile ($cred) per questo parametro. Per altre informazioni, vedere Get-Credential.

Type:PSCredential
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

-Database

Questo parametro è disponibile solo in Exchange locale.

Il parametro Database restituisce tutti i destinatari archiviati nel database delle cassette postali specificato. È possibile utilizzare qualsiasi valore che identifichi il database in maniera univoca. Ad esempio:

  • Nome
  • Nome distinto (DN)
  • GUID
Type:DatabaseIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

Questo parametro è disponibile solo in Exchange locale.

Il parametro DomainController consente di specificare il controller di dominio utilizzato da questo cmdlet per la lettura o la scrittura dei dati in Active Directory. Identificare il controller di dominio mediante il relativo nome di dominio completo (FQDN). Ad esempio, 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

Il parametro Filter usa la sintassi OPATH per filtrare i risultati in base alle proprietà e ai valori specificati. I criteri di ricerca usano la sintassi "Property -ComparisonOperator 'Value'".

  • Racchiudere l'intero filtro OPATH tra virgolette doppie " ". Se il filtro contiene valori di sistema (ad esempio, $true, $falseo $null), usare le virgolette singole ''. Sebbene questo parametro sia una stringa (non un blocco di sistema), è anche possibile usare le parentesi graffe { }, ma solo se il filtro non contiene variabili.
  • La proprietà è una proprietà filtrabile. Per altre informazioni sulle proprietà filtrabili in Exchange Server e Exchange Online, vedere Proprietà filtrabili per il parametro Filter.
  • ComparisonOperator è un operatore di confronto OPATH, ad esempio -eq per equals e -like per il confronto di stringhe. Per ulteriori informazioni sugli operatori di confronto, vedere about_Comparison_Operators.
  • Il valore è il valore della proprietà da cercare. Racchiudere valori di testo e variabili tra virgolette singole ('Value' o '$Variable'). Se un valore variabile contiene virgolette singole, è necessario identificare (escape) le virgolette singole per espandere correttamente la variabile. Ad esempio, invece di '$User', usare '$($User -Replace "'","''")'. Non racchiudere valori interi o di sistema tra virgolette, ad esempio usare 500, $true, $falseo $null .

È possibile concatenare più criteri di ricerca usando gli operatori -and logici e -or. Ad esempio, "Criteria1 -and Criteria2" o "(Criteria1 -and Criteria2) -or Criteria3".

Per informazioni dettagliate sui filtri OPATH in Exchange, vedere Informazioni aggiuntive sulla sintassi 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

Il parametro Identity consente di specificare l'oggetto destinatario da visualizzare. È possibile utilizzare qualsiasi valore che identifichi il destinatario in modo univoco. Esempio:

  • Nome
  • Alias
  • Nome distinto (DN)
  • Nome distinto (DN)
  • Nome distinto canonico
  • GUID
Type:RecipientIdParameter
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

-IgnoreDefaultScope

Questo parametro è disponibile solo in Exchange locale.

L'opzione IgnoreDefaultScope indica al comando di ignorare l'impostazione dell'ambito del destinatario predefinito per la sessione di Exchange PowerShell e di usare l'intera foresta come ambito. Con questa opzione non è necessario specificare alcun valore.

Questa opzione consente al comando di accedere agli oggetti active directory attualmente non disponibili nell'ambito predefinito, ma introduce anche le restrizioni seguenti:

  • Non è possibile utilizzare il parametro DomainController. Il comando utilizza automaticamente un server di catalogo globale appropriato.
  • È possibile utilizzare solo il DN per il parametro Identity. Non vengono accettate altre forme di identificazione, ad esempio alias o GUID.
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

-IncludeBookmarkObject

Questo parametro è riservato all'uso interno da parte di Microsoft.

Type:Boolean
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

-IncludeSoftDeletedRecipients

L'opzione IncludeSoftDeletedRecipients specifica se includere i destinatari eliminati temporaneamente nei risultati. Con questa opzione non è necessario specificare alcun valore.

I destinatari eliminati temporaneamente sono destinatari eliminati che sono ancora recuperabili.

Nota: usare questa opzione con i parametri Identity o RecipientTypeDetails per ottenere softDeletedRecipients.

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

-OrganizationalUnit

Il parametro OrganizationalUnit filtra i risultati in base alla posizione dell'oggetto in Active Directory. Vengono restituiti solo gli oggetti presenti nella posizione specificata. L'input valido per questo parametro è un'unità organizzativa o un dominio restituito dal cmdlet Get-OrganizationalUnit. È possibile utilizzare qualsiasi valore che identifichi l'unità organizzativa o il dominio in modo univoco. Ad esempio:

  • Nome
  • Nome
  • Nome distinto (DN)
  • GUID
Type:OrganizationalUnitIdParameter
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, Exchange Online Protection

-Properties

Questo parametro è riservato all'uso interno da parte di Microsoft.

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

-PropertySet

Questo parametro è riservato all'uso interno da parte di Microsoft.

Type:PropertySet
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

-ReadFromDomainController

Questo parametro è disponibile solo in Exchange locale.

L'opzione ReadFromDomainController consente di specificare che le informazioni devono essere lette da un controller di dominio nel dominio dell'utente. Con questa opzione non è necessario specificare alcun valore.

Il comando: Set-AdServerSettings -ViewEntireForest $true per includere tutti gli oggetti nella foresta richiede l'opzione ReadFromDomainController. In caso contrario, il comando potrebbe usare un catalogo globale che contiene informazioni obsolete. Inoltre, potrebbe essere necessario eseguire più iterazioni del comando con l'opzione ReadFromDomainController per ottenere le informazioni.

Per impostazione predefinita, l'ambito del destinatario è impostato sul dominio che ospita i server di Exchange.

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

-RecipientPreviewFilter

Il parametro RecipientPreviewFilter testa un filtro destinatario che si userebbe in un gruppo di distribuzione dinamico, in un elenco di indirizzi o in un criterio di indirizzo di posta elettronica. Questo parametro usa la sintassi del filtro LDAP.

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

-RecipientType

Il parametro RecipientType filtra i risultati in base al tipo di destinatario specificato. I valori validi sono:

  • Dynamicdistributiongroup
  • Mailcontact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • UserMailbox

È possibile specificare più valori separati da virgole.

Type:RecipientType[]
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

-RecipientTypeDetails

Il parametro RecipientTypeDetails filtra i risultati in base al sottotipo di destinatario specificato. I valori validi sono:

  • DiscoveryMailbox
  • Dynamicdistributiongroup
  • EquipmentMailbox
  • GroupMailbox (Exchange 2013 o versione successiva e cloud)
  • GuestMailUser (Exchange 2016 o versione successiva e cloud)
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 o versione successiva e cloud)
  • Mailcontact
  • MailForestContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • PublicFolderMailbox (Exchange 2013 o versione successiva e cloud)
  • RemoteEquipmentMailbox
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox (Exchange 2013 o versione successiva e cloud)
  • RemoteUserMailbox
  • RoomList
  • RoomMailbox
  • SchedulingMailbox (Exchange 2016 o versione successiva e cloud)
  • SharedMailbox
  • SharedWithMailUser (solo cloud)
  • TeamMailbox (Exchange 2013 o versione successiva e cloud)
  • UserMailbox

È possibile specificare più valori separati da virgole.

Il valore del parametro RecipientType influisce sui valori che è possibile usare per questo parametro. Ad esempio, se si usa il valore RecipientType MailContact, non è possibile usare il valore UserMailbox per questo parametro. Verrà visualizzato l'errore: Nessuno dei recipientTypeDetail specificati è incluso in alcun tipo di destinatario specificato.

Type:RecipientTypeDetails[]
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

Il parametro ResultSize consente di specificare il numero massimo di risultati da restituire. Se si desidera restituire tutte le richieste che soddisfano la query, impostare questo parametro sul valore unlimited. Il valore predefinito è 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

-SortBy

Il parametro SortBy consente di specificare la proprietà in base a cui ordinare i risultati. È possibile ordinare in base a una sola proprietà alla volta. I risultati vengono visualizzati in ordine crescente.

Se la visualizzazione predefinita non include la proprietà per cui si esegue l'ordinamento, è possibile accodare il comando con | Format-Table -Auto Property1,Property2,...PropertyX. per creare una nuova visualizzazione che contiene tutte le proprietà che si desidera visualizzare. I caratteri jolly (*) nei nomi di proprietà sono supportati.

È possibile eseguire l'ordinamento in base alle seguenti proprietà:

  • Nome
  • DisplayName
  • Alias
  • Città
  • FirstName
  • LastName
  • Office
  • ServerLegacyDN
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

Input

Input types

Per verificare i tipi di input accettati da questo cmdlet, vedere Tipi di input e output dei cmdlet. Se il campo relativo al tipo di input di un cmdlet è vuoto, il cmdlet non accetta dati di input.

Output

Output types

Per verificare i tipi restituiti, detti anche tipi di output, accettati da questo cmdlet, vedere Tipi di input e output dei cmdlet. Se il campo relativo al tipo di output è vuoto, il cmdlet non restituisce dati.