Skip to content

Commit ea49068

Browse files
thomps23thomps23
authored
Merge pull request #299627 from MicrosoftDocs/release-build-azure-service-groups
 [Build 2025 ship room] Azure Service Groups
2 parents 9e296d6 + 44a8c76 commit ea49068

15 files changed

+896
-0
lines changed

‎articles/governance/index.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ productDirectory:
4040
text: Protect your resource hierarchy
4141
- url: ./management-groups/index.yml
4242
text: See more >
43+
- title: Azure Service Groups
44+
imageSrc: ./media/management-groups.svg
45+
links:
46+
- url: ./service-groups/overview.md
47+
text: Developer overview
48+
- url: ./service-groups/create-service-group-rest-api.md
49+
text: Create a service group using the REST API
50+
- url: ./service-groups/create-service-group-member-rest-api.md
51+
text: Connect resources or resource containers to service groups
52+
- url: ./service-groups/manage-service-groups.md
53+
text: Manage Service Groups
4354
- title: Azure Policy
4455
imageSrc: ./media/azure-policy.svg
4556
links:

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

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: "Quickstart: Connect Service Group members using the REST API - Azure Governance"
3+
description: In this quickstart, you use REST API to connect a resource to a service group with a service group member relationship.
4+
author: rthorn17
5+
ms.author: rithorn
6+
ms.service: azure-policy
7+
ms.topic: quickstart
8+
ms.date: 5/19/2025
9+
---
10+
11+
12+
# Quickstart: Connect resources or resource containers to service groups with Service Group Member Relationships
13+
14+
To connect 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).
15+
16+
> [!IMPORTANT]
17+
> Azure Service Groups is currently in PREVIEW.
18+
> For more information about participating in the preview, see [Azure Service Groups Preview](https://aka.ms/ServiceGroups/PreviewSignup).
19+
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
20+
21+
## Prerequisites
22+
23+
- If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/)
24+
account before you begin.
25+
26+
- If you haven't already, install [ARMClient](https://github.com/projectkudu/ARMClient). It's a tool
27+
that sends HTTP requests to Azure Resource Manager-based REST APIs.
28+
29+
## Create in REST API
30+
31+
For REST API, use the
32+
[Service Groups Member- Create or Update]() endpoint to create a new service group member.
33+
34+
In this example, we're connecting a Virtual Machine [VM1] to a service group [Contoso].
35+
36+
1. Service Group: **groupId** is _Contoso_
37+
1. Virtual Machine: The **resourceID** is _VM1_
38+
1. Service Group Member: The **relationshipID** is _SGM1_
39+
40+
When you're adding a resource to a service group, you create service group member by extending the resource.
41+
42+
- REST API URI
43+
44+
```http
45+
PUT https://management.azure.com/[scope]/providers/Microsoft.Relationships/serviceGroupMember/SGM1?api-version=2023-09-01-preview
46+
```
47+
48+
49+
In the preceding example, the new service group member is created extending the Virtual Machine. To
50+
specify the service group as the parent, use the **TargetID** property.
51+
52+
- REST API URI
53+
54+
```http
55+
PUT https://management.azure.com/subscriptions/[SUBID]/resourceGroups/[RGID]/providers/microsoft.compute/virtualmachine/[VMID]/providers/Microsoft.Relationships/serviceGroupMember/SGM1?api-version=2024-02-01-preview
56+
```
57+
58+
- Request Body
59+
60+
```json
61+
{
62+
"properties": {
63+
"targetId": "providers/microsoft.management/servicegroups/Contoso"
64+
}
65+
}
66+
```
67+
68+
## Clean up resources
69+
70+
To remove the service group created in this document, use the
71+
[Service Group Member Delete]() endpoint:
72+
73+
- REST API URI
74+
75+
```http
76+
DELETE https://management.azure.com/[scope]/providers/Microsoft.Relationships/serviceGroupMember/SGM1?api-version=2023-09-01-preview
77+
```
78+
79+
- No Request Body
80+
81+
82+
## Next step
83+
84+
In this quickstart, you created a service group to help create different views in Azure. The
85+
service group can have member subscriptions, resource groups, resources, or other service groups.
86+
87+
To learn more about service groups and how to manage your service group hierarchy, continue to:
88+
89+
> [!div class="nextstepaction"]
90+
> [Manage your resources with service groups](manage-service-groups.md)
91+

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

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: "Quickstart: Create a service group using the Azure portal - Azure Governance"
3+
description: In this quickstart, you use the portal to create a service group to organize your resources.
4+
author: rthorn17
5+
ms.author: rithorn
6+
ms.service: azure-policy
7+
ms.topic: quickstart
8+
ms.date: 5/19/2025
9+
---
10+
11+
12+
# Quickstart: Create a service group (preview) in the portal
13+
14+
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).
15+
16+
> [!IMPORTANT]
17+
> Azure Service Groups is currently in PREVIEW.
18+
> For more information about participating in the preview, see [Azure Service Groups Preview](https://aka.ms/ServiceGroups/PreviewSignup).
19+
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
20+
21+
## Prerequisites
22+
23+
- If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/)
24+
account before you begin.
25+
26+
## Create in Azure portal
27+
28+
1. Log into the [Azure portal](https://portal.azure.com).
29+
2. Select **All services** > **Management + governance**.
30+
3. Select **Service Groups**.
31+
4. Select **+ Add Service Group**.
32+
33+
:::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**.
45+
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]"_
47+
48+
7. Select "Next"
49+
8. The review page shows
50+
51+
:::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":::
52+
53+
9. If all information is correct, select **Create**
54+
55+
## Clean up resources
56+
57+
1. Select **All services** > **Management + governance**.
58+
59+
1. Select **Service Groups**.
60+
61+
1. Find the service group created that you want to delete, select it, then select the box.
62+
63+
1. Select the **delete** button at the top of the page.
64+
65+
## Next steps
66+
67+
In this quickstart, you created a service group. The service group can hold subscriptions, resource groups, or resources.
68+
69+
To learn more about service groups and how to manage your hierarchy, continue to:
70+
71+
> [!div class="nextstepaction"]
72+
> [How to: Manage Service Groups](manage-service-groups.md)
73+
74+
## Related content
75+
* [What are Azure Service Groups?](overview.md)
76+
* [How to: Manage Service Groups](manage-service-groups.md)
77+
* [Connect service group members with REST API](create-service-group-member-rest-api.md)

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

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: "Quickstart: Create a service group with REST API - Azure Governance"
3+
description: In this quickstart, you use REST API to create a service group to organize your resources.
4+
author: rthorn17
5+
ms.author: rithorn
6+
ms.service: azure-policy
7+
ms.topic: quickstart
8+
ms.date: 5/19/2025
9+
---
10+
11+
12+
# Quickstart: Create a service group (preview) with REST API
13+
14+
With Azure Service Groups (preview) you can create low-privilege-based groupings of resources across subscriptions. They provide a way to manage resources with minimal permissions, ensuring that resources can be grouped and managed without granting excessive access. Service Groups are designed to complement existing organizational structures like Resource Groups, Subscriptions, and Management Groups by offering a flexible and secure way to aggregate resources for specific purposes. For more information on service groups, see [Getting started with Service Groups](overview.md).
15+
16+
> [!IMPORTANT]
17+
> Azure Service Groups is currently in PREVIEW.
18+
> For more information about participating in the preview, see [Azure Service Groups Preview](https://aka.ms/ServiceGroups/PreviewSignup).
19+
> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
20+
21+
## Prerequisites
22+
23+
- If you don't have an Azure subscription, create a [free](https://azure.microsoft.com/free/)
24+
account before you begin.
25+
26+
- If you haven't already, install [ARMClient](https://github.com/projectkudu/ARMClient). It's a tool
27+
that sends HTTP requests to Azure Resource Manager-based REST APIs.
28+
29+
## Create in REST API
30+
31+
In this example, the service group **groupId** is
32+
_Contoso_.
33+
34+
- REST API URI
35+
36+
```http
37+
PUT https://management.azure.com/providers/Microsoft.Management/serviceGroups/Contoso?api-version=2024-02-01-preview
38+
```
39+
40+
- Request Body
41+
42+
The **groupId** is a unique identifier being created. This ID is used by other commands to reference
43+
this group and it can't be changed later.
44+
45+
If you want the service group to show a different name within the Azure portal, add the
46+
**properties.displayName** property in the request body. For example, to create a service group
47+
with the **groupId** of _Contoso_ and the display name of _Contoso Group_, use the following
48+
endpoint and request body:
49+
50+
```json
51+
{
52+
"properties": {
53+
"displayName": "_Contoso Group_",
54+
"parent": {
55+
"resourceId": "/providers/Microsoft.Management/serviceGroups/[tenantId]"
56+
}
57+
}
58+
}
59+
```
60+
61+
62+
In the preceding examples, the new service group is created under the root service group. To
63+
specify a different service group as the parent, use the **properties.parent.id** property.
64+
65+
- REST API URI
66+
67+
```http
68+
PUT https://management.azure.com/providers/Microsoft.Management/serviceGroups/Contoso?api-version=2024-02-01-preview
69+
```
70+
71+
- Request Body
72+
73+
```json
74+
{
75+
"properties": {
76+
"displayName": "Contoso Group",
77+
"parent": {
78+
"id": "/providers/Microsoft.Management/serviceGroups/HoldingGroup"
79+
}
80+
}
81+
}
82+
```
83+
84+
## Verify your Service Group was created
85+
Service Groups PUT or create call is an Asynchronous call which means that the response to the initial create call is that it was accepted. This response doesn't mean the service group was successfully created, only that the Azure successfully received the request to create the service group.
86+
87+
To check the operation was successful, you should do a GET call on the value returned in the **azure-asyncoperation** header. The URL provides the status of the created operation.
88+
89+
> [!NOTE]
90+
> To avoid issues within scripts or templates, the automation should poll this provided URL before moving to the next step.
91+
> If the automation moves to the next step before the operation has responded successfully, the next operation will fail as the service group has not been created.
92+
93+
## Clean up resources
94+
95+
To remove the service group created in this document, use the
96+
Service Group Delete endpoint:
97+
98+
- REST API URI
99+
100+
```http
101+
DELETE https://management.azure.com/providers/Microsoft.Management/serviceGroups/Contoso?api-version=2024-02-01-preview
102+
```
103+
104+
- No Request Body
105+
106+
## Related content
107+
* [What are Azure Service Groups?](overview.md)
108+
* [How to Manage Service Groups](manage-service-groups.md)
109+
* [Connect service group members with REST API](create-service-group-member-rest-api.md)

‎articles/governance/service-groups/index.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### YamlMime:Landing
2+
3+
title: Azure Service Groups documentation
4+
summary: Azure Service Groups.
5+
6+
metadata:
7+
title: Azure Service Groups documentation
8+
description: Azure Service Groups documentation.
9+
ms.service: azure-policy
10+
ms.topic: landing-page
11+
author: kenieva
12+
ms.author: kenieva
13+
ms.date: 02/25/2025
14+
15+
landingContent:
16+
- title: About Azure Service Groups
17+
linkLists:
18+
- linkListType: overview
19+
links:
20+
- text: What are Azure Service Groups?
21+
url: ./overview.md
22+
- linkListType: how-to-guide
23+
links:
24+
- text: Create a service group with REST API
25+
url: ./create-service-group-rest-api.md
26+
- text: Create a service group in Azure portal
27+
url: ./create-service-group-portal.md
28+
- text: Connect Service Group members using the REST API
29+
url: ./create-service-group-member-rest-api.md
30+
- text: How to use Service Groups to manage resources
31+
url: ./manage-service-groups.md

0 commit comments

Comments
 (0)