Menginstal Microsoft Entra PowerShell

Modul Microsoft Entra PowerShell memungkinkan profesional TI mengelola sumber daya Microsoft Entra secara efisien, memastikan integrasi dan fungsionalitas yang lancar di berbagai platform. Modul ini meningkatkan kemampuan Anda untuk mengotomatiskan dan menyederhanakan tugas administratif.

Dalam artikel ini, Anda mempelajari cara menginstal, memverifikasi, memperbarui, dan memecahkan masalah modul PowerShell Microsoft Entra di berbagai sistem operasi.

Modul PowerShell Microsoft Entra dibagi menjadi dua modul, masing-masing dengan submodul yang dapat diinstal secara terpisah. Dua modul utama adalah:

  • Microsoft. Entra - ketersediaan umum atau v1.0 versi Microsoft Entra PowerShell. Ini menunjuk ke sumber daya Microsoft Graph v1.0 dan SDK PowerShell Microsoft Graph v1.0.
  • Microsoft.Entra.Beta - Beta atau versi pratinjau Microsoft Entra PowerShell. Ini mengacu pada sumber daya Microsoft Graph Beta dan SDK PowerShell Microsoft Graph Beta.

PowerShell versi 7 atau yang lebih tinggi direkomendasikan untuk digunakan dengan modul PowerShell Microsoft Entra di semua platform termasuk Windows, Linux, dan macOS.

Instal modul Microsoft Entra PowerShell di Windows

Metode penginstalan yang direkomendasikan dan versi PowerShell untuk modul:

  • Instal dari PowerShell Gallery
  • Gunakan dengan Windows PowerShell 5.1+ atau PowerShell 7+.

Prasyarat tentang Windows

  • Jalankan perintah berikut dari PowerShell untuk menentukan versi PowerShell Anda:

    $PSVersionTable.PSVersion
    
  • Tentukan apakah Anda telah menginstal modul:

    Get-Module -Name Microsoft.Entra -ListAvailable
    
  • Mengatur kebijakan eksekusi PowerShell ke ditandatangani dari jarak jauh atau kurang ketat

    • Periksa kebijakan eksekusi PowerShell:

      Get-ExecutionPolicy -List
      
    • Atur kebijakan eksekusi PowerShell ke ditandatangani dari jarak jauh:

      Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
      

    Untuk informasi selengkapnya tentang kebijakan eksekusi, lihat about_Execution_Policies.

Installation

Saat menginstal modul, Anda dapat memilih untuk menginstal seluruh modul atau submodul tertentu. Contoh berikut menunjukkan cara menginstal seluruh modul untuk v1.0 dan Beta.

Gunakan cmdlet Install-Module untuk menginstal modul.

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

Secara opsional, Anda dapat mengubah cakupan penginstalan menggunakan parameter Cakupan . Operasi ini memerlukan izin admin.

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

Menginstal submodul tertentu

Menginstal modul tertentu sangat ideal untuk skenario otomatisasi seperti menggunakan Azure Functions dan Azure Automation.

Jalankan perintah berikut untuk mencantumkan semua Microsoft.Entra modul GA/v1.0 di PowerShell Gallery:

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

Perintah ini mencantumkan semua modul PowerShell GA/v1.0 Microsoft Entra di PowerShell Gallery.

Misalnya, untuk menginstal Users modul, jalankan perintah berikut:

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

Menginstal Microsoft Entra PowerShell di Linux

Prasyarat di Linux

Penginstalan di Linux

Saat menginstal modul, Anda dapat memilih untuk menginstal seluruh modul atau submodul tertentu. Contoh berikut menunjukkan cara menginstal seluruh modul.

Buka Terminal atau aplikasi host shell lainnya dan jalankan pwsh untuk memulai PowerShell.

Gunakan cmdlet Install-Module untuk menginstal modul:

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

Secara opsional, Anda dapat mengubah cakupan penginstalan menggunakan parameter Cakupan . Operasi ini memerlukan izin admin.

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

Menginstal submodul tertentu di Linux

Menginstal modul tertentu sangat ideal untuk skenario otomatisasi seperti menggunakan Azure Functions dan Azure Automation.

Jalankan perintah berikut untuk mencantumkan semua Microsoft.Entra modul GA/v1.0 di PowerShell Gallery:

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

Perintah ini mencantumkan semua modul PowerShell GA/v1.0 Microsoft Entra di PowerShell Gallery.

Misalnya, untuk menginstal Users modul, jalankan perintah berikut:

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

Menginstal Microsoft Entra PowerShell di macOS

Artikel ini menjelaskan cara menginstal modul dari PowerShell Gallery di macOS.

Prasyarat di macOS

Penginstalan di macOS

