適用於 Microsoft Entra Cloud Sync 的 AADCloudSyncTools PowerShell 模組

發行項
03/12/2025

AADCloudSyncTools 模組提供一組實用的工具，可協助您管理Microsoft Entra Cloud Sync 的部署。

先決條件

您可以使用 Install-AADCloudSyncToolsPrerequisites自動安裝 AADCloudSyncTools 模組的所有必要條件。您將在本文的下一節中執行此動作。

以下是您需要的一些詳細資料：

AADCloudSyncTools 模組使用 Microsoft 驗證連結庫（MSAL）驗證，因此需要安裝 MSAL.PS 模組。若要確認安裝，請在 PowerShell 視窗中執行 Get-module MSAL.PS -ListAvailable。如果模組已正確安裝，您將會收到回應。如有必要，您可以使用 Install-AADCloudSyncToolsPrerequisites 來安裝最新版本的 MSAL.PS。
雖然 AADCloudSyncTools 模組的任何功能都不需要 Microsoft Graph PowerShell 模組，但它很有用。因此，當您使用 Install-AADCloudSyncToolsPrerequisites時，系統會自動安裝。
從 PowerShell 資源庫安裝模組需要強制執行傳輸層安全性（TLS） 1.2。 Cmdlet Install-AADCloudSyncToolsPrerequisites 先設定 TLS 1.2 強制，再安裝所有必要條件。若要確保您可以手動安裝模組，請在 PowerShell 工作階段中設定如下設置，然後使用 cmdlet：
```
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 
```
如果Microsoft Entra Connect 雲端布建代理程式未執行，或設定精靈尚未順利完成，AADCloudSyncTools 模組可能無法正常運作。

安裝 AADCloudSyncTools PowerShell 模組

使用系統管理許可權開啟 Windows PowerShell。
執行 Import-module -Name "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools"。
若要確認模組已匯入，請執行 Get-module AADCloudSyncTools。

您現在應該會看到模組的相關信息。
若要安裝 AADCloudSyncTools 模組必要條件，請執行 Install-AADCloudSyncToolsPrerequisites。
在第一次執行時，如果 PowerShellGet 模組不存在，將會被安裝。若要載入新的 PowerShellGet 模組，請關閉 PowerShell 視窗，並開啟具有系統管理許可權的新 PowerShell 會話。
執行 Import-module -Name "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools"再次匯入模組。
再次執行 Install-AADCloudSyncToolsPrerequisites 以安裝 MSAL 和 Microsoft Graph PowerShell 模組。

現在所有的前置作業應該都已經安裝完成。

每次您想要在新 PowerShell 會話中使用 AADCloudSyncTools 模組時，請執行下列命令：

Import-module "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Utility\AADCloudSyncTools"

AADCloudSyncTools 指令集

注意

使用 AADCloudSyncTools 模組之前，請確定Microsoft Entra Connect 雲端布建代理程式正在執行，且設定精靈已順利完成。若要針對精靈問題進行疑難解答，您可以在 C：\ProgramData\Microsoft\Azure AD Connect 布建代理程式\追蹤資料夾中找到追蹤記錄，如需詳細資訊，請參閱雲端同步疑難解答。

Connect-AADCloudSyncTools

此 Cmdlet 會使用 MSAL.PS 模組來要求 Microsoft Entra 系統管理員存取 Microsoft Graph 的令牌。

Export-AADCloudSyncToolsLogs

此 Cmdlet 會匯出和封裝壓縮檔案中的所有疑難解答數據，如下所示：

設置詳細追蹤並開始從佈建代理程式收集數據（與 Start-AADCloudSyncToolsVerboseLogs相同）。
在三分鐘後，停止數據收集，並停用詳細追蹤功能（與 Stop-AADCloudSyncToolsVerboseLogs相同）。
收集過去 24 小時內的事件查看器記錄。
將使用者 Documents 資料夾中的所有代理記錄、事件查看器記錄和詳細資訊記錄壓縮成 .zip 檔案。

您可以使用下列選項來微調資料收集：

SkipVerboseTrace 只匯出目前的記錄，而不擷取詳細信息記錄（預設值 = false）。
TracingDurationMins 指定不同的擷取持續時間（預設值 = 3 分鐘）。
OutputPath 指定不同的輸出路徑（預設值 = 使用者的 Documents 資料夾）。

