Navigera i Microsoft Entra PowerShell-modulen

Microsoft Entra PowerShell är ett kraftfullt verktyg för att hantera och administrera Entra-resurser direkt från PowerShell.

Den här artikeln hjälper dig att navigera i modulen och beskriver dess grundläggande begrepp.

Förutsättningar

Logga in

Varje cmdlet i Microsoft Entra PowerShell skyddas av en eller flera behörighetsomfång. Om du vill använda Microsoft Entra PowerShell måste användare som loggar in samtycka till de behörighetsomfång som krävs för den cmdlet som de planerar att använda. Ange behörigheterna i cmdleten Connect-Entra . Logga in med ett administratörskonto för din klientorganisation om du uppmanas att göra det.

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

Microsoft Entra PowerShell stöder två typer av autentisering: delegerad åtkomst och åtkomst endast för appar. Om du vill se alla möjliga alternativ läser du autentiseringsscenarierna.

Hitta tillgängliga kommandon

Microsoft Entra PowerShell-cmdletar följer en standardnamnkonvention för PowerShell, Verb-Noun. Verbet beskriver åtgärden (till exempel New, Get, Set, Remove) och substantivet beskriver resurstypen (till exempel User, Group, ServicePrincipal, Device). Substantiv i Microsoft Entra PowerShell börjar alltid med prefixet Entra. Den fullständiga listan över standardverb finns i de godkända verben för PowerShell-kommandon.

Note

För Beta-cmdletar lägger du till ett Beta-prefix i resursnamnet. Använd till exempel Get-EntraBetaUser i stället Get-EntraUser för för betaversionen.

Du kan hämta alla tillgängliga kommandon i Microsoft Entra PowerShell-modulen med hjälp av följande kommando:

Get-Command -Module Microsoft.Entra*

För att begränsa detta, till exempel för att hitta kommandon som är relaterade till program, kör du följande kommando.

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

Det här kommandot visar alla cmdletar, funktioner och alias som ingår i modulen för programresursen.

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

Visa egenskaper och metoder som stöds för ett kommando

Om du vill se fler egenskaper utöver standardutdata kör du följande kommando för att visa alla egenskaper som stöds:

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

Det här kommandot visar alla användaregenskaper och metoder.

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

Få hjälp

Om du vill få hjälp med Microsoft Entra PowerShell-cmdletar använder du Get-Help kommandot för detaljerad hjälp om specifika kommandon, inklusive deras syntax, parametrar och användningsexempel. Om du till exempel vill veta mer om Get-EntraUser kommandot kör du följande kommando.

Get-Help Get-EntraUser -Detailed

Det här kommandot ger detaljerad hjälpdokumentation, inklusive cmdletens beskrivning, parametrar, användningsexempel och relaterade kommandon, som hjälper dig att förstå hur du använder den effektivt i olika scenarier.

Lär dig grunderna

Få praktisk hjälp med Microsoft Entra PowerShell genom våra detaljerade anvisningar: