Microsoft Entra PowerShell installeren

Met de Microsoft Entra PowerShell-module kunnen IT-professionals efficiënt Microsoft Entra resources beheren, waardoor naadloze integratie en functionaliteit op verschillende platforms mogelijk zijn. Met deze module kunt u beheertaken automatiseren en stroomlijnen.

In dit artikel leert u hoe u de Microsoft Entra PowerShell-module installeert, verifieert, bijwerkt en oplost in de verschillende besturingssystemen.

De Microsoft Entra PowerShell-module wordt gesplitst in twee modules, elk met submodules die afzonderlijk kunnen worden geïnstalleerd. De twee belangrijkste modules zijn:

  • Microsoft. Entra: de algemene beschikbaarheid of v1.0 versie van Microsoft Entra PowerShell. Deze verwijst naar Microsoft Graph v1.0- en Microsoft Graph PowerShell SDK v1.0-resources.
  • Microsoft. Entra.Beta: de Beta of preview-versie van Microsoft Entra PowerShell. Deze verwijst naar Microsoft Graph bèta- en Microsoft Graph PowerShell SDK bèta-resources.

PowerShell versie 7 of hoger wordt aanbevolen voor gebruik met de Microsoft Entra PowerShell-module op alle platforms, waaronder Windows, Linux en macOS.

De PowerShell-module Microsoft Entra installeren op Windows

De aanbevolen installatiemethode en PowerShell-versie voor de module:

  • Installeren vanuit de PowerShell Gallery
  • Gebruiken met Windows PowerShell 5.1+ of PowerShell 7+.

Vereisten voor Windows

  • Voer de volgende opdracht uit vanuit PowerShell om uw PowerShell-versie te bepalen:

    $PSVersionTable.PSVersion
    
  • Controleer of u de module hebt geïnstalleerd:

    Get-Module -Name Microsoft.Entra -ListAvailable
    
  • Het PowerShell-uitvoeringsbeleid instellen op extern ondertekend of minder beperkend

    • Controleer het PowerShell-uitvoeringsbeleid:

      Get-ExecutionPolicy -List
      
    • Stel het PowerShell-uitvoeringsbeleid in op extern ondertekend:

      Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
      

    Zie about_Execution_Policies voor meer informatie over het uitvoeringsbeleid.

Installatie

Wanneer u de module installeert, kunt u ervoor kiezen om de hele module of een specifieke submodule te installeren. In de volgende voorbeelden ziet u hoe u de hele module installeert voor zowel v1.0 als Beta.

Gebruik de cmdlet Install-Module om de module te installeren.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope CurrentUser -Force -AllowClobber

U kunt desgewenst het bereik van de installatie wijzigen met behulp van de parameter Bereik . Voor deze bewerking zijn beheerdersmachtigingen vereist.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope AllUsers -Force -AllowClobber

Specifieke submodules installeren

Het installeren van specifieke modules is ideaal voor automatiseringsscenario's, zoals het gebruik van Azure Functions en Azure Automation.

Voer de volgende opdracht uit om alle Microsoft.Entra GA/v1.0-modules in de PowerShell Gallery weer te geven:

Find-Module -Name "Microsoft.Entra*" -Repository PSGallery |
Where-Object { $_.Name -notmatch "beta" }

Met deze opdracht worden alle Microsoft Entra PowerShell-modules GA/v1.0 in de PowerShell Gallery weergegeven.

Voer bijvoorbeeld de volgende opdracht uit om de Users module te installeren:

Install-Module -Name Microsoft.Entra.Users -Repository PSGallery -Force -AllowClobber

Microsoft Entra PowerShell installeren op Linux

Vereisten voor Linux

Installatie in Linux

Wanneer u de module installeert, kunt u ervoor kiezen om de hele module of een specifieke submodule te installeren. In het volgende voorbeeld ziet u hoe u de hele module installeert.

Open de Terminal of een andere shell-hosttoepassing en voer deze uit pwsh om PowerShell te starten.

Gebruik de cmdlet Install-Module om de module te installeren:

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope CurrentUser -Force -AllowClobber

