適用於 Microsoft Entra 雲端同步的 AADCloudSyncTools PowerShell 模組

發行項
07/03/2024

AADCloudSyncTools 模組提供一組實用的工具，可協助您管理 Microsoft Entra 雲端同步的部署。

必要條件

您可以使用 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 強制執行功能。 Install-AADCloudSyncToolsPrerequisites Cmdlet 會在安裝所有必要條件之前，先設定 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 Cmdlet

注意

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

Connect-AADCloudSyncTools

此 Cmdlet 會使用 MSAL.PS 模組來要求權杖，讓 Microsoft Entra 管理員可存取 Microsoft Graph。

Export-AADCloudSyncToolsLogs

此 Cmdlet 會匯出所有疑難排解資料並封裝在壓縮檔案中，如下所示：

設定詳細資訊追蹤，並開始向佈建代理程式收集資料 (與 Start-AADCloudSyncToolsVerboseLogs 相同)。
資料收集會在三分鐘後停止，並停用詳細資訊追蹤 (與 Stop-AADCloudSyncToolsVerboseLogs相同)。
收集過去 24 小時內的事件檢視器記錄。
將所有代理程式記錄、詳細資訊記錄和事件檢視器記錄壓縮成 .zip 檔案，並放到使用者的 [文件] 資料夾中。

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

SkipVerboseTrace 只會匯出目前記錄，而不會擷取詳細資訊記錄 (預設值 = false)。
TracingDurationMins 可指定不同的擷取期間 (預設值 = 3 分鐘)。
OutputPath 可指定不同的輸出路徑 (預設值 = 使用者的「文件」資料夾)。

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 Provisioning Agent\Trace 資料夾中找到這些追蹤記錄。

Stop-AADCloudSyncToolsVerboseLogs

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

Suspend-AADCloudSyncToolsJob

此 Cmdlet 會暫停同步。

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention

停用 accidentalDeletionPrevention 租用戶功能

Disable-AADCloudSyncToolsDirSyncAccidentalDeletionPrevention -tenantId <TenantId>

此 Cmdlet 需要 Microsoft Entra 租用戶的 TenantId。系統會確認是否已啟用意外刪除防護功能，並在租用戶上設定 Microsoft Entra Connect (ADSync，而非雲端同步)，並停用此功能。

範例：

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

共用方式為