Get-Recipient
Dieses Cmdlet ist der lokalen Bereitstellung von Exchange und im cloudbasierten Dienst verfügbar. Einige Parameter und Einstellungen gelten exklusiv für die eine oder andere Umgebung.
Verwenden Sie das Cmdlet Get-Recipient, um vorhandene Empfängerobjekte in Ihrer Organisation anzuzeigen. Dieses Cmdlet gibt alle E-Mail-aktivierten Objekte (z. B. Postfächer, E-Mail-Benutzer, E-Mail-Kontakte und Verteilergruppen) zurück.
Hinweis: In Exchange Online PowerShell wird empfohlen, anstelle dieses Cmdlets das Cmdlet Get-EXORecipient zu verwenden. Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Exchange Online PowerShell.
Um in Cloudumgebungen Microsoft 365-Gruppen zurückzugeben, müssen Sie den RecipientTypeDetails-Parameter mit dem Wert GroupMailbox verwenden.
Informationen zu den Parametersätzen im Abschnitt zur Syntax weiter unten finden Sie unter Syntax der Exchange-Cmdlets.
Syntax
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>]Beschreibung
Das Cmdlet Get-Recipient gibt möglicherweise nicht alle objektspezifischen Eigenschaften für einen Empfänger zurück. Um die objektspezifischen Eigenschaften für einen Empfänger anzuzeigen, müssen Sie das entsprechende Cmdlet basierend auf dem Objekttyp (z. B. Get-Mailbox, Get-MailUser oder Get-DistributionGroup) verwenden.
Bevor Sie dieses Cmdlet ausführen können, müssen Ihnen die entsprechenden Berechtigungen zugewiesen werden. Auch wenn in diesem Thema alle Parameter für das Cmdlet aufgeführt werden, verfügen Sie möglicherweise nicht über den Zugriff auf einige Parameter, wenn sie nicht in den Ihnen zugewiesenen Berechtigungen enthalten sind. Wie Sie herausfinden, welche Berechtigungen zur Ausführung eines bestimmten Cmdlets oder Parameters in Ihrer Organisation erforderlich sind, können Sie unter Find the permissions required to run any Exchange cmdlet nachlesen.
Beispiele
Beispiel 1
Get-Recipient -ResultSize unlimitedIn diesem Beispiel wird eine Zusammenfassungsliste aller Empfänger in Ihrer Organisation abgerufen.
Beispiel 2
Get-Recipient -Identity "Marketing Department" | Format-ListIn diesem Beispiel werden ausführliche Informationen für den Empfänger mit dem Namen Marketing Department zurückgegeben.
Beispiel 3
Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,NameIn diesem Beispiel werden Informationen zu allen E-Mail-Kontakten in Ihrer Organisation abgerufen und nach ihren Abteilungen sortiert.
Parameter
-Anr
Der Parameter Anr gibt eine Zeichenfolge an, für die eine Suche zur Auflösung eines nicht eindeutigen Namens (Ambiguous Name Resolution, ANR) durchgeführt wird. Sie können eine Teilzeichenfolge angeben und nach Objekten mit einem Attribut suchen, das der Zeichenfolge entspricht. Die gesuchten Standardattribute umfassen:
- 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
Dieser Parameter ist nur im cloudbasierten Dienst verfügbar.
Der Parameter AuthenticationType gibt den Empfänger nach Authentifizierungstyp zurück. Verwenden Sie einen der folgenden Werte:
- Federated
- Verwaltet
| 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
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| 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
Dieser Parameter ist nur im cloudbasierten Dienst verfügbar.
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| 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
Dieser Parameter ist nur im lokalen Exchange verfügbar.
Der Parameter Credential gibt den Benutzernamen und das Kennwort an, die zum Ausführen dieses Befehls verwendet werden. Normalerweise verwenden Sie diesen Parameter in Skripts oder wenn Sie unterschiedliche Anmeldeinformationen bereitstellen müssen, die über die erforderlichen Berechtigungen verfügen.
Ein Wert für diesen Parameter setzt das Cmdlet "Get-Credential" voraus. Verwenden Sie den Wert (Get-Credential), um diesen Befehl anzuhalten und eine Aufforderung zur Eingabe von Anmeldeinformationen zu erhalten. Oder speichern Sie die Anmeldeinformationen in einer Variablen (beispielsweise $cred = Get-Credential), bevor Sie diesen Befehl ausführen, und verwenden Sie dann den Variablennamen ($cred) für diesen Parameter. Weitere Informationen finden Sie unter 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
Dieser Parameter ist nur im lokalen Exchange verfügbar.
Der Database-Parameter gibt alle Empfänger zurück, die in der angegebenen Postfachdatenbank gespeichert sind. Sie können jeden beliebigen Wert verwenden, sofern er die Datenbank eindeutig kennzeichnet. Beispiel:
- Name
- Distinguished Name (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
Dieser Parameter ist im lokalen Exchange verfügbar.
Der Parameter "DomainController" gibt den Domänencontroller an, der von diesem Cmdlet verwendet wird, um aus Active Directory Daten zu lesen oder hineinzuschreiben. Der Domänencontroller kann anhand seines vollqualifizierten Domänennamens (Fully Qualified Domain Name, FQDN) ermittelt werden. Beispiel: 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
Der Parameter Filter verwendet die OPATH-Syntax, um die Ergebnisse nach den angegebenen Eigenschaften und Werten zu filtern. Das Suchkriterium verwendet die Syntax "Property -ComparisonOperator 'Value'".
- Schließen Sie den gesamten OPATH-Filter in doppelte Anführungszeichen " ein. Wenn der Filter Systemwerte enthält (z. B.
$true,$falseoder$null), verwenden Sie stattdessen einfache Anführungszeichen ''. Obwohl dieser Parameter eine Zeichenfolge ist (kein Systemblock), können Sie auch geschweifte Klammern { } verwenden, jedoch nur, wenn der Filter keine Variablen enthält. - Eigenschaft ist eine filterbare Eigenschaft. Weitere Informationen zu den filterbaren Eigenschaften in Exchange Server und Exchange Online finden Sie unter Filterbare Eigenschaften für den Filter-Parameter.
- ComparisonOperator ist ein OPATH-Vergleichsoperator (z. B
-eq. für gleich und-likefür den Zeichenfolgenvergleich). Weitere Informationen über Vergleichsoperatoren finden Sie unter about_Comparison_Operators. - Wert ist der zu suchende Eigenschaftswert. Fügen Sie Textwerte und Variablen in einfache Anführungszeichen (
'Value'oder'$Variable') ein. Wenn ein Variablenwert einfache Anführungszeichen enthält, müssen Sie die einfachen Anführungszeichen identifizieren (escape), um die Variable korrekt zu erweitern. Sie können z. B.'$($User -Replace "'","''")'anstelle von'$User'verwenden. Schließen Sie keine ganzen Zahlen oder Systemwerte in Anführungszeichen ein (verwenden Sie stattdessen beispielsweise500$true,$falseoder$null).
Sie können mehrere Suchkriterien mithilfe der logischen Operatoren -and und -or miteinander verketten. Zum Beispiel "Criteria1 -and Criteria2" oder "(Criteria1 -and Criteria2) -or Criteria3".
Ausführliche Informationen zu OPATH-Filtern in Exchange finden Sie unter Zusätzliche Informationen zur OPATH-Syntax.
| 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
Der Parameter Identity gibt das Empfängerobjekt an, das angezeigt werden soll. Sie können jeden Wert verwenden, der den Empfänger eindeutig bestimmt. Beispiel:
- Name
- Alias
- Distinguished Name (DN)
- Distinguished Name (DN)
- Kanonischer DN
- 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
Dieser Parameter ist nur im lokalen Exchange verfügbar.
Die Option IgnoreDefaultScope weist den Befehl an, die Standardeinstellung für den Empfängerbereich für die Exchange PowerShell-Sitzung zu ignorieren und die komplette Gesamtstruktur als Bereich zu verwenden. Sie müssen keinen Wert für diese Option angeben.
Dieser Switch ermöglicht dem Befehl den Zugriff auf Active Directory-Objekte, die derzeit nicht im Standardbereich verfügbar sind, führt aber auch die folgenden Einschränkungen ein:
- Sie können den Parameter DomainController nicht verwenden. Der Befehl verwendet automatisch einen geeigneten globalen Katalogserver.
- Sie können nur den DN für den Identitätsparameter verwenden. Andere Formen der Identifikation wie Aliasnamen oder GUIDs werden nicht akzeptiert.
| 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
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| 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
Die Option IncludeSoftDeletedRecipients gibt an, ob vorläufig gelöschte Empfänger in die Ergebnisse eingeschlossen werden sollen. Sie müssen keinen Wert für diese Option angeben.
Vorläufig gelöschte Empfänger sind gelöschte Empfänger, die noch wiederhergestellt werden können.
Hinweis: Verwenden Sie diesen Schalter mit den Parametern Identity oder RecipientTypeDetails, um die SoftDeletedRecipients abzurufen.
| 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
Der OrganizationalUnit-Parameter filtert die Ergebnisse basierend auf dem Speicherort des Objekts in Active Directory. Es werden nur Objekte zurückgegeben, die am angegebenen Speicherort vorhanden sind. Eine gültige Eingabe für diesen Parameter ist eine Organisationseinheit (OU) oder Domäne, die vom Cmdlet Get-OrganizationalUnit zurückgegeben wird. Sie können jeden beliebigen Wert verwenden, sofern er die Organisationseinheit oder Domäne eindeutig kennzeichnet. Beispiel:
- Name
- Name
- Distinguished Name (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
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| 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
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
| 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
Dieser Parameter ist nur im lokalen Exchange verfügbar.
Die Option ReadFromDomainController gibt an, dass Informationen von einem Domänencontroller in der Domäne des Benutzers gelesen werden sollen. Sie müssen keinen Wert für diese Option angeben.
Der Befehl Set-AdServerSettings -ViewEntireForest $true zum Einschließen aller Objekte in der Gesamtstruktur erfordert den ReadFromDomainController-Switch. Andernfalls könnte der Befehl einen globalen Katalog verwenden, der veraltete Informationen enthält. Außerdem müssen Sie möglicherweise mehrere Iterationen des Befehls mit dem ReadFromDomainController-Switch ausführen, um die Informationen abzurufen.
Standardmäßig ist der Empfängerbereich auf die Domäne festgelegt, in der sich Ihre Exchange-Server befinden.
| 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
Der Parameter RecipientPreviewFilter testet einen Empfängerfilter, den Sie in einer dynamischen Verteilergruppe, Adressliste oder E-Mail-Adressrichtlinie verwenden würden. Dieser Parameter verwendet die LDAP-Filtersyntax.
| 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
Der Parameter RecipientType filtert die Ergebnisse nach angegebenem Empfängertyp. Gültige Werte sind:
- DynamicDistributionGroup
- MailContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- UserMailbox
Es können mehrere Werte durch Kommata getrennt angegeben werden.
| 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
Der Parameter RecipientTypeDetails filtert die Ergebnisse nach dem angegebenen Empfängeruntertyp. Gültige Werte sind:
- DiscoveryMailbox
- DynamicDistributionGroup
- EquipmentMailbox
- GroupMailbox (Exchange 2013 oder höher und Cloud)
- GuestMailUser (Exchange 2016 oder höher und Cloud)
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox (Exchange 2013 oder höher und Cloud)
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox (Exchange 2013 oder höher und Cloud)
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox (Exchange 2013 oder höher und Cloud)
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox (Exchange 2016 oder höher und Cloud)
- SharedMailbox
- SharedWithMailUser (nur Cloud)
- TeamMailbox (Exchange 2013 oder höher und Cloud)
- UserMailbox
Es können mehrere Werte durch Kommata getrennt angegeben werden.
Der Wert des RecipientType-Parameters hat Auswirkungen auf die Werte, die Sie für diesen Parameter verwenden können. Wenn Sie beispielsweise den RecipientType-Wert MailContact verwenden, können Sie nicht den UserMailbox-Wert für diesen Parameter verwenden. Es wird die folgende Fehlermeldung angezeigt: None of the specified RecipientTypeDetails are included in any specified recipient type.
| 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
Der ResultSize-Parameter gibt die maximale Anzahl von zurückzugebenden Ergebnissen an. Wenn Sie alle Anforderungen zurückgeben möchten, die der Abfrage entsprechen, verwenden Sie unlimited als Wert für diesen Parameter. Der Standardwert ist 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
Der Parameter SortBy gibt die Eigenschaft an, nach der die Ergebnisse sortiert werden sollen. Sie können die Sortierung nur jeweils nach einer Eigenschaft vornehmen. Die Ergebnisse werden in absteigender Reihenfolge sortiert.
Wenn die Standardansicht die Eigenschaft, nach der Sie sortieren, nicht enthält, können Sie den Befehl mit | Format-Table -Auto Property1,Property2,...PropertyX anhängen. um eine neue Ansicht zu erstellen, die alle Eigenschaften enthält, die Sie sehen möchten. Platzhalter (*) in den Eigenschaftsnamen werden unterstützt.
Nach den folgende Eigenschaften kann sortiert werden:
- Name
- DisplayName
- Alias
- Stadt/Ort
- 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 |
Eingaben
Input types
Eingabetypen, die dieses Cmdlet akzeptiert, finden Sie unter Eingabe- und Ausgabetypen für Cmdlets. Wenn das Feld mit dem Eingabetyp für ein Cmdlet leer ist, akzeptiert das Cmdlet diese Eingabedaten nicht.
Ausgaben
Output types
Informationen zu den Rückgabetypen, die auch als Ausgabetypen bezeichnet werden, die dieses Cmdlet akzeptiert, finden Sie unter Cmdlet Input and Output Types. Wenn das Feld Ausgabetyp leer ist, gibt das Cmdlet keine Daten zurück.