Skip to content

Commit 9328ffb

Browse files
committed
added new draft
1 parent ea594b3 commit 9328ffb

File tree

4 files changed

+45
-4
lines changed

4 files changed

+45
-4
lines changed

articles/active-directory-domain-services/concepts-custom-attributes.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.service: active-directory
1010
ms.subservice: domain-services
1111
ms.workload: identity
1212
ms.topic: how-to
13-
ms.date: 01/29/2023
13+
ms.date: 03/06/2023
1414
ms.author: justinha
1515

1616
---
@@ -21,14 +21,55 @@ For various reasons, companies often can’t modify code for legacy apps. For ex
2121
Azure AD supports adding custom data to resources using [extensions](/graph/extensibility-overview). Azure Active Directory Domain Services (Azure AD DS) can synchronize the following types of extensions from Azure AD, so you can also use apps that depend on custom attributes with Azure AD DS:
2222

2323
- [onPremisesExtensionAttributes](/graph/extensibility-overview?tabs=http#extension-attributes) are a set of 15 attributes that can store extended user string attributes.
24-
- [Directory Extensions](/graph/extensibility-overview?tabs=http#directory-azure-ad-extensions) allow the schema extension of specific directory objects, such as users and groups, with strongly-typed attributes through registration with an application in the tenant.
24+
- [Directory extensions](/graph/extensibility-overview?tabs=http#directory-azure-ad-extensions) allow the schema extension of specific directory objects, such as users and groups, with strongly-typed attributes through registration with an application in the tenant.
2525

26-
Both types of extensions can be configured By using Azure AD Connect for users who are managed on-premises, or MSGraph APIs for cloud-only users.
26+
Both types of extensions can be configured By using Azure AD Connect for users who are managed on-premises, or Microsoft Graph APIs for cloud-only users.
2727

2828
>[!Note]
29-
>It is not supported to synchronize the following types of extensions:
29+
>The following types of extensions aren't supported for synchronization:
3030
>- Custom Security Attributes in Azure AD (Preview)
3131
>- MSGraph Schema Extensions
3232
>- Open Extensions
3333
3434

35+
## Requirements
36+
37+
The minimum SKU supported for custom attributes is the Enterprise SKU. If you use Standard, you need to [upgrade](change-sku.md) the managed domain to Enterprise or Premium. For more information, see [Azure Active Directory Domain Pricing](https://azure.microsoft.com/pricing/details/active-directory-ds/).
38+
39+
## How Custom Attributes work
40+
41+
After you create a managed domain, click **Custom Attributes (Preview)** under **Settings** to enable attribute synchronization.
42+
43+
:::image type="content" border="true" source="./media/concepts-custom-attributes/enable.png" alt-text="Screenshot of how to enable custom attributes.":::
44+
45+
## Enable predefined attribute synchronization
46+
47+
Click **OnPremisesExtensionAttributes** to synchronize the attributes extensionAttribute1-15, also known as [Exchange custom attributes](/graph/api/resources/onpremisesextensionattributes?view=graph-rest-1.0).
48+
49+
## Synchronize Azure AD directory extension attributes
50+
51+
These are the extended user or group attributes defined in your Azure AD tenant.
52+
53+
Select **+ Add** to choose which custom attributes to synchronize. The list will be populated with the available extension properties in your tenant. You can filter the list by using the search bar.
54+
55+
:::image type="content" border="true" source="./media/concepts-custom-attributes/add.png" alt-text="Screenshot of how to add directory extension attributes.":::
56+
57+
58+
If you don't see the directory extension you are looking for, enter the extension’s associated application appId and click **Search** to load only that application’s defined extension properties. This search helps when multiple applications define many extensions in your tenant.
59+
60+
>[!NOTE]
61+
>If you would like to see directory extensions synchronized by Azure AD Connect, click **Enterprise App** and look for the Application ID of the **Tenant Schema Extension App**. For more information, see [Azure AD Connect sync: Directory extensions](../active-directory/hybrid/how-to-connect-sync-feature-directory-extensions.md#configuration-changes-in-azure-ad-made-by-the-wizard).
62+
63+
Click **Select**, and then **Save** to confirm the change.
64+
65+
:::image type="content" border="true" source="./media/concepts-custom-attributes/select.png" alt-text="Screenshot of how to save directory extension attributes.":::
66+
67+
Azure AD DS will back fill all synchronized users and groups with the onboarded custom attribute values. The custom attribute values will gradually populate for objects that contain the directory extension in Azure AD. During the backfill synchronization process, incremental changes in Azure AD will temporarily be paused, and the sync time will depend on the size of the tenant.
68+
69+
To check the backfilling status, click **Azure AD DS Health** and verify the **Synchronization with Azure AD** monitor has an updated timestamp within an hour since onboarding. Once updated, the backfill is complete.
70+
71+
## Next steps
72+
73+
To configure onPremisesExtensionAttributes or directory extensions for cloud-only users in Azure AD, see [Custom data options in Microsoft Graph](/graph/extensibility-overview?tabs=http#custom-data-options-in-microsoft-graph).
74+
75+
To sync onPremisesExtensionAttributes or directory extensions from on-premises to Azure AD, [configure Azure AD Connect](../active-directory/hybrid/how-to-connect-sync-feature-directory-extensions.md).
64.1 KB
Loading
158 KB
Loading
27.8 KB
Loading

0 commit comments

Comments
 (0)