You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/cloud-sync/reference-powershell.md
+76-20Lines changed: 76 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,26 +56,82 @@ Here are some details about what you need:
56
56
57
57
## AADCloudSyncTools cmdlets
58
58
59
-
|Cmdlet|Purpose|
60
-
|-----|-----|
61
-
|`Connect-AADCloudSyncTools`|Uses the MSAL.PS module to request a token for the Azure AD administrator to access Microsoft Graph.
62
-
|`Export-AADCloudSyncToolsLogs`|Exports and packages all the troubleshooting data in a compressed file, as follows: </br><br>1. Sets verbose tracing and starts collecting data from the provisioning agent (same as `Start-AADCloudSyncToolsVerboseLogs`). <br>You can find these trace logs in the folder *C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace*. </br></br>2. Stops data collection after three minutes and disables verbose tracing (same as `Stop-AADCloudSyncToolsVerboseLogs`). <br>You can specify a different duration by using `-TracingDurationMins` or completely skip verbose tracing by using `-SkipVerboseTrace`. </br></br>3. Collects Event Viewer logs for the last 24 hours. </br></br>4. Compresses all the agent logs, verbose logs, and Event Viewer logs into a .zip file in the user's *Documents* folder. <br>You can specify a different output folder by using `-OutputPath <folder path>`. </br>
63
-
|`Get-AADCloudSyncToolsInfo`|Shows Azure AD tenant details and the state of internal variables.
64
-
|`Get-AADCloudSyncToolsJob`|Uses Microsoft Graph to get Azure AD service principals and returns the sync job information. Can also be called using the specific sync job ID as a parameter.
65
-
|`Get-AADCloudSyncToolsJobSchedule`|Uses Microsoft Graph to get Azure AD service principals and returns the sync job's schedule. Can also be called using the specific sync job ID as a parameter.
66
-
|`Get-AADCloudSyncToolsJobSchema`|Uses Microsoft Graph to get Azure AD service principals and returns the sync job's schema.
67
-
|`Get-AADCloudSyncToolsJobScope`|Uses Microsoft Graph to get the sync job's schema for the provided sync job ID and outputs all filter groups' scopes.
68
-
|`Get-AADCloudSyncToolsJobSettings`|Uses Microsoft Graph to get Azure AD service principals and returns the sync job's settings. Can also be called using the specific sync job ID as a parameter.
69
-
|`Get-AADCloudSyncToolsJobStatus`|Uses Microsoft Graph to get Azure AD service principals and returns the sync job's status. Can also be called using the specific sync job ID as a parameter.
70
-
|`Get-AADCloudSyncToolsServicePrincipal`|Uses Microsoft Graph to get the service principals for Azure AD and/or Azure Service Fabric. Without parameters, will only return Azure AD service principals.
71
-
|`Install-AADCloudSyncToolsPrerequisites`|Checks for the presence of PowerShellGet v2.2.4.1 or later and Azure AD and MSAL.PS modules, and installs these if they're missing.
72
-
|`Invoke-AADCloudSyncToolsGraphQuery`|Invokes a web request for the URI, method, and body specified as parameters.
73
-
|`Repair-AADCloudSyncToolsAccount`|Uses Azure AD PowerShell to delete the current account (if present) and resets the sync account authentication with a new synchronization account in Azure AD.
74
-
|`Restart-AADCloudSyncToolsJob`|Restarts a full synchronization.
75
-
|`Resume-AADCloudSyncToolsJob`|Continues synchronization from the previous watermark.
76
-
|`Start-AADCloudSyncToolsVerboseLogs`|Modifies *AADConnectProvisioningAgent.exe.config* to enable verbose tracing and restarts the AADConnectProvisioningAgent service. You can use `-SkipServiceRestart` to prevent service restart, but any configuration changes will not take effect. You can find these trace logs in the folder *C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace*.
77
-
|`Stop-AADCloudSyncToolsVerboseLogs`|Modifies *AADConnectProvisioningAgent.exe.config* to disable verbose tracing and restarts the AADConnectProvisioningAgent service. You can use `-SkipServiceRestart` to prevent service restart, but any configuration changes will not take effect.
This cmdlet uses the MSAL.PS module to request a token for the Azure AD administrator to access Microsoft Graph.
62
+
63
+
### Export-AADCloudSyncToolsLogs
64
+
65
+
This cmdlet exports and packages all the troubleshooting data in a compressed file, as follows:
66
+
67
+
1. Sets verbose tracing and starts collecting data from the provisioning agent (same as `Start-AADCloudSyncToolsVerboseLogs`). You can find these trace logs in the folder *C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace*.
68
+
2. Stops data collection after three minutes and disables verbose tracing (same as `Stop-AADCloudSyncToolsVerboseLogs`). You can specify a different duration by using `-TracingDurationMins` or completely skip verbose tracing by using `-SkipVerboseTrace`.
69
+
3. Collects Event Viewer logs for the last 24 hours.
70
+
4. Compresses all the agent logs, verbose logs, and Event Viewer logs into a .zip file in the user's *Documents* folder. You can specify a different output folder by using `-OutputPath <folder path>`.
71
+
72
+
### Get-AADCloudSyncToolsInfo
73
+
74
+
This cmdlet shows Azure AD tenant details and the state of internal variables.
75
+
76
+
### Get-AADCloudSyncToolsJob
77
+
78
+
This cmdlet uses Microsoft Graph to get Azure AD service principals and returns the sync job's information. You can also call it by using the specific sync job ID as a parameter.
79
+
80
+
### Get-AADCloudSyncToolsJobSchedule
81
+
82
+
This cmdlet uses Microsoft Graph to get Azure AD service principals and returns the sync job's schedule. You can also call it by using the specific sync job ID as a parameter.
83
+
84
+
### Get-AADCloudSyncToolsJobSchema
85
+
86
+
This cmdlet uses Microsoft Graph to get Azure AD service principals and returns the sync job's schema.
87
+
88
+
### Get-AADCloudSyncToolsJobScope
89
+
90
+
This cmdlet uses Microsoft Graph to get the sync job's schema for the provided sync job ID and outputs all filter groups' scopes.
91
+
92
+
### Get-AADCloudSyncToolsJobSettings
93
+
94
+
This cmdlet uses Microsoft Graph to get Azure AD service principals and returns the sync job's settings. You can also call it by using the specific sync job ID as a parameter.
95
+
96
+
### Get-AADCloudSyncToolsJobStatus
97
+
98
+
This cmdlet uses Microsoft Graph to get Azure AD service principals and returns the sync job's status. You can also call it by using the specific sync job ID as a parameter.
99
+
100
+
### Get-AADCloudSyncToolsServicePrincipal
101
+
102
+
This cmdlet uses Microsoft Graph to get the service principals for Azure AD and/or Azure Service Fabric. Without parameters, it will return only Azure AD service principals.
103
+
104
+
### Install-AADCloudSyncToolsPrerequisites
105
+
106
+
This cmdlet checks for the presence of PowerShellGet v2.2.4.1 or later, the Azure AD module, and the MSAL.PS module. It installs these items if they're missing.
107
+
108
+
### Invoke-AADCloudSyncToolsGraphQuery
109
+
110
+
This cmdlet invokes a web request for the URI, method, and body specified as parameters.
111
+
112
+
### Repair-AADCloudSyncToolsAccount
113
+
114
+
This cmdlet uses Azure AD PowerShell to delete the current account (if present). It then resets the sync account authentication with a new sync account in Azure AD.
115
+
116
+
### Restart-AADCloudSyncToolsJob
117
+
118
+
This cmdlet restarts a full synchronization.
119
+
120
+
### Resume-AADCloudSyncToolsJob
121
+
122
+
This cmdlet continues synchronization from the previous watermark.
123
+
124
+
### Start-AADCloudSyncToolsVerboseLogs
125
+
126
+
This cmdlet modifies *AADConnectProvisioningAgent.exe.config* to enable verbose tracing and restarts the AADConnectProvisioningAgent service. You can use `-SkipServiceRestart` to prevent service restart, but any configuration changes will not take effect. You can find these trace logs in the folder *C:\ProgramData\Microsoft\Azure AD Connect Provisioning Agent\Trace*.
127
+
128
+
### Stop-AADCloudSyncToolsVerboseLogs
129
+
130
+
This cmdlet modifies *AADConnectProvisioningAgent.exe.config* to disable verbose tracing and restarts the AADConnectProvisioningAgent service. You can use `-SkipServiceRestart` to prevent service restart, but any configuration changes will not take effect.
0 commit comments