Skip to content

Commit 1286c5e

Browse files
authored
Merge pull request #5 from kenieva/service-groups-update
Improve service groups documentation: critical fixes and clarity
2 parents 1205fcf + 0bb4c8c commit 1286c5e

7 files changed

Lines changed: 152 additions & 67 deletions

File tree

articles/governance/service-groups/create-service-group-member-portal.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ ms.date: 11/3/2025
99
---
1010

1111

12-
# Quickstart: Add resources or resource containers to service groups with Service Group Member Relationships in Portal
12+
# Quickstart: Add resources or resource containers to service groups in the Azure portal
1313

14-
To add resources, resource groups, or subscriptions to a Service Group (preview), you need to create a new Service Group Member Relationship. For more information on service groups, see [Getting started with Service Groups](overview.md).
14+
To add resources, resource groups, or subscriptions to a Service Group (preview), you create a Service Group Member Relationship. This relationship links the resource to the service group without moving it from its current location. For more information on service groups, see [What are Azure Service Groups?](overview.md).
1515

1616
> [!IMPORTANT]
1717
> Azure Service Groups is currently in PREVIEW.
@@ -22,7 +22,11 @@ To add resources, resource groups, or subscriptions to a Service Group (preview)
2222
- If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/)
2323
account before you begin.
2424

25-
- To be able to deploy a service group member relationship, you must have Microsoft.Relationship/ServiceGroupMember/write permissions on member resource and [Service Group Contributor](../../role-based-access-control/built-in-roles/management-and-governance.md) at the target service group.
25+
- An existing service group. If you haven't created one yet, see [Create a service group in the portal](create-service-group-portal.md).
26+
27+
- To add a member, you need both:
28+
- **Microsoft.Relationship/ServiceGroupMember/write** permission on the resource you're adding (the member).
29+
- [**Service Group Contributor**](../../role-based-access-control/built-in-roles/management-and-governance.md) role on the target service group.
2630

2731
## Add members during service group creation
2832

@@ -32,7 +36,7 @@ To add resources, resource groups, or subscriptions to a Service Group (preview)
3236

3337
2. Select to add individual resources, resource groups, or subscriptions.
3438

35-
3. Once selected, you can use filters to narrow the list as needed.
39+
3. Once selected, use filters to narrow the list. You can filter by resource type, subscription, resource group, or location.
3640

3741
4. Once all members are chosen, press **Select**
3842

@@ -45,42 +49,50 @@ To add resources, resource groups, or subscriptions to a Service Group (preview)
4549

4650
## Add members to existing service group
4751