Get-AADCloudSyncToolsInfo

此 Cmdlet 會顯示Microsoft Entra 租使用者詳細數據和內部變數的狀態。

Get-AADCloudSyncToolsJob

此 Cmdlet 會使用 Microsoft Graph 來取得Microsoft Entra 服務主體，並傳回同步作業的資訊。您也可以使用特定的同步作業識別碼做為參數來呼叫它。

Get-AADCloudSyncToolsJobSchedule

此 Cmdlet 會使用 Microsoft Graph 來取得 Microsoft Entra 服務主體，並傳回同步作業的排程。您也可以使用特定的同步作業識別碼做為參數來呼叫它。

Get-AADCloudSyncToolsJobSchema

此 Cmdlet 會使用 Microsoft Graph 來取得Microsoft Entra 服務主體，並傳回同步作業的架構。

Get-AADCloudSyncToolsJobScope

此 Cmdlet 會使用 Microsoft Graph 來取得所提供同步作業識別碼的同步作業架構，並輸出所有篩選群組的範圍。

Get-AADCloudSyncToolsJobSettings

此 Cmdlet 會使用 Microsoft Graph 來取得 Microsoft Entra 服務主體，並傳回同步作業的設定。您也可以使用特定的同步作業識別碼做為參數來呼叫它。

Get-AADCloudSyncToolsJobStatus

此 Cmdlet 會使用 Microsoft Graph 來取得Microsoft Entra 服務主體，並傳回同步作業的狀態。您也可以使用特定的同步作業識別碼做為參數來呼叫它。

Get-AADCloudSyncToolsServicePrincipal

此 Cmdlet 會使用 Microsoft Graph 來取得Microsoft Entra ID 和/或 Azure Service Fabric 的服務主體。如果沒有參數，它只會傳回Microsoft Entra 服務主體。

Install-AADCloudSyncToolsPrerequisites

此 Cmdlet 會檢查 PowerShellGet v2.2.4.1 或更新版本、Microsoft Graph PowerShell 模組和 MSAL.PS 模組是否存在。如果系統遺漏了這些專案，則會進行安裝。

Invoke-AADCloudSyncToolsGraphQuery

此 Cmdlet 會針對指定為參數的 URI、方法和主體叫用 Web 要求。

Repair-AADCloudSyncToolsAccount

此 Cmdlet 會使用 Microsoft Graph PowerShell 刪除目前的帳戶（如果有的話）。然後，它會使用 Microsoft Entra ID 中的新同步帳號重設同步帳號驗證。

Restart-AADCloudSyncToolsJob

此 Cmdlet 會重新啟動完整同步處理。

Resume-AADCloudSyncToolsJob

此 Cmdlet 會繼續從先前的浮水印進行同步處理。

Start-AADCloudSyncToolsVerboseLogs

此 cmdlet 會修改 AADConnectProvisioningAgent.exe.config，以啟用詳細追蹤，並重新啟動 AADConnectProvisioningAgent 服務。您可以使用 -SkipServiceRestart 來防止服務重新啟動，但任何設定變更都不會生效。您可以在 C：\ProgramData\Microsoft\Azure AD Connect 布建代理程式\追蹤資料夾中找到這些追蹤記錄。

Stop-AADCloudSyncToolsVerboseLogs

此 Cmdlet 會修改 AADConnectProvisioningAgent.exe.config 以停用詳述追蹤，並重新啟動 AADConnectProvisioningAgent 服務。您可以使用 -SkipServiceRestart 來防止服務重新啟動，但任何設定變更都不會生效。

Suspend-AADCloudSyncToolsJob

此 Cmdlet 會暫停同步處理。

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention

停用防止意外刪除租戶功能

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention -tenantId <TenantId>

此 Cmdlet 需要 TenantId 的 Microsoft Entra 租使用者。它將會驗證租用戶上是否已使用 Microsoft Entra Connect（ADSync，而非雲端同步）啟用[意外刪除防護]功能，並在已啟用時將其停用。

例：

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention -tenantId "aaaabbbb-0000-cccc-1111-dddd2222eeee"

共用方式為