Saat menginstal modul, Anda dapat memilih untuk menginstal seluruh modul atau submodul tertentu. Contoh berikut menunjukkan cara menginstal seluruh modul.

Buka Terminal atau aplikasi host shell lainnya dan jalankan pwsh untuk memulai PowerShell.

Gunakan cmdlet Install-Module untuk menginstal modul PowerShell Microsoft Entra:

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

Secara opsional, Anda dapat mengubah cakupan penginstalan menggunakan parameter Cakupan . Operasi ini memerlukan izin admin.

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

Menginstal submodul tertentu di macOS

Menginstal modul tertentu sangat ideal untuk skenario otomatisasi seperti menggunakan Azure Functions dan Azure Automation.

Jalankan perintah berikut untuk mencantumkan semua Microsoft.Entra modul GA/v1.0 di PowerShell Gallery:

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

Perintah ini mencantumkan semua modul PowerShell GA/v1.0 Microsoft Entra di PowerShell Gallery.

Misalnya, untuk menginstal Users modul, jalankan perintah berikut:

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

Verifikasi versi dan lokasi modul yang terinstal

Setelah penginstalan selesai, Anda dapat memverifikasi submodul, versi, dan lokasi yang diinstal dengan perintah berikut.

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

Perintah ini menunjukkan modul PowerShell Microsoft Entra terinstal, versinya, dan lokasi penginstalannya. Versi output harus cocok dengan versi terbaru pada PowerShell Gallery. Anda sekarang siap untuk menggunakan modul.

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

Untuk memverifikasi apakah submodul tertentu misalnya, Users diinstal, jalankan:

Get-InstalledModule -Name Microsoft.Entra.Users

Versi output harus cocok dengan versi terbaru pada PowerShell Gallery.

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

Memecahkan masalah penginstalan

Kesalahan Cause Workaround
Install-Module: Parameter tidak dapat ditemukan yang cocok dengan nama parameter AllowPrerelease. Anda menggunakan versi Install-Module yang lebih lama. Untuk meningkatkan, ikuti panduan ini. Masalah ini hanya berlaku untuk platform Windows.
Modul dependen 'module-name' tidak diinstal pada komputer ini. Untuk menggunakan modul saat ini 'Microsoft. Entra,' pastikan bahwa modul dependennya 'module-name' diinstal. Dependensi Microsoft Entra PowerShell tidak diinstal Untuk menginstal, gunakan skrip ini
Cmdlet sudah ada pada sistem Tambahkan parameter -AllowClobber: Install-Module -Name Microsoft.Entra -Repository PSGallery -Force -AllowClobber
Perintah berikut sudah tersedia pada sistem ini: 'Enable-EntraAzureADAlias,Get-EntraUnsupportedCommand,Test-EntraScript' Ada konflik ketika salah satu Beta atau v1.0 sudah diinstal Untuk mengatasi masalah ini, hapus instalan versi modul yang menyinggung.

Untuk solusi penginstalan umum lainnya dan masalah umum lainnya, lihat Memecahkan masalah penginstalan modul.

Masuk akun

Untuk mulai mengelola sumber daya Microsoft Entra Anda dengan modul PowerShell Microsoft Entra, luncurkan sesi PowerShell dan jalankan Connect-Entra untuk masuk ke Microsoft Entra ID:

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

Gunakan kredensial Microsoft Entra Anda untuk masuk ke jendela masuk yang terbuka.

Anda perlu mengulangi langkah ini untuk setiap sesi PowerShell baru yang Anda mulai.

Untuk informasi selengkapnya tentang skenario autentikasi lainnya, lihat skenario autentikasi lainnya.

Memperbarui modul

Jika modul diinstal, ikuti langkah-langkah ini untuk memperbaruinya.

Pertama, verifikasi versi dan lokasi modul menggunakan panduan di bagian verifikasi penginstalan artikel ini.

Memperbarui ke versi terbaru

Gunakan Update-Module untuk memperbarui ke versi terbaru modul Microsoft Entra PowerShell.

Update-Module -Name Microsoft.Entra -Force

Untuk memperbarui submodul tertentu, seperti Users, jalankan:

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

Memperbarui modul PowerShell Microsoft Entra menggunakan Update-Module tidak menghapus versi lama modul dari sistem Anda.

Menghapus instalan modul

Untuk menghapus modul, jalankan perintah :

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

Untuk menghapus instalan submodul tertentu, seperti Users, jalankan:

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

Untuk menghapus instalan semua submodul, jalankan:

$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
}

Langkah berikutnya

  • Untuk mempelajari selengkapnya tentang menavigasi modul Microsoft Entra PowerShell, lihat artikel Menavigasi modul.