48-
1. Log into the [Azure portal](https://aka.ms/portalfx/service-groups-internal).
52+
1. Log into the [Azure portal](https://portal.azure.com/).
4953

50-
2. Select **All services** > **Management + governance**.
54+
2. Search for **Service Groups** using the top portal search bar.
5155

52-
3. Select **Service Groups**.
56+
3. Select **Service Groups** from the results.
5357

5458
4. Select the desired Service Group.
5559

56-
5. In the left hand side service menu, select **members** under relationship management.
60+
5. In the left hand side service menu, select **Members** under **Relationship management**.
5761

5862
:::image type="content" source="./media/members-service-menu.png" alt-text="Screenshot of the relationship management drop down within the left hand context pane on the service group page." Lightbox="./media/members-service-menu.png":::
5963

6064
6. To add members, select the **+Add** button on the top action bar. Select to add individual resources, resource groups, or subscriptions. On the **Add members** pane, select and filter to the desired resources. Once all members are chosen, select **Add**.
6165

6266

63-
## Remove members to existing service group
67+
## Remove members from an existing service group
6468

65-
1. Log into the [Azure portal](https://aka.ms/portalfx/service-groups-internal).
69+
1. Log into the [Azure portal](https://portal.azure.com/).
6670

67-
2. Select **All services** > **Management + governance**.
71+
2. Search for **Service Groups** using the top portal search bar.
6872

69-
3. Select **Service Groups**.
73+
3. Select **Service Groups** from the results.
7074

7175
4. Select the desired Service Group.
7276

73-
5. In the left hand side service menu, select **members** under relationship management.
77+
5. In the left hand side service menu, select **Members** under **Relationship management**.
78+
79+
6. Select the members from the list by clicking the check box and press **Delete** from the top action bar. This removes the resource as a member, but doesn't delete the resource itself.
7480

75-
6. Select the members from the list of members by clicking the check box and press **Delete** from the top action bar. This removes the resource as a member, but won't delete the resource.
81+
> [!NOTE]
82+
> Removing a member only breaks the connection between the resource and the service group. The underlying resource, resource group, or subscription isn't affected.
7683
7784
:::image type="content" source="./media/delete-members.png" alt-text="Screenshot of the delete button within the service group members page." Lightbox="./media/delete-members.png":::
7885

7986
## Next step
8087

8188
In this quickstart, you added members to service groups.
8289

83-
To learn more about service groups and how to manage your service group hierarchy, continue to:
90+
To learn more about managing membership at scale using Bicep, Azure Policy, or PowerShell scripts, see:
8491

8592
> [!div class="nextstepaction"]
86-
> [Manage your resources with service groups](manage-service-groups.md)
93+
> [Manage membership at scale](manage-membership.md)
94+
95+
## Related content
96+
* [What are Azure Service Groups?](overview.md)
97+
* [How to: Manage Service Groups](manage-service-groups.md)
98+
* [Add members using REST API](create-service-group-member-rest-api.md)

articles/governance/service-groups/create-service-group-member-rest-api.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,16 @@ To add resources, resource groups, or subscriptions to a Service Group (preview)
3131

3232
## Create in REST API
3333

34+
The `[scope]` in the URLs below refers to the full Azure Resource Manager path of the resource you want to add as a member. The scope varies depending on the type of resource:
35+
36+
| Resource type | Scope format |
37+
|---|---|
38+
| Subscription | `subscriptions/{subscriptionId}` |
39+
| Resource group | `subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}` |
40+
| Resource | `subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProvider}/{resourceType}/{resourceName}` |
41+
3442
For REST API, use the
35-
[Service Groups Member- Create or Update]() endpoint to create a new service group member.
43+
[Service Groups Member - Create or Update](/rest/api/resources/service-group-member/create-or-update) endpoint to create a new service group member.
3644

3745
In this example, we're adding a Virtual Machine [VM1] to a service group [Contoso].
3846

@@ -71,7 +79,7 @@ specify the service group as the parent, use the **TargetID** property.
7179
## Clean up resources
7280

7381
To remove the service group created in this document, use the
74-
[Service Group Member Delete]() endpoint:
82+
[Service Group Member - Delete](/rest/api/resources/service-group-member/delete) endpoint:
7583

7684
- REST API URI
7785

@@ -81,6 +89,22 @@ To remove the service group created in this document, use the
8189

8290
- No Request Body
8391

92+
## Verify your service group member
93+
94+
The Create Service Group Member API is an asynchronous call. A successful response means the request was accepted, but the operation may still be processing. To check the operation status:
95+
96+
1. Look for the **Azure-AsyncOperation** header in the response from the PUT request.
97+
2. Make a GET request to the URL in that header to check the operation status.
98+
99+
```json
100+
{
101+
"status": "Succeeded"
102+
}
103+
```
104+
105+
Possible status values include `Succeeded`, `Failed`, and `InProgress`. Wait for the operation to complete before relying on the membership relationship.
106+
107+
For more information on checking operation status, see [Checking for Service Group Operation Status](manage-service-groups.md#checking-for-service-group-operation-status).
84108

85109
## Next step
86110

articles/governance/service-groups/create-service-group-portal.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.custom:
1313

1414
# Quickstart: Create a service group (preview) in the portal
1515

16-
Azure Service Groups offer a flexible way to organize and manage resources across subscriptions and resource groups, parallel to any existing Azure resource hierarchy. They're ideal for scenarios requiring cross-boundary grouping, minimal permissions, and aggregations of data across resources. These features empower teams to create tailored resource collections that align with operational, organizational, or persona-based needs. This article helps give you an overview of what service groups are, the scenarios to use them for, and provide guidance on how to get started. For more information on service groups, see [Getting started with Service Groups](overview.md).
16+
Azure Service Groups let you create flexible, custom groupings of your Azure resources across subscriptions and resource groups, without changing your existing resource hierarchy. For a full overview of capabilities and scenarios, see [What are Azure Service Groups?](overview.md).
1717

1818
> [!IMPORTANT]
1919
> Azure Service Groups is currently in public preview.
@@ -23,53 +23,56 @@ Azure Service Groups offer a flexible way to organize and manage resources acros
2323

2424
- If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn)
2525
account before you begin.
26+
- You need **Service Group Contributor** or **Service Group Administrator** role on the parent service group where you want to create the new group. If creating under the root service group, see [Root Service Group access](./overview.md#the-root-service-group).
2627

2728
## Create in Azure portal
2829

2930
1. Log into the [Azure portal](https://portal.azure.com/).
30-
3. Search **Service Groups**.
31-
4. Select **+ Create Service Group**.
31+
32+
2. In the top search bar, search for **Service Groups** and select **Service Groups** from the results.
33+
34+
3. Select **+ Create Service Group**.
3235

3336
:::image type="content" source="./media/create-service-group.png" alt-text="Screenshot of new Service Group screen." Lightbox = "./media/create-service-group.png" :::
34-
5. Fill in the service group ID field
35-
36-
* The **Service Group ID** is the directory unique identifier that is used to submit commands
37-
on this service group. This identifier isn't editable after creation as it's used throughout
38-
the Azure system to identify this group. The
39-
[root service group](./overview.md#the-root-service-group) is
40-
automatically created with an ID that is the Microsoft Entra ID. For all other
41-
service groups, assign a unique ID.
42-
* The display name field is the name that is displayed within the Azure portal. A separate
43-
display name is an optional field when creating the service group and can be changed at any time.
44-
6. Select the **Parent Service Group**.
37+
38+
4. Fill in the **Service Group ID** field.
39+
40+
* The **Service Group ID** is a unique identifier used to reference this service group in API calls, scripts, and policies. This ID **can't be changed** after creation, so choose a meaningful and descriptive name (for example, `platform-networking` or `project-contoso-prod`).
41+
* The ID must be globally unique across all Microsoft Entra tenants. Two tenants can't have a Service Group with the same ID.
42+
* The **Display name** field is optional and can be changed at any time. It controls how the service group appears in the Azure portal.
43+
44+
5. Select the **Parent Service Group**.
4545

46-
* If you don't have a parent service group, or don't know what to pick, select the Root Service Group which has same ID as the tenant's ID. _"Microsoft.Management/serviceGroups[tenantId]"_
46+
* If you don't have a parent service group, or don't know what to pick, select the Root Service Group which has the same ID as your tenant's ID: `Microsoft.Management/serviceGroups/[tenantId]`
47+
48+
6. Select **Next** to proceed.
4749

48-
7. Select "Next"
49-
8. The review page shows
50+
7. The review page shows a summary of your choices.
5051

5152
:::image type="content" source="./media/create-review-service-group.png" alt-text="Screenshot of the review page for creating a new service group" Lightbox="./media/create-review-service-group.png":::
5253

53-
9. If all information is correct, select **Create**
54+
8. If all information is correct, select **Create**.
55+
56+
> [!TIP]
57+
> After creating your service group, the next step is to add members. See [Add members to a service group in the portal](create-service-group-member-portal.md) or [Add members using REST API](create-service-group-member-rest-api.md).
5458
5559
## Clean up resources
5660

57-
1. Search **Service Groups**.
61+
1. In the top search bar, search for **Service Groups** and select **Service Groups** from the results.
5862

59-
1. Find the service group created that you want to delete, select it, then select the box.
63+
1. Find the service group you want to delete, select the checkbox next to it.
6064

61-
1. Select the **delete** button at the top of the page.
65+
1. Select the **Delete** button at the top of the page.
6266

6367
## Next steps
6468

65-
In this quickstart, you created a service group. The service group can hold subscriptions, resource groups, or resources.
66-
67-
To learn more about service groups and how to manage your hierarchy, continue to:
69+
In this quickstart, you created a service group. The next step is to add resources, resource groups, or subscriptions as members.
6870

6971
> [!div class="nextstepaction"]
70-
> [How to: Manage Service Groups](manage-service-groups.md)
72+
> [Add members to a service group in the portal](create-service-group-member-portal.md)
7173
7274
## Related content
7375
* [What are Azure Service Groups?](overview.md)
7476
* [How to: Manage Service Groups](manage-service-groups.md)
75-
* [Connect service group members with REST API](create-service-group-member-rest-api.md)
77+
* [Add members using REST API](create-service-group-member-rest-api.md)
78+
* [Manage membership at scale](manage-membership.md)
Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
### YamlMime:Landing
22

33
title: Azure Service Groups documentation
4-
summary: Azure Service Groups.
4+
summary: Organize and manage resources across subscriptions with flexible, custom groupings using Azure Service Groups.
55

66
metadata:
77
title: Azure Service Groups documentation
8-
description: Azure Service Groups documentation.
8+
description: Learn how to create flexible resource groupings across subscriptions using Azure Service Groups. Build custom views for teams, projects, and workloads with minimal permissions.
99
ms.service: azure-policy
1010
ms.topic: landing-page
1111
author: kenieva
@@ -20,13 +20,19 @@ landingContent:
2020
links:
2121
- text: What are Azure Service Groups?
2222
url: ./overview.md
23-
- linkListType: how-to-guide
23+
- linkListType: quickstart
2424
links:
25+
- text: Create a service group in the Azure portal
26+
url: ./create-service-group-portal.md
2527
- text: Create a service group with REST API
2628
url: ./create-service-group-rest-api.md
27-
- text: Create a service group in Azure portal
28-
url: ./create-service-group-portal.md
29-
- text: Connect Service Group members using the REST API
29+
- text: Add members in the Azure portal
30+
url: ./create-service-group-member-portal.md
31+
- text: Add members with REST API
3032
url: ./create-service-group-member-rest-api.md
31-
- text: How to use Service Groups to manage resources
33+
- linkListType: how-to-guide
34+
links:
35+
- text: Manage Service Groups and members
3236
url: ./manage-service-groups.md
37+
- text: Manage membership at scale
38+
url: ./manage-membership.md

articles/governance/service-groups/manage-service-groups.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ This section shows you how to manage service group's actions create, read, updat
2929

3030
- HTTP method: **PUT**
3131
- Resource Provider: **Microsoft.Management**
32-
- API Version: **2024-04-01-preview**
33-
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview
32+
- API Version: **2024-02-01-preview**
33+
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-02-01-preview
3434

3535
Request Body:
3636
```json
@@ -61,7 +61,7 @@ API Response:
6161
}
6262
```
6363

64-
* **GroupID**: Required field in the URL that uniquely identifies the Service Group. This ID is immutable once created
64+
* **GroupID**:Required field in the URL that uniquely identifies the Service Group. This ID is immutable once created
6565
* Service groups must have a Global Unique Name. This means it isn't specific to Tenant it's being created in, but all tenants in that cloud. Ex. Public Cloud across all tenants.
6666
* **Kind**: Optional string property that is used by Resource Providers for scenarios. Kind value is immutable after creation.
6767
* **Display Name**: Optional String Property to display a different name rather than the Group ID
@@ -75,8 +75,8 @@ To update a service group, a PUT or PATCH API method can be used which have the
7575

7676
- HTTP method: **PUT** or **PATCH**
7777
- Resource Provider: **Microsoft.Management**
78-
- API Version: **2024-04-01-preview**
79-
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview
78+
- API Version: **2024-02-01-preview**
79+
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-02-01-preview
8080

8181

8282
Request Body:
@@ -113,8 +113,8 @@ For descriptions of the properties see [Create Service Group](#create-service-gr
113113

114114
- HTTP method: **DELETE**
115115
- Resource Provider: **Microsoft.Management**
116-
- API Version: **2024-04-01-preview**
117-
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview
116+
- API Version: **2024-02-01-preview**
117+
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-02-01-preview
118118
- No Request Body
119119

120120
API Response:
@@ -124,8 +124,8 @@ The DELETE response returns an HTTP Status Code. The HTTP DELETE Action is an As
124124

125125
- HTTP method: **GET**
126126
- Resource Provider: **Microsoft.Management**
127-
- API Version: **2024-04-01-preview**
128-
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-04-01-preview
127+
- API Version: **2024-02-01-preview**
128+
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]?api-version=2024-02-01-preview
129129
- No Request Body
130130

131131
API Response:
@@ -151,8 +151,8 @@ Service Groups has an API that allows you to get all the Service Group Parents a
151151

152152
- HTTP method: **POST**
153153
- Resource Provider: **Microsoft.Management**
154-
- API Version: **2024-04-01-preview**
155-
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]/listAncestors?api-version=2024-04-01-preview
154+
- API Version: **2024-02-01-preview**
155+
- URL: https://management.azure.com/providers/Microsoft.Management/serviceGroups/[groupID]/listAncestors?api-version=2024-02-01-preview
156156

157157
- No Request Body
158158

@@ -206,6 +206,14 @@ Service group members are resources, resource groups, or subscriptions that are
206206
### Create a Service Group Member
207207
Resources, resource groups, and subscriptions can all be made members of a service group. The Service Group Member relationship is created as an extension off the member that is being connected to the group.
208208

209+
The `[scope]` in the URLs below refers to the full Azure Resource Manager path of the resource being added as a member:
210+
211+
| Resource type | Scope format |
212+
|---|---|
213+
| Subscription | `subscriptions/{subscriptionId}` |
214+
| Resource group | `subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}` |
215+
| Resource | `subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProvider}/{resourceType}/{resourceName}` |
216+
209217
- HTTP method: **PUT**
210218
- Resource Provider: **Microsoft.Relationships**
211219
- API Version: **2023-09-01-preview**

0 commit comments

Comments
 (0)