Get-SecurityPrincipal
Dieses Cmdlet ist der lokalen Bereitstellung von Exchange und im cloudbasierten Dienst verfügbar. Einige Parameter und Einstellungen können für die eine oder die andere Umgebung exklusiv sein.
Verwenden Sie das Cmdlet Get-SecurityPrincipal, um eine Liste von Sicherheitsprinzipalen zurückzugeben. Sicherheitsprinzipale sind Entitäten, z. B. Benutzer oder Sicherheitsgruppen, denen Berechtigungen und Benutzerrechte zugewiesen werden können.
Informationen zu den Parametersätzen im Abschnitt zur Syntax weiter unten finden Sie unter Syntax der Exchange-Cmdlets.
Syntax
Default (Standardwert)
Get-SecurityPrincipal
[[-Identity] <ExtendedSecurityPrincipalIdParameter>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IncludeDomainLocalFrom <SmtpDomain>]
[-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-RoleGroupAssignable]
[-Types <MultiValuedProperty>]
[<CommonParameters>]
Beschreibung
Das Cmdlet Get-SecurityPrincipal wird vom Exchange Admin Center verwendet, um Felder aufzufüllen, in denen Empfängerinformationen angezeigt werden.
Bevor Sie dieses Cmdlet ausführen können, müssen Ihnen die entsprechenden Berechtigungen zugewiesen werden. Obwohl in diesem Artikel alle Parameter für das Cmdlet aufgeführt sind, haben Sie möglicherweise keinen 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-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com
In diesem Beispiel werden Sicherheitsprinzipale aus der organisationseinheit Personen abgerufen.
Beispiel 2
Get-SecurityPrincipal -Filter "Department -eq 'Legal'"
In diesem Beispiel werden Sicherheitsprinzipale aus der Rechtsabteilung mithilfe des Filter-Parameters abgerufen. Es werden nur Sicherheitsprinzipale abgerufen, die der Filterbedingung entsprechen.
Beispiel 3
Get-SecurityPrincipal -Identity Administrator
In diesem Beispiel wird ein einzelner Sicherheitsprinzipal abgerufen, der explizit mit dem Identity-Parameter angegeben wird.
Beispiel 4
Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize
In diesem Beispiel werden bekannte Sicherheitsprinzipale abgerufen und nur die Eigenschaften Name und SID in den Ergebnissen angezeigt.
Parameter
-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
| Typ: | Fqdn |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Filter
Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection
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.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Identity
Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection
Der Parameter Identity gibt den Sicherheitsprinzipal an. Wenn der Sicherheitsprinzipal explizit mithilfe dieses Parameters angegeben wird, werden keine zusätzlichen Sicherheitsprinzipale zurückgegeben.
Parametereigenschaften
| Typ: | ExtendedSecurityPrincipalIdParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 1 |
| Obligatorisch.: | False |
| Wert aus Pipeline: | True |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | True |
| Wert aus verbleibenden Argumenten: | False |
-IncludeDomainLocalFrom
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 IncludeDomainLocalFrom-Parameter gibt an, ob lokale Domänengruppen aus dem FQDN der angegebenen Active Directory-Domäne (z. B. contoso.com) in den Ergebnissen zurückgegeben werden sollen.
Verwenden Sie diesen Parameter nicht mit den Parametern Filter oder Identity.
Parametereigenschaften
| Typ: | SmtpDomain |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-OrganizationalUnit
Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection
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
| Typ: | ExtendedOrganizationalUnitIdParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-ResultSize
Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection
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
| Typ: | Unlimited |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-RoleGroupAssignable
Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection
Der Switch RoleGroupAssignable filtert Sicherheitsprinzipale, indem nur Objekte zurückgegeben werden, die einer RBAC-Rollengruppe zugewiesen werden können. Sie müssen keinen Wert für diese Option angeben.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Types
Anwendbar: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Security & Compliance, Exchange Online Protection
Der Types-Parameter filtert die Ergebnisse nach Objekttyp. Gültige Werte sind:
- Computer
- GlobalSecurityGroup
- Gruppe
- UniversalSecurityGroup
- Benutzer
- WellknownSecurityPrincipal
Es können mehrere Werte durch Kommata getrennt angegeben werden.
Parametereigenschaften
| Typ: | MultiValuedProperty |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen finden Sie unter about_CommonParameters.
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 und die von diesem Cmdlet akzeptiert werden, finden Sie unter Eingabe- und Ausgabetypen von Cmdlets. Wenn das Feld mit dem Ausgabetyp leer ist, gibt das Cmdlet keine Daten zurück.