Nawigowanie po module Microsoft Entra PowerShell

Microsoft Entra powerShell to zaawansowane narzędzie do zarządzania zasobami Entra i administrowania nimi bezpośrednio z poziomu programu PowerShell.

Ten artykuł ułatwia nawigowanie po module i przedstawienie podstawowych pojęć.

Prerequisites

Zaloguj się

Każde polecenie cmdlet w programie Microsoft Entra PowerShell jest chronione przez co najmniej jeden zakres uprawnień. Aby używać programu Microsoft Entra PowerShell, użytkownicy, którzy się logują, muszą wyrazić zgodę na wymagane zakresy uprawnień dla polecenia cmdlet, którego zamierzają użyć. Określ uprawnienia w poleceniu cmdlet Connect-Entra. Zaloguj się przy użyciu konta administratora dzierżawy, jeśli zostanie wyświetlony monit.

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

Microsoft Entra program PowerShell obsługuje dwa typy uwierzytelniania: dostęp delegowany i dostęp tylko do aplikacji. Aby wyświetlić wszystkie możliwe opcje, zapoznaj się ze scenariuszami uwierzytelniania.

Znajdowanie dostępnych poleceń

Polecenia cmdlet Microsoft Entra dla programu PowerShell są zgodne ze standardową konwencją nazewnictwa programu PowerShell, Verb-Noun. Czasownik opisuje akcję (przykłady obejmują , , NewGet, Set) i rzeczownik opisuje typ zasobu (przykłady to RemoveUser, Group, ServicePrincipal, Device). Rzeczowniki w module Microsoft Entra PowerShell zawsze rozpoczynają się prefiksem Entra. Aby uzyskać pełną listę standardowych czasowników, zobacz zatwierdzone czasowniki dla poleceń programu PowerShell.

Note

W przypadku poleceń cmdlet Beta dodaj prefiks Beta do nazwy zasobu. Na przykład w wersji Beta użyj Get-EntraBetaUser zamiast Get-EntraUser.

Listę wszystkich dostępnych poleceń w module PowerShell Microsoft Entra można uzyskać za pomocą następującego polecenia:

Get-Command -Module Microsoft.Entra*

Aby zawęzić to, na przykład, aby znaleźć polecenia związane z aplikacjami, uruchom następujące polecenie.

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

To polecenie wyświetla wszystkie polecenia cmdlet, funkcje i aliasy zawarte w module zasobu aplikacji.

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

Wyświetlanie obsługiwanych właściwości i metod dla polecenia

Aby wyświetlić więcej właściwości poza domyślnymi danymi wyjściowymi, uruchom następujące polecenie, aby wyświetlić wszystkie obsługiwane właściwości:

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

To polecenie wyświetla wszystkie właściwości i metody użytkownika.

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

Uzyskaj pomoc

Aby znaleźć pomoc dotyczącą poleceń cmdlet programu Microsoft Entra PowerShell, użyj Get-Help polecenia , aby uzyskać szczegółową pomoc dotyczącą określonych poleceń, w tym ich składni, parametrów i przykładów użycia. Aby na przykład dowiedzieć się więcej o poleceniu Get-EntraUser , uruchom następujące polecenie.

Get-Help Get-EntraUser -Detailed

To polecenie zawiera szczegółową dokumentację pomocy, w tym opis polecenia cmdlet, parametry, przykłady użycia i powiązane polecenia, pomagając zrozumieć, jak efektywnie używać go w różnych scenariuszach.

Poznaj podstawy

Skorzystaj z praktycznych instrukcji dotyczących programu Microsoft Entra PowerShell, korzystając z naszych szczegółowych przewodników z instrukcjami:

  • Last updated on