Skip to content

Commit 5576809

Browse files
authored
Merge pull request #186866 from billmath/cloud3
staging
2 parents 7169953 + bd481f1 commit 5576809

14 files changed

+77
-78
lines changed

articles/active-directory/cloud-sync/how-to-install-pshell.md

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: karenhoran
77
ms.service: active-directory
88
ms.workload: identity
99
ms.topic: how-to
10-
ms.date: 11/16/2020
10+
ms.date: 01/31/2021
1111
ms.subservice: hybrid
1212
ms.author: billmath
1313
ms.collection: M365-identity-device-management
@@ -29,76 +29,78 @@ The Windows server must have TLS 1.2 enabled before you install the Azure AD Con
2929
3030
## Install the Azure AD Connect provisioning agent by using PowerShell cmdlets
3131

32-
1. Sign in to the Azure portal, and then go to **Azure Active Directory**.
33-
1. In the menu on the left, select **Azure AD Connect**.
34-
1. Select **Manage provisioning** > **Review all agents**.
35-
1. Download the Azure AD Connect provisioning agent from the Azure portal.
36-
37-
![Screenshot that shows downloading the on-premises agent.](media/how-to-install/install-9.png)</br>
38-
39-
1. For the purposes of these instructions, the agent was downloaded to the C:\temp folder.
40-
1. Install ProvisioningAgent in quiet mode.
41-
42-
```
43-
$installerProcess = Start-Process c:\temp\AADConnectProvisioningAgent.Installer.exe /quiet -NoNewWindow -PassThru
44-
$installerProcess.WaitForExit()
32+
1. Sign in to the server you'll use with enterprise admin permissions.
33+
2. Sign in to the Azure portal, and then go to **Azure Active Directory**.
34+
3. On the menu on the left, select **Azure AD Connect**.
35+
4. Select **Manage cloud sync**.
36+
[![Screenshot that shows manage cloud sync](media/how-to-install/new-install-1.png)](media/how-to-install/new-install-1.png#lightbox)</br>
37+
5. At the top, click **Download agent**.
38+
[![Screenshot that the download agent](media/how-to-install/new-install-2.png)](media/how-to-install/new-install-2.png#lightbox)</br>
39+
6. On the right, click **Accept terms and download**.
40+
7. For the purposes of these instructions, the agent was downloaded to the C:\temp folder.
41+
8. Install ProvisioningAgent in quiet mode.
4542
```
46-
1. Import the Provisioning Agent PS module.
43+
$installerProcess = Start-Process 'c:\temp\AADConnectProvisioningAgentSetup.exe' /quiet -NoNewWindow -PassThru
44+
$installerProcess.WaitForExit()
4745

