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
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| description | String | Description for the administrative unit.|
49
49
| displayName | String | Display name for the administrative unit. |
50
-
| membershipRule | String |Dynamic membership rule for the administrative unit. For more about the rules that you can use for dynamic administrative units and dynamic groups, see [Using attributes to create advanced rules](https://azure.microsoft.com/documentation/articles/active-directory-accessmanagement-groups-with-advanced-rules/).|
51
-
| membershipRuleProcessingState | String |Used to control whether the dynamic membership rule is actively processed. Set to `On`when you want the dynamic membership rule to be active and `Paused` if you want to stop updating membership dynamically. |
52
-
| membershipType | String |Membership type for the administrative unit. Can be `dynamic` or `assigned`. |
53
-
| visibility | String |Visibility for the administrative unit. If not set, then the default is `public`. Can be set to `HiddenMembership`, which hides the membership from nonmembers. |
50
+
| membershipRule | String |The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see [Manage rules for dynamic membership groups in Microsoft Entra ID](/entra/identity/users/groups-dynamic-membership).|
51
+
| membershipRuleProcessingState | String |Controls whether the dynamic membership rule is actively processed. Set to `On`to activate the dynamic membership rule, or `Paused` to stop updating membership dynamically. |
52
+
| membershipType | String |Indicates the membership type for the administrative unit. The possible values are: `dynamic`, `assigned`. If not set, the default value is `null` and the default behavior is assigned. |
53
+
| visibility | String |The visibility of the administrative unit. If not set, the default value is `null` and the default behavior is public. It can be set to `HiddenMembership` to hide the membership from nonmembers. |
54
54
55
-
Since the **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), you can use the `PATCH` operation to add, update, or delete your own app-specific data in custom properties of an extension in an existing **administrativeUnit** instance.
55
+
The **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), which allows you to use the `PATCH` operation to add, update, or delete your own app-specific data in custom properties of an extension in an existing **administrativeUnit** instance.
56
56
57
57
## Response
58
58
59
59
If successful, this method returns a `204 No Content` response code.
60
60
61
61
## Examples
62
62
63
-
The following example sets a dynamic membership rule on an existing administrative unit to include all users whose country is United States. It also updates the administrative unit display name.
64
-
65
63
### Request
66
64
65
+
The following example shows a request that sets a dynamic membership rule on an existing administrative unit to include all users whose country is the United States. It also updates the display name of the administrative unit.
@@ -32,6 +32,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
32
32
POST /administrativeUnits
33
33
POST /directory/administrativeUnits
34
34
```
35
+
35
36
## Request headers
36
37
| Name |Description|
37
38
|:----------|:----------|
@@ -41,19 +42,19 @@ POST /directory/administrativeUnits
41
42
## Request body
42
43
In the request body, supply a JSON representation of an [administrativeUnit](../resources/administrativeunit.md) object.
43
44
44
-
You can specify the following properties when creating an **administrativeUnit**.
45
+
You can specify the following properties when you create an **administrativeUnit**.
45
46
46
47
| Property | Type |Description|
47
48
|:---------------|:--------|:----------|
48
49
| description | String | Description for the administrative unit. Optional. |
49
50
| displayName | String | Display name for the administrative unit. Required. |
50
51
| isMemberManagementRestricted | Boolean |`true` if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. Default value is `false`. Use this property to define administrative units whose roles don't inherit from tenant-level administrators, and management of individual member objects is limited to administrators scoped to a restricted management administrative unit. Immutable, so can't be changed later. Optional. |
51
-
| membershipRule | String |Dynamic membership rule for the administrative unit. For more about the rules that you can use for dynamic administrative units and dynamic groups, see [Using attributes to create advanced rules](https://azure.microsoft.com/documentation/articles/active-directory-accessmanagement-groups-with-advanced-rules/). Optional.|
52
-
| membershipRuleProcessingState | String |Used to control whether the dynamic membership rule is actively processed. Set to `On`when you want the dynamic membership rule to be active and `Paused` if you want to stop updating membership dynamically. Optional. |
53
-
| membershipType | String |Membership type for the administrative unit. Can be `dynamic` or `assigned`. Optional. |
54
-
| visibility |String |Visibility for the administrative unit. If not set, then the default is `public`. Can be set to `HiddenMembership`, which hides the membership from non-members. Optional. |
52
+
| membershipRule | String |The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see [Manage rules for dynamic membership groups in Microsoft Entra ID](/entra/identity/users/groups-dynamic-membership). Optional.|
53
+
| membershipRuleProcessingState | String |Controls whether the dynamic membership rule is actively processed. Set to `On`to activate the dynamic membership rule, or `Paused` to stop updating membership dynamically. Optional. |
54
+
| membershipType | String |Indicates the membership type for the administrative unit. The possible values are: `dynamic`, `assigned`. If not set, the default value is `null` and the default behavior is assigned. Optional. |
55
+
| visibility |String |The visibility of the administrative unit. If not set, the default value is `null` and the default behavior is public. It can be set to `HiddenMembership` to hide the membership from nonmembers. Optional. |
55
56
56
-
Because the **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), you can use the `POST` operation and add custom properties with your own data to the administrative unit while creating it.
57
+
The **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), which allows you to use the `POST` operation to add custom properties with your own data when you create the administrative unit.
57
58
58
59
## Response
59
60
@@ -66,7 +67,7 @@ If successful, this method returns a `201 Created` response code and an [adminis
66
67
The following example creates a new administrative unit with a dynamic membership rule to include all users whose country is United States.
The following example creates a new restricted management administrative unit. The `isMemberManagementRestricted` property is immutable, so can't be changed later.
Copy file name to clipboardExpand all lines: api-reference/beta/resources/administrativeunit.md
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -62,10 +62,10 @@ This resource supports:
62
62
|displayName|String|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`.|
63
63
|id|String|Unique identifier for the administrative unit. Read-only. Supports `$filter` (`eq`).|
64
64
|isMemberManagementRestricted|Boolean|`true` if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. Default value is `false`. Use this property to define administrative units whose roles don't inherit from tenant-level administrators, and management of individual member objects is limited to administrators scoped to a restricted management administrative unit. Immutable, so can't be changed later. <br/><br/> For more information about working with restricted management administrative units, see [Restricted management administrative units in Microsoft Entra ID](/azure/active-directory/roles/admin-units-restricted-management).|
65
-
| membershipRule | String |Dynamic membership rule for the administrative unit. For more about the rules that you can use for dynamic administrative units and dynamic groups, see [Using attributes to create advanced rules](https://azure.microsoft.com/documentation/articles/active-directory-accessmanagement-groups-with-advanced-rules/). |
66
-
| membershipRuleProcessingState | String |Used to control whether the dynamic membership rule is actively processed. Set to `On`when you want the dynamic membership rule to be active and `Paused`if you want to stop updating membership dynamically. If not set, the default behavior is `Paused`. |
67
-
| membershipType | String |Membership type for the administrative unit. Can be `dynamic` or `assigned`. If not set, the default behavior is `assigned`. |
68
-
| visibility | String | Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership` or `Public`. If not set, the default behavior is `Public`. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit. |
65
+
| membershipRule | String |The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see [Manage rules for dynamic membership groups in Microsoft Entra ID](/entra/identity/users/groups-dynamic-membership). |
66
+
| membershipRuleProcessingState | String |Controls whether the dynamic membership rule is actively processed. Set to `On`to activate the dynamic membership rule, or `Paused` to stop updating membership dynamically. |
67
+
| membershipType | String |Indicates the membership type for the administrative unit. The possible values are: `dynamic`, `assigned`. If not set, the default value is `null` and the default behavior is assigned. |
68
+
| visibility | String | Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership` or `Public`. If not set, the default value is `null` and the default behavior is public. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit. |
69
69
70
70
> [!TIP]
71
71
> Directory extensions and associated data are returned by default while schema extensions and associated data returned only on `$select`.
@@ -96,12 +96,11 @@ The following JSON representation shows the resource type.
0 commit comments