U kunt desgewenst het bereik van de installatie wijzigen met behulp van de parameter Bereik . Voor deze bewerking zijn beheerdersmachtigingen vereist.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope AllUsers -Force -AllowClobber

Specifieke submodules installeren in Linux

Het installeren van specifieke modules is ideaal voor automatiseringsscenario's, zoals het gebruik van Azure Functions en Azure Automation.

Voer de volgende opdracht uit om alle Microsoft.Entra GA/v1.0-modules in de PowerShell Gallery weer te geven:

Find-Module -Name "Microsoft.Entra*" -Repository PSGallery |
Where-Object { $_.Name -notmatch "beta" }

Met deze opdracht worden alle Microsoft Entra PowerShell-modules GA/v1.0 in de PowerShell Gallery weergegeven.

Voer bijvoorbeeld de volgende opdracht uit om de Users module te installeren:

Install-Module -Name Microsoft.Entra.Users -Repository PSGallery -Force -AllowClobber

Microsoft Entra PowerShell installeren in macOS

In dit artikel wordt uitgelegd hoe u de module installeert vanuit de PowerShell Gallery in macOS.

Vereisten voor macOS

Installatie in macOS

Wanneer u de module installeert, kunt u ervoor kiezen om de hele module of een specifieke submodule te installeren. In het volgende voorbeeld ziet u hoe u de hele module installeert.

Open de Terminal of een andere shell-hosttoepassing en voer deze uit pwsh om PowerShell te starten.

Gebruik de cmdlet Install-Module om de Microsoft Entra PowerShell-module te installeren:

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope CurrentUser -Force -AllowClobber

U kunt desgewenst het bereik van de installatie wijzigen met behulp van de parameter Bereik . Voor deze bewerking zijn beheerdersmachtigingen vereist.

Install-Module -Name Microsoft.Entra -Repository PSGallery -Scope AllUsers -Force -AllowClobber

Specifieke submodules installeren in macOS

Het installeren van specifieke modules is ideaal voor automatiseringsscenario's, zoals het gebruik van Azure Functions en Azure Automation.

Voer de volgende opdracht uit om alle Microsoft.Entra GA/v1.0-modules in de PowerShell Gallery weer te geven:

Find-Module -Name "Microsoft.Entra*" -Repository PSGallery |
Where-Object { $_.Name -notmatch "beta" }

Met deze opdracht worden alle Microsoft Entra PowerShell-modules GA/v1.0 in de PowerShell Gallery weergegeven.

Voer bijvoorbeeld de volgende opdracht uit om de Users module te installeren:

Install-Module -Name Microsoft.Entra.Users -Repository PSGallery -Force -AllowClobber

Geïnstalleerde moduleversie en -locatie controleren

Nadat de installatie is voltooid, kunt u de geïnstalleerde submodules, hun versie en locatie controleren met de volgende opdracht.

Get-InstalledModule -Name Microsoft.Entra* |
Where-Object { $_.Name -notmatch "Beta" } | Format-Table Name, Version, InstalledLocation -AutoSize

Met deze opdracht ziet u de geïnstalleerde Microsoft Entra PowerShell-module, de bijbehorende versie en de installatielocatie. De uitvoerversie moet overeenkomen met de nieuwste versie op de PowerShell Gallery. U bent nu klaar om de module te gebruiken.

Name                                Version InstalledLocation
----                                ------- -----------------
Microsoft.Entra                     1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra\1.0.1
Microsoft.Entra.Applications        1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Applications\1.0.1
Microsoft.Entra.Authentication      1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Authentication\1.0.1
Microsoft.Entra.DirectoryManagement 1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.DirectoryManagement\1.0.1
Microsoft.Entra.Governance          1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Governance\1.0.1
Microsoft.Entra.Groups              1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Groups\1.0.1
Microsoft.Entra.Reports             1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Reports\1.0.1
Microsoft.Entra.SignIns             1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.SignIns\1.0.1
Microsoft.Entra.Users               1.0.1   <PowerShell-Path>\PowerShell\Modules\Microsoft.Entra.Users\1.0.1

