Get-EXORecipient
Dieses Cmdlet ist nur im Exchange Online PowerShell-Modul verfügbar. Weitere Informationen finden Sie unter Informationen zum Exchange Online PowerShell-Moduls.
Verwenden Sie das Cmdlet Get-EXORecipient, um vorhandene Empfängerobjekte in Ihrem organization anzuzeigen. Dieses Cmdlet gibt alle E-Mail-aktivierten Objekte (z. B. Postfächer, E-Mail-Benutzer, E-Mail-Kontakte und Verteilergruppen) zurück.
Informationen zu den Parametersätzen im Abschnitt zur Syntax weiter unten finden Sie unter Syntax der Exchange-Cmdlets.
Syntax
Get-EXORecipient
[[-Identity] <String>]
[-ExternalDirectoryObjectId <Guid>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-PrimarySmtpAddress <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-UserPrincipalName <String>]
[<CommonParameters>]
Get-EXORecipient
[-Anr <String>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Beschreibung
Get-EXORecipient Cmdlet kann verwendet werden, um vorhandene Empfängerobjekte in Ihrem organization anzuzeigen. Dieses Cmdlet gibt alle E-Mail-aktivierten Objekte (z. B. Postfächer, E-Mail-Benutzer, E-Mail-Kontakte und Verteilergruppen) zurück.
Beispiele
Beispiel 1
Get-EXORecipient -ResultSize 100
In diesem Beispiel werden die ersten 100 Empfängerobjekte in sortierter Reihenfolge des Namens zurückgegeben.
Beispiel 2
Get-EXORecipient -Identity john@contosot.com
In diesem Beispiel werden die Empfängerattributdetails für den Benutzer zurückgegeben. john@contoso.com
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
Sie können diesen Parameter nicht mit den Parametern ExternalDirectoryObjectId, Identity, PrimarySmtpAddress oder UserPrincipalName verwenden.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-ExternalDirectoryObjectId
Der Parameter ExternalDirectoryObjectId identifiziert den Empfänger, den Sie anzeigen möchten, anhand der ObjectId in Microsoft Entra ID.
Sie können diesen Parameter nicht mit den Parametern Anr, Identity, PrimarySmtpAddress oder UserPrincipalName verwenden.
Typ: | Guid |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-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
,$false
oder$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 finden Sie unter Get-EXORecipient-Eigenschaftensätze und 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 beispielsweise500
$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.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-Identity
Der Parameter Identity gibt das Empfängerobjekt an, das angezeigt werden soll. Um die beste Leistung zu erzielen, wird empfohlen, die folgenden Werte zum Identifizieren des Empfängers zu verwenden:
- Benutzer-ID oder User Principal Name (UPN)
- GUID
Andernfalls können Sie einen beliebigen Wert verwenden, der den Empfänger eindeutig identifiziert. Zum Beispiel:
- Name
- Alias
- Distinguished Name (DN)
- Domäne\Benutzername
- E-Mail-Adresse
- LegacyExchangeDN
- SamAccountName
Sie können diesen Parameter nicht mit den Parametern Anr, ExternalDirectoryObjectId, PrimarySmtpAddress oder UserPrincipalName verwenden.
Typ: | String |
Position: | 0 |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-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.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-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 oder Domäne, die mithilfe des Cmdlets Get-OrganizationalUnit sichtbar ist. Sie können jeden beliebigen Wert verwenden, sofern er die Organisationseinheit oder Domäne eindeutig kennzeichnet. Beispiel:
- Name
- Name
- Distinguished Name (DN)
- GUID
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-PrimarySmtpAddress
PrimarySmtpAddress identifiziert den Empfänger, den Sie anzeigen möchten, navin@contoso.comanhand der primären SMTP-E-Mail-Adresse (z. B. ).
Sie können diesen Parameter nicht mit den Parametern Anr, ExternalDirectoryObjectId, Identity oder UserPrincipalName verwenden.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-Properties
Der Properties-Parameter gibt die Eigenschaften an, die in der Ausgabe dieses Cmdlets zurückgegeben werden. Es können mehrere Werte durch Kommata getrennt angegeben werden.
Weitere Informationen zu den verfügbaren Eigenschaften finden Sie unter Get-EXORecipient-Eigenschaftensätze.
Typ: | String[] |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-PropertySets
Der Parameter PropertySets gibt eine logische Gruppierung von Eigenschaften an, die in der Ausgabe dieses Cmdlets zurückgegeben werden. Gültige Werte sind:
- Minimum (dies ist der Standardwert)
- Archivieren
- Benutzerdefiniert
- MailboxMove
- Richtlinie
Weitere Informationen zu den Eigenschaften, die in den einzelnen Eigenschaftensätzen enthalten sind, finden Sie unter Get-EXORecipient-Eigenschaftensätze.
Typ: | PropertySet[] |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-RecipientPreviewFilter
Dieser Parameter ist für die interne Verwendung durch Microsoft reserviert.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-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.
Typ: | String[] |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-RecipientTypeDetails
Der Parameter RecipientTypeDetails filtert die Ergebnisse nach dem angegebenen Empfängeruntertyp. Gültige Werte sind:
- DiscoveryMailbox
- DynamicDistributionGroup
- EquipmentMailbox
- GroupMailbox
- GuestMailUser
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox
- SharedMailbox
- SharedWithMailUser
- TeamMailbox
- 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.
Typ: | String[] |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-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.
Typ: | Unlimited |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |
-UserPrincipalName
Der UserPrincipalName-Parameter identifiziert den Empfänger, den Sie nach UPN anzeigen möchten (z. B navin@contoso.onmicrosoft.com. ).
Sie können diesen Parameter nicht mit den Parametern Anr, ExternalDirectoryObjectId, Identity oder PrimarySmtpAddress verwenden.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
Gilt für:: | Exchange Online |