Get-Recipient

Syntax

AnrSet

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[]>]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

Identity

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[]>]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [<CommonParameters>]

DatabaseSet

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>]

RecipientPreviewFilterSet

Get-Recipient
    [-RecipientPreviewFilter <String>]
    [-AuthenticationType <AuthenticationType>]
    [-Capabilities <MultiValuedProperty>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeManagerWithDisplayName]
    [-IncludeSoftDeletedRecipients]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-Properties <String[]>]
    [-PropertySet <PropertySet>]
    [-ReadFromDomainController]
    [-RecipientType <RecipientType[]>]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [<CommonParameters>]

Beschreibung

Beispiele

Beispiel 1

Get-Recipient -ResultSize unlimited

Beispiel 2

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

Beispiel 3

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

Parameter

-Anr

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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

Parametereigenschaften

Parametersätze

-AuthenticationType

Anwendbar: Exchange Online, Security & Compliance, Integriertes Sicherheits-Add-On für lokale Postfächer

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

Parametereigenschaften

Parametersätze

-BookmarkDisplayName

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.

Parametereigenschaften

Parametersätze

-Capabilities

Anwendbar: Exchange Online, Security & Compliance, Integriertes Sicherheits-Add-On für lokale Postfächer

Dieser Parameter ist nur im cloudbasierten Dienst verfügbar.

Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.

Parametereigenschaften

Parametersätze

-Credential

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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.

Parametereigenschaften

Parametersätze

-Database

Anwendbar: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Dieser Parameter ist 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

Parametereigenschaften

Parametersätze

-DomainController

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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.

Parametereigenschaften

Parametersätze

-Filter

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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 -like fü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 beispielsweise 500$true, $false oder $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.

Parametereigenschaften

Parametersätze

-Identity

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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

Achtung: Der Wert $null oder ein nicht vorhandener Wert für den Identity-Parameter gibt alle Objekte zurück, als ob Sie den Get-Befehl ohne den Identity-Parameter ausgeführt haben. Vergewissern Sie sich, dass listen von Werten für den Identity-Parameter korrekt sind und keine nicht vorhandenen $null-Werte enthalten.

Parametereigenschaften

Parametersätze

-IgnoreDefaultScope

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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.

Parametereigenschaften

Parametersätze

-IncludeBookmarkObject

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.

Parametereigenschaften

Parametersätze

-IncludeManagerWithDisplayName

Anwendbar: Exchange Online, integriertes Sicherheits-Add-On für lokale Postfächer

Dieser Parameter ist nur im cloudbasierten Dienst verfügbar.

{{ Fill IncludeManagerWithDisplayName Description }}

Parametereigenschaften

Parametersätze

-IncludeSoftDeletedRecipients

Anwendbar: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Integriertes Sicherheits-Add-On für lokale Postfächer

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.

Parametereigenschaften

Parametersätze

-OrganizationalUnit

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Integriertes Sicherheits-Add-On für lokale Umgebungen Postfächer

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

Parametereigenschaften

Parametersätze

-Properties

Anwendbar: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integriertes Sicherheits-Add-On für lokale Postfächer

Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.

Parametereigenschaften

Parametersätze

-PropertySet

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.

Parametereigenschaften

Parametersätze

-ReadFromDomainController

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

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.

Parametereigenschaften

Parametersätze

-RecipientPreviewFilter

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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.

Parametereigenschaften

Parametersätze

-RecipientType

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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.

Parametereigenschaften

Parametersätze

-RecipientTypeDetails

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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. Sie erhalten den Folgenden Fehler: Keine der angegebenen RecipientTypeDetails sind in einem angegebenen Empfängertyp enthalten.

Parametereigenschaften

Parametersätze

-ResultSize

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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.

Parametereigenschaften

Parametersätze

-SortBy

Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Integrierte Sicherheit Add-On für lokale Postfächer

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
• FirstName
• LastName
• Office
• ServerLegacyDN

Parametereigenschaften

Parametersätze

CommonParameters

Eingaben

Input types

Ausgaben

Output types