4846
```
47+
9. Import the Provisioning Agent PS module.
48+
```
4949
Import-Module "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Microsoft.CloudSync.PowerShell.dll"
5050
```
51-
1. Connect to Azure AD by using global administrator credentials. You can customize this section to fetch a password from a secure store.
52-
51+
10. Connect to Azure AD by using an account with the hybrid identity role. You can customize this section to fetch a password from a secure store.
5352
```
54-
$globalAdminPassword = ConvertTo-SecureString -String "Global admin password" -AsPlainText -Force
53+
$hybridAdminPassword = ConvertTo-SecureString -String "Hybrid identity admin password" -AsPlainText -Force
5554
56-
$globalAdminCreds = New-Object System.Management.Automation.PSCredential -ArgumentList ("GlobalAdmin@contoso.onmicrosoft.com", $globalAdminPassword)
55+
$hybridAdminCreds = New-Object System.Management.Automation.PSCredential -ArgumentList ("HybridIDAdmin@contoso.onmicrosoft.com", $hybridAdminPassword)
5756
58-
Connect-AADCloudSyncAzureAD -Credential $globalAdminCreds
57+
Connect-AADCloudSyncAzureAD -Credential $hybridAdminCreds
5958
```
60-
1. Add the gMSA account, and provide credentials of the domain admin to create the default gMSA account.
61-
59+
11. Add the gMSA account, and provide credentials of the domain admin to create the default gMSA account.
6260
```
6361
$domainAdminPassword = ConvertTo-SecureString -String "Domain admin password" -AsPlainText -Force
6462
6563
$domainAdminCreds = New-Object System.Management.Automation.PSCredential -ArgumentList ("DomainName\DomainAdminAccountName", $domainAdminPassword)
6664
6765
Add-AADCloudSyncGMSA -Credential $domainAdminCreds
6866
```
69-
1. Or use the preceding cmdlet to provide a pre-created gMSA account.
70-
67+
12. Or use the preceding cmdlet to provide a pre-created gMSA account.
7168
```
7269
Add-AADCloudSyncGMSA -CustomGMSAName preCreatedGMSAName$
7370
```
74-
1. Add the domain.
75-
71+
13. Add the domain.
7672
```
7773
$contosoDomainAdminPassword = ConvertTo-SecureString -String "Domain admin password" -AsPlainText -Force
7874
7975
$contosoDomainAdminCreds = New-Object System.Management.Automation.PSCredential -ArgumentList ("DomainName\DomainAdminAccountName", $contosoDomainAdminPassword)
8076
8177
Add-AADCloudSyncADDomain -DomainName contoso.com -Credential $contosoDomainAdminCreds
8278
```
83-
1. Or use the preceding cmdlet to configure preferred domain controllers.
84-
79+
14. Or use the preceding cmdlet to configure preferred domain controllers.
8580
```
8681
$preferredDCs = @("PreferredDC1", "PreferredDC2", "PreferredDC3")
8782
8883
Add-AADCloudSyncADDomain -DomainName contoso.com -Credential $contosoDomainAdminCreds -PreferredDomainControllers $preferredDCs
8984
```
90-
1. Repeat the previous step to add more domains. Provide the account names and domain names of the respective domains.
91-
92-
1. Restart the service.
93-
85+
15. Repeat the previous step to add more domains. Provide the account names and domain names of the respective domains.
86+
16. Restart the service.
9487
```
9588
Restart-Service -Name AADConnectProvisioningAgent
9689
```
97-
1. Go to the Azure portal to create the cloud sync configuration.
90+
17. Go to the Azure portal to create the cloud sync configuration.
9891
9992
## Provisioning agent gMSA PowerShell cmdlets
10093
Now that you've installed the agent, you can apply more granular permissions to the gMSA. For information and step-by-step instructions on how to configure the permissions, see [Azure AD Connect cloud provisioning agent gMSA PowerShell cmdlets](how-to-gmsa-cmdlets.md).
10194
95+
## Installing against US govt cloud
96+
By default, the Azure Active Directory (Azure AD) Connect provisioning agent installs against the default Azure cloud environment. If you are installing the agent for use in the US government cloud do the following:
97+
98+
- In step #8 above, add **ENVIRONMENTNAME=AzureUSGovernment** to the command line like the example below.
99+
```
100+
$installerProcess = Start-Process -FilePath "c:\temp\AADConnectProvisioningAgent.Installer.exe" -ArgumentList "/quiet ENVIRONMENTNAME=AzureUSGovernment" -NoNewWindow -PassThru
101+
$installerProcess.WaitForExit()
102+
```
103+
102104
## Next steps
103105

104106
- [What is provisioning?](what-is-provisioning.md)

articles/active-directory/cloud-sync/how-to-install.md

Lines changed: 42 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ manager: karenhoran
77
ms.service: active-directory
88
ms.workload: identity
99
ms.topic: how-to
10-
ms.date: 12/13/2021
10+
ms.date: 01/31/2021
1111
ms.subservice: hybrid
1212
ms.author: billmath
1313
ms.collection: M365-identity-device-management
@@ -22,7 +22,7 @@ This article walks you through the installation process for the Azure Active Dir
2222
>[!NOTE]
2323
>This article deals with installing the provisioning agent by using the wizard. For information on installing the Azure AD Connect provisioning agent by using a command-line interface (CLI), see [Install the Azure AD Connect provisioning agent by using a CLI and PowerShell](how-to-install-pshell.md).
2424
25-
For additional information and an example, see the following video.
25+
For more information and an example, see the following video.
2626

2727
> [!VIDEO https://www.microsoft.com/en-us/videoplayer/embed/RWK5mR]
2828
@@ -38,36 +38,33 @@ To upgrade an existing agent to use the group Managed Service Account created du
3838
To install the agent:
3939

4040
1. Sign in to the server you'll use with enterprise admin permissions.
41-
1. Sign in to the Azure portal, and then go to **Azure Active Directory**.
42-
1. On the menu on the left, select **Azure AD Connect**.
43-
1. Select **Manage cloud sync** > **Review all agents**.
44-
1. Download the Azure AD Connect provisioning agent from the Azure portal.
45-
46-
![Screenshot that shows Download on-premises agent.](media/how-to-install/install-9.png)</br>
47-
1. Accept the terms and select **Download**.
48-
1. Run the Azure AD Connect provisioning installer AADConnectProvisioningAgentSetup.msi.
49-
1. On the **Microsoft Azure AD Connect Provisioning Agent Package** screen, accept the licensing terms and select **Install**.
50-
51-
![Screenshot that shows the Microsoft Azure AD Connect Provisioning Agent Package screen.](media/how-to-install/install-1.png)</br>
52-
1. After this operation finishes, the configuration wizard starts. Sign in with your Azure AD global administrator account.
53-
1. On the **Configure Service Account** screen, select either **Create gMSA** or **Use custom gMSA**. If you allow the agent to create the account, it will be named provAgentgMSA$. If you specify **Use custom gMSA**, you're prompted to provide this account.
54-
1. Enter the domain admin credentials to create the group Managed Service account that will be used to run the agent service. Select **Next**.
55-
56-
![Screenshot that shows the Create gMSA option.](media/how-to-install/install-12.png)</br>
57-
1. On the **Connect Active Directory** screen, select **Add Directory**. Then sign in with your Active Directory administrator account. This operation adds your on-premises directory.
58-
1. Optionally, you can manage the preference of domain controllers the agent will use by selecting the **Select domain controller priority** checkbox and ordering the list of domain controllers. Select **OK**.
59-
60-
![Screenshot that shows ordering the domain controllers.](media/how-to-install/install-2a.png)</br>
61-
1. Select **Next**.
62-
63-
![Screenshot that shows the Connect Active Directory screen.](media/how-to-install/install-3a.png)</br>
64-
1. On the **Agent installation** screen, confirm settings and the account that will be created and select **Confirm**.
65-
66-
![Screenshot that shows the Confirm settings.](media/how-to-install/install-11.png)</br>
67-
1. After this operation finishes, you should see **Your agent installation is complete.** Select **Exit**.
68-
69-
![Screenshot that shows the Configuration complete screen.](media/how-to-install/install-4a.png)</br>
70-
1. If you still see the initial **Microsoft Azure AD Connect Provisioning Agent Package** screen, select **Close**.
41+
2. Sign in to the Azure portal, and then go to **Azure Active Directory**.
42+
3. On the menu on the left, select **Azure AD Connect**.
43+
4. Select **Manage cloud sync**.
44+
[![Screenshot that shows manage cloud sync](media/how-to-install/new-install-1.png)](media/how-to-install/new-install-1.png#lightbox)</br>
45+
5. At the top, click **Download agent**.
46+
[![Screenshot that the download agent](media/how-to-install/new-install-2.png)](media/how-to-install/new-install-2.png#lightbox)</br>
47+
7. On the right, click **Accept terms and download**.
48+
[![Screenshot that accept and download](media/how-to-install/new-install-3.png)](media/how-to-install/new-install-3.png#lightbox)</br>
49+
9. Once the agent has completed downloading, click **Open file**. This will start the installation.
50+
[![Screenshot that shows open file](media/how-to-install/new-install-4.png)](media/how-to-install/new-install-4.png#lightbox)</br>
51+
10. On the **Microsoft Azure AD Connect Provisioning Agent Package** screen, accept the licensing terms, and select **Install**.
52+
[![Screenshot that shows install](media/how-to-install/new-install-5.png)](media/how-to-install/new-install-5.png#lightbox)</br>
53+
11. After this operation finishes, the configuration wizard starts. Click **Next**.
54+
[![Screenshot that shows wizard](media/how-to-install/new-install-6.png)](media/how-to-install/new-install-6.png#lightbox)</br>
55+
13. Sign in with your Azure AD global administrator account.
56+
14. On the **Configure Service Account** screen, select either **Create gMSA**, or **Use custom gMSA**. If you allow the agent to create the account, it will be named **provAgentgMSA$**. If you specify **Use custom gMSA**, you're prompted to provide this account.
57+
[![Screenshot that shows create service account](media/how-to-install/new-install-7.png)](media/how-to-install/new-install-7.png#lightbox)</br>
58+
15. Enter the domain administrator credentials to create the group Managed Service account that will be used to run the agent service. Select **Next**.
59+
![Screenshot that shows the Create gMSA option.](media/how-to-install/install-12.png)</br>
60+
16. On the **Connect Active Directory** screen, click **Next**. Your current domain has been added automatically. If you wish to add additional domains, enter them and select **Add Directory**. Then sign in with an administrator account from that domain.
61+
[![Screenshot that shows connecting to AD](media/how-to-install/new-install-8.png)](media/how-to-install/new-install-8.png#lightbox)</br>
62+
17. Optionally, you can manage the preference of domain controllers the agent will use. To do this, click **Add Directory** and select the **Select domain controller priority** checkbox and then order the list of domain controllers. Select **OK**. Click **Next**.
63+
[![Screenshot that shows adding domain controller priority](media/how-to-install/new-install-10.png)](media/how-to-install/new-install-10.png#lightbox)</br>
64+
18. On the **Agent installation** screen, confirm settings and the account that will be created and select **Confirm**.
65+
[![Screenshot that shows install confirmation](media/how-to-install/new-install-11.png)](media/how-to-install/new-install-11.png#lightbox)</br>
66+
20. After this operation finishes, you should see **Your agent installation is complete.** Select **Exit**.
67+
21. If you still see the initial **Microsoft Azure AD Connect Provisioning Agent Package** screen, select **Close**.
7168

7269
## Verify agent installation
7370
Agent verification occurs in the Azure portal and on the local server that's running the agent.
@@ -76,33 +73,27 @@ Agent verification occurs in the Azure portal and on the local server that's run
7673
To verify the agent is being seen by Azure:
7774

7875
1. Sign in to the Azure portal.
79-
1. On the left, select **Azure Active Directory** > **Azure AD Connect**. In the center, select **Manage cloud sync**.
80-
76+
2. On the left, select **Azure Active Directory** > **Azure AD Connect**. In the center, select **Manage cloud sync**.
8177
![Screenshot that shows the Azure portal.](media/how-to-install/install-6.png)</br>
82-
83-
1. On the **Azure AD Connect cloud sync** screen, select **Review all agents**.
84-
78+
3. On the **Azure AD Connect cloud sync** screen, select **Review all agents**.
8579
![Screenshot that shows the Review all agents option.](media/how-to-install/install-7.png)</br>
86-
87-
1. On the **On-premises provisioning agents** screen, you see the agents you installed. Verify that the agent in question is there and is marked *active*.
88-
80+
4. On the **On-premises provisioning agents** screen, you see the agents you installed. Verify that the agent in question is there and is marked *active*.
8981
![Screenshot that shows On-premises provisioning agents screen.](media/how-to-install/verify-1.png)</br>
9082

9183
### On the local server
9284
To verify that the agent is running:
9385

9486
1. Sign in to the server with an administrator account.
95-
1. Open **Services** by going to it or by selecting **Start** > **Run** > **Services.msc**.
96-
1. Under **Services**, make sure **Microsoft Azure AD Connect Agent Updater** and **Microsoft Azure AD Connect Provisioning Agent** are there and their status is *Running*.
97-
98-
![Screenshot that shows the Services screen.](media/how-to-install/troubleshoot-1.png)
87+
2. Open **Services** by going to it or by selecting **Start** > **Run** > **Services.msc**.
88+
3. Under **Services**, make sure **Microsoft Azure AD Connect Agent Updater** and **Microsoft Azure AD Connect Provisioning Agent** are present. Also, ensure the status is *Running*.
89+
![Screenshot that shows the Services screen.](media/how-to-install/troubleshoot-1.png)
9990

10091
>[!IMPORTANT]
10192
>The agent has been installed, but it must be configured and enabled before it will start synchronizing users. To configure a new agent, see [Create a new configuration for Azure AD Connect cloud sync](how-to-configure.md).
10293
10394
## Enable password writeback in Azure AD Connect cloud sync
10495

105-
To use password writeback and enable the SSPR service to detect the cloud sync agent , you need to use the `Set-AADCloudSyncPasswordWritebackConfiguration` cmdlet and tenant’s global administrator credentials:
96+
To use password writeback and enable the self-service password reset (SSPR) service to detect the cloud sync agent, you need to use the `Set-AADCloudSyncPasswordWritebackConfiguration` cmdlet and tenant’s global administrator credentials:
10697

10798
```
10899
Import-Module "C:\\Program Files\\Microsoft Azure AD Connect Provisioning Agent\\Microsoft.CloudSync.Powershell.dll"
@@ -111,6 +102,12 @@ To use password writeback and enable the SSPR service to detect the cloud sync a
111102

112103
For more information on using password writeback with Azure AD Connect cloud sync, see [Tutorial: Enable cloud sync self-service password reset writeback to an on-premises environment (preview)](../../active-directory/authentication/tutorial-enable-cloud-sync-sspr-writeback.md).
113104

105+
## Installing against US govt cloud
106+
By default, the Azure Active Directory (Azure AD) Connect provisioning agent installs against the default Azure cloud environment. If you are installing the agent for use in the US government cloud do the following:
107+
108+
- In step #7 above, instead of click **Open file**, go to start run and navigate to the **AADConnectProvisioningAgentSetup.exe** file. In the run box, after the executable, enter **ENVIRONMENTNAME=AzureUSGovernment** and click **Ok**.
109+
[![Screenshot showing US govt cloud install](media/how-to-install/new-install-12.png)](media/how-to-install/new-install-12.png#lightbox)</br>
110+
114111

115112
## Next steps
116113

93.5 KB
Loading
46.1 KB
Loading
111 KB
Loading
36.8 KB
Loading
68.7 KB
Loading
34.8 KB
Loading
17.2 KB
Loading
74.8 KB
Loading

0 commit comments

Comments
 (0)