Navigieren im PowerShell-Modul Microsoft Entra

Microsoft Entra PowerShell ist ein leistungsstarkes Tool zum Verwalten und Administrieren von Entra-Ressourcen direkt in PowerShell.

Dieser Artikel hilft Ihnen beim Navigieren im Modul und beschreibt seine Kernkonzepte.

Voraussetzungen

Anmelden

Jedes Cmdlet in Microsoft Entra PowerShell ist durch einen oder mehrere Berechtigungsbereiche geschützt. Um Microsoft Entra PowerShell zu verwenden, müssen Benutzer, die sich anmelden, den erforderlichen Berechtigungsbereichen für das Cmdlet zustimmen, das sie verwenden möchten. Geben Sie die Berechtigungen im Connect-Entra Cmdlet an. Melden Sie sich bei Aufforderung mit einem Administratorkonto für Ihren Mandanten an.

Connect-Entra -Scopes 'User.Read.All'

Microsoft Entra PowerShell unterstützt zwei Authentifizierungstypen: delegierter Zugriff und nur App-Zugriff. Informationen zu allen möglichen Optionen finden Sie in den Authentifizierungsszenarien.

Verfügbare Befehle suchen

Microsoft Entra PowerShell-Cmdlets folgen einer Standardbenennungskonvention für PowerShell. Verb-Noun Das Verb beschreibt die Aktion (Beispiele: New, , GetSet, Remove, ) und das Substantiv beschreibt den Ressourcentyp (Beispiele sind User, , Group, ServicePrincipal). Device Substantive in Microsoft Entra PowerShell beginnen immer mit dem PräfixEntra. Die vollständige Liste der Standardverben finden Sie in den genehmigten Verben für PowerShell-Befehle.

Hinweis

Fügen Sie für Beta-Cmdlets dem Ressourcennamen ein Betapräfix hinzu. Zum Beispiel verwenden Sie Get-EntraBetaUser anstelle von Get-EntraUser für die Betaversion.

Mit dem folgenden Befehl können Sie alle verfügbaren Befehle in Microsoft Entra PowerShell-Modul abrufen:

Get-Command -Module Microsoft.Entra*

Um dies beispielsweise einzugrenzen, führen Sie den folgenden Befehl aus, um Befehle im Zusammenhang mit Anwendungen zu finden.

Get-Command -Module Microsoft.Entra* -Noun *application*

Dieser Befehl zeigt alle Cmdlets, Funktionen und Aliase an, die im Modul für die Anwendungsressource enthalten sind.

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Function        Add-EntraApplicationOwner                          1.0.1     Microsoft.Entra
Function        Get-EntraApplication                               1.0.1     Microsoft.Entra
Function        Get-EntraApplicationExtensionProperty              1.0.1     Microsoft.Entra
Function        Get-EntraApplicationKeyCredential                  1.0.1     Microsoft.Entra
Function        Get-EntraApplicationLogo                           1.0.1     Microsoft.Entra
Function        Get-EntraApplicationOwner                          1.0.1     Microsoft.Entra
Function        Get-EntraApplicationPasswordCredential             1.0.1     Microsoft.Entra

Anzeigen unterstützter Eigenschaften und Methoden für einen Befehl

Um weitere Eigenschaften über die Standardausgabe hinaus anzuzeigen, führen Sie den folgenden Befehl aus, um alle unterstützten Eigenschaften anzuzeigen:

Get-EntraUser -UserId 'rsmith@contoso.com' | Get-Member

Mit diesem Befehl werden alle Benutzereigenschaften und -methoden angezeigt.

accountEnabled                        NoteProperty          bool accountEnabled=True
ageGroup                              NoteProperty          object ageGroup=null
businessPhones                        NoteProperty          Object[]
city                                  NoteProperty          string city=Bellevue
companyName                           NoteProperty          object companyName=null
consentProvidedForMinor               NoteProperty          object
country                               NoteProperty          string
createdDateTime                       NoteProperty          datetime createdDateTime
creationType                          NoteProperty          object creationType=null
deletedDateTime                       NoteProperty          object deletedDateTime=null
DeletionTimestamp                     NoteProperty          object DeletionTimestamp=null
department                            NoteProperty          string department=Retail
DirSyncEnabled                        NoteProperty          object DirSyncEnabled=null
displayName                           NoteProperty          string displayName=Adele Vance
employeeHireDate                      NoteProperty          object employeeHireDate=null
employeeId                            NoteProperty          object employeeId=null
employeeLeaveDateTime                 NoteProperty          object employeeLeaveDateTime=null
employeeOrgData                       NoteProperty          object employeeOrgData=null
employeeType                          NoteProperty          object employeeType=null

Hilfe erhalten

Um Hilfe zu den Microsoft Entra PowerShell-Cmdlets zu finden, verwenden Sie Get-Help den Befehl, um detaillierte Hilfe zu bestimmten Befehlen zu erhalten, einschließlich ihrer Syntax, Parameter und Verwendungsbeispiele. Um beispielsweise mehr über den Get-EntraUser Befehl zu erfahren, führen Sie den folgenden Befehl aus.

Get-Help Get-EntraUser -Detailed

Dieser Befehl liefert eine ausführliche Hilfedokumentation, einschließlich der Beschreibung des Cmdlets, der Parameter, von Verwendungsbeispielen und verwandten Befehlen, und hilft Ihnen dabei, zu verstehen, wie Sie es in verschiedenen Szenarien effektiv einsetzen.

Erfahren Sie mehr über die Grundlagen

Machen Sie sich mit Microsoft Entra PowerShell in unseren detaillierten Anleitungen vertraut: