Skip to content

Commit b30b343

Browse files
authored
Merge pull request #203683 from MicrosoftDocs/main
Merge main to live, 4 AM
2 parents bae27b7 + fb9a9c4 commit b30b343

File tree

39 files changed

+839
-344
lines changed

39 files changed

+839
-344
lines changed

articles/active-directory/app-provisioning/workday-integration-reference.md

Lines changed: 97 additions & 60 deletions
Large diffs are not rendered by default.

articles/active-directory/cloud-sync/how-to-gmsa-cmdlets.md

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ 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: 07/01/2022
1111
ms.subservice: hybrid
1212
ms.author: billmath
1313
ms.collection: M365-identity-device-management
1414
---
1515

1616
# Azure AD Connect cloud provisioning agent gMSA PowerShell cmdlets
1717

18-
The purpose of this document is to describe the Azure AD Connect cloud provisioning agent gMSA PowerShell cmdlets. These cmdlets allow you to have more granularity on the permissions that are applied on the service account (gMSA). By default, Azure AD Connect cloud sync applies all permissions similar to Azure AD Connect on the default gMSA or a custom gMSA.
18+
The purpose of this document is to describe the Azure AD Connect cloud provisioning agent gMSA PowerShell cmdlets. These cmdlets allow you to have more granularity on the permissions that are applied on the service account (gMSA). By default, Azure AD Connect cloud sync applies all permissions similar to Azure AD Connect on the default gMSA or a custom gMSA, during cloud provisioning agent install.
1919

2020
This document will cover the following cmdlets:
2121

22-
`Set-AADCloudSyncRestrictedPermissions`
23-
2422
`Set-AADCloudSyncPermissions`
2523

24+
`Set-AADCloudSyncRestrictedPermissions`
25+
2626
## How to use the cmdlets:
2727

2828
The following prerequisites are required to use these cmdlets.
@@ -32,34 +32,26 @@ The following prerequisites are required to use these cmdlets.
3232
2. Import Provisioning Agent PS module into a PowerShell session.
3333

3434
```powershell
35-
Import-Module "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Microsoft.CloudSync.Powershell.dll"
35+
Import-Module "C:\Program Files\Microsoft Azure AD Connect Provisioning Agent\Microsoft.CloudSync.Powershell.dll"
3636
```
3737

38-
3. Remove existing permissions. To remove all existing permissions on the service account, except SELF use: `Set-AADCloudSyncRestrictedPermission`.
39-
40-
This cmdlet requires a parameter called `Credential` which can be passed, or it will prompt if called without it.
38+
3. These cmdlets require a parameter called `Credential` which can be passed, or will prompt the user if not provided in the command line. Depending on the cmdlet syntax used, these credentials must be an enterprise admin account or, at a minimum, a domain administrator of the target domain where you're setting the permissions.
4139

42-
To create a variable, use:
40+
4. To create a variable for credentials, use:
4341

4442
`$credential = Get-Credential`
43+
44+
5. To set Active Directory permissions for cloud provisioning agent, you can use the following cmdlet. This will grant permissions in the root of the domain allowing the service account to manage on-premises Active Directory objects. See [Using Set-AADCloudSyncPermissions](#using-set-aadcloudsyncpermissions) below for examples on setting the permissions.
4545

46-
This will prompt the user to enter username and password. The credentials must be at a minimum domain administrator(of the domain where agent is installed), could be enterprise admin as well.
47-
48-
4. Then you can call the cmdlet to remove extra permissions:
46+
`Set-AADCloudSyncPermissions -EACredential $credential`
4947

50-
```powershell
51-
Set-AADCloudSyncRestrictedPermissions -Credential $credential
52-
```
53-
54-
5. Or you can simply call:
48+
6. To restrict Active Directory permissions set by default on the cloud provisioning agent account, you can use the following cmdlet. This will increase the security of the service account by disabling permission inheritance and removing all existing permissions, except SELF and Full Control for administrators. See [Using Set-AADCloudSyncRestrictedPermission](#using-set-aadcloudsyncrestrictedpermissions) below for examples on restricting the permissions.
5549

56-
`Set-AADCloudSyncRestrictedPermissions` which will prompt for credentials.
57-
58-
6. Add specific permission type. Permissions added are same as Azure AD Connect. See [Using Set-AADCloudSyncPermissions](#using-set-aadcloudsyncpermissions) below for examples on setting the permissions.
50+
`Set-AADCloudSyncRestrictedPermission -Credential $credential`
5951

6052
## Using Set-AADCloudSyncPermissions
6153

62-
`Set-AADCloudSyncPermissions` supports the following permission types which are identical to the permissions used by Azure AD Connect. The following permission types are supported:
54+
`Set-AADCloudSyncPermissions` supports the following permission types which are identical to the permissions used by Azure AD Connect Classic Sync (ADSync). The following permission types are supported:
6355

6456
|Permission type|Description|
6557
|-----|-----|
@@ -69,28 +61,43 @@ The following prerequisites are required to use these cmdlets.
6961
|HybridExchangePermissions|See [HybridExchangePermissions](../../active-directory/hybrid/how-to-connect-configure-ad-ds-connector-account.md#permissions-for-exchange-hybrid-deployment) permissions for Azure AD Connect|
7062
|ExchangeMailPublicFolderPermissions| See [ExchangeMailPublicFolderPermissions](../../active-directory/hybrid/how-to-connect-configure-ad-ds-connector-account.md#permissions-for-exchange-mail-public-folders) permissions for Azure AD Connect|
7163
|CloudHR| Applies 'Create/delete User objects' on 'This object and all descendant objects'|
72-
|All|adds all the above permissions.|
64+
|All| Applies all the above permissions|
7365

7466
You can use AADCloudSyncPermissions in one of two ways:
75-
- [Grant a certain permission to all configured domains](#grant-a-certain-permission-to-all-configured-domains)
76-
- [Grant a certain permission to a specific domain](#grant-a-certain-permission-to-a-specific-domain)
67+
- [Grant permissions to all configured domains](#grant-permissions-to-all-configured-domains)
68+
- [Grant permissions to a specific domain](#grant-permissions-to-a-specific-domain)
7769

78-
## Grant a certain permission to all configured domains
70+
## Grant permissions to all configured domains
7971

8072
Granting certain permissions to all configured domains will require the use of an enterprise admin account.
8173

8274
```powershell
83-
Set-AADCloudSyncPermissions -PermissionType "Any mentioned above" -EACredential $credential (prepopulated same as above [$credential = Get-Credential])
75+
$credential = Get-Credential
76+
Set-AADCloudSyncPermissions -PermissionType "Any mentioned above" -EACredential $credential
8477
```
8578

86-
## Grant a certain permission to a specific domain
79+
## Grant permissions to a specific domain
8780

88-
Granting certain permissions to a specific domain will require the use of, at minimum a domain admin account of the domain you are attempting to add.
81+
Granting certain permissions to a specific domain will require the use of a TargetDomainCredential that is enterprise admin or, domain admin of the target domain. The TargetDomain has to be already configured through wizard.
8982

9083
```powershell
91-
Set-AADCloudSyncPermissions -PermissionType "Any mentioned above" -TargetDomain "FQDN of domain" (has to be already configured through wizard) -TargetDomainCredential $credential(same as above)
84+
$credential = Get-Credential
85+
Set-AADCloudSyncPermissions -PermissionType "Any mentioned above" -TargetDomain "FQDN of domain" -TargetDomainCredential $credential
9286
```
9387

94-
Note: for 1. The credentials must be at a minimum Enterprise admin.
95-
96-
For 2. The Credentials can be either Domain admin or enterprise admin.
88+
## Using Set-AADCloudSyncRestrictedPermissions
89+
For increased security, `Set-AADCloudSyncRestrictedPermissions` will tighten the permissions set on the cloud provisioning agent account itself. Hardening permissions on the cloud provisioning agent account involves the following changes:
90+
91+
- Disable inheritance
92+
- Remove all default permissions, except ACEs specific to SELF.
93+
- Set Full Control permissions for SYSTEM, Administrators, Domain Admins, and Enterprise Admins.
94+
- Set Read permissions for Authenticated Users and Enterprise Domain Controllers.
95+
96+
The -Credential parameter is necessary to specify the Administrator account that has the necessary privileges to restrict Active Directory permissions on the cloud provisioning agent account. This is typically the domain or enterprise administrator.
97+
98+
For Example:
99+
100+
``` powershell
101+
$credential = Get-Credential
102+
Set-AADCloudSyncRestrictedPermissions -Credential $credential
103+
```

0 commit comments

Comments
 (0)