Als u wilt controleren of een specifieke submodule bijvoorbeeld is geïnstalleerd, Users voert u het volgende uit:

Get-InstalledModule -Name Microsoft.Entra.Users

De uitvoerversie moet overeenkomen met de nieuwste versie op de PowerShell Gallery.

Version              Name                                Repository           Description
-------              ----                                ----------           -----------
1.0.1                Microsoft.Entra.Users               PSGallery            Microsoft Entra PowerShell

Installatieproblemen oplossen

Fout Oorzaak Tijdelijke maatregel
Install-Module: er is geen parameter gevonden die overeenkomt met de parameternaam AllowPrerelease. U gebruikt een oudere versie van Install-Module. Volg deze handleiding om een upgrade uit te voeren. Het probleem is alleen van toepassing op Windows platform.
Afhankelijke module 'modulenaam' is niet geïnstalleerd op deze computer. Als u de huidige module Microsoft wilt gebruiken. Entra, zorg ervoor dat de afhankelijke module 'module-name' is geïnstalleerd. De Microsoft Entra PowerShell-afhankelijkheden zijn niet geïnstalleerd Gebruik dit script om te installeren
Cmdlets bestaan al op het systeem Parameter toevoegen -AllowClobber : Install-Module -Name Microsoft.Entra -Repository PSGallery -Force -AllowClobber
De volgende opdrachten zijn al beschikbaar op dit systeem: 'Enable-EntraAzureADAlias,Get-EntraUnsupportedCommand,Test-EntraScript' Er is een conflict wanneer Beta of v1.0 al is geïnstalleerd Om het probleem op te lossen, deïnstalleer de problematische moduleversie.

Zie Problemen met moduleinstallatie oplossen voor oplossingen voor andere veelvoorkomende installatieproblemen en andere algemene problemen.

Aanmelden

Als u uw Microsoft Entra resources wilt beheren met de Microsoft Entra PowerShell-module, start u een PowerShell-sessie en voert u Connect-Entra uit om u aan te melden bij Microsoft Entra ID:

Connect-Entra -Scopes 'User.Read.All'
Get-EntraUser -Filter "userPrincipalName eq 'SawyerM@contoso.com'"

Gebruik uw Microsoft Entra referenties om u aan te melden bij het aanmeldingsvenster dat wordt geopend.

U moet deze stap herhalen voor elke nieuwe PowerShell-sessie die u start.

Zie meer verificatiescenario's voor meer informatie over andere verificatiescenario's.

De module bijwerken

Als de module is geïnstalleerd, volgt u deze stappen om deze bij te werken.

Controleer eerst de moduleversie en -locatie met behulp van de richtlijnen in de sectie voor het verifiëren van de installatie van dit artikel.

Bijwerken naar de nieuwste versie

Gebruik Update-Module om bij te werken naar de nieuwste versie van de Microsoft Entra PowerShell-module.

Update-Module -Name Microsoft.Entra -Force

Voer de volgende opdracht uit om een specifieke submodule bij te werken, zoals Users:

Update-Module -Name Microsoft.Entra.Users -Force

Als u de Microsoft Entra PowerShell-module bijwerkt, Update-Module worden oude versies van de module niet uit uw systeem verwijderd.

De module verwijderen

Voer de opdracht uit om de module te verwijderen:

Uninstall-Module -Name Microsoft.Entra -AllVersions -Force

Voer de volgende opdracht uit om een specifieke submodule te verwijderen, zoals Users:

Uninstall-Module -Name Microsoft.Entra.Users -AllVersions -Force

Als u alle submodules wilt verwijderen, voert u het volgende uit:

$InstalledSubModules = Get-InstalledModule -Name Microsoft.Entra.* |
Where-Object { $_.Name -notmatch "Beta" }
foreach ($module in $InstalledSubModules) {
    Write-Host "Checking for submodule: $($module.Name)" -ForegroundColor Yellow -BackgroundColor DarkBlue
    Uninstall-Module -Name $module.Name -Force -ErrorAction Stop
    Write-Host "Successfully uninstalled submodule: $($module.Name)" -ForegroundColor Green
}

Volgende stappen