Skip to content

Commit 27da9b2

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #28452 from AnkushAtCryptoSkool/ga-v1-docs-related-changes
Tenant Configuration Management GA
2 parents c45ddda + 1ed649f commit 27da9b2

68 files changed

Lines changed: 3359 additions & 64 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api-reference/beta/api/configurationmanagement-list-configurationmonitors.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,3 +203,67 @@ Content-Type: application/json
203203
]
204204
}
205205
```
206+
207+
### Example 2: Error response when the service is unavailable
208+
209+
The following example shows an error response when the monitor encounters issues during execution.
210+
211+
#### Request
212+
213+
The following example shows a request.
214+
<!-- {
215+
"blockType": "request",
216+
"name": "list_configurationmonitor_error"
217+
}-->
218+
``` http
219+
GET https://graph.microsoft.com/beta/admin/configurationManagement/configurationMonitors
220+
```
221+
222+
#### Response
223+
224+
The following example shows the response.
225+
<!-- {
226+
"blockType": "response",
227+
"truncated": false,
228+
"@odata.type": "Collection(microsoft.graph.configurationMonitor)"
229+
}-->
230+
``` http
231+
HTTP/1.1 200 OK
232+
Content-Type: application/json
233+
234+
{
235+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/configurationManagement/configurationMonitors",
236+
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET admin/configurationManagement/configurationMonitors?$select=createdBy,createdDateTime",
237+
"value": [
238+
{
239+
"@odata.type": "#microsoft.graph.configurationMonitor",
240+
"id": "a1cbec62-453e-421f-94b5-7a4288bc122a",
241+
"inactivationReason": "Service unavailable - unable to process monitor",
242+
"displayName": "Sample Monitor",
243+
"description": "Sample EXO Monitor with SharedMailbox AcceptedDomain and MailContact",
244+
"tenantId": "96bf81b4-2694-42bb-9204-70081135ca61",
245+
"status": "active",
246+
"monitorRunFrequencyInHours": 6,
247+
"mode": "monitorOnly",
248+
"createdDateTime": "2024-12-11T05:50:42.6436339Z",
249+
"lastModifiedBy": {
250+
"user": {
251+
"id": "823da47e-fc25-48d8-8b5a-6186c760f0df",
252+
"displayName": "System Administrator"
253+
}
254+
},
255+
"lastModifiedDateTime": "2024-12-11T05:50:42.6974645Z",
256+
"createdBy": {
257+
"user": {
258+
"id": "823da47e-fc25-48d8-8b5a-6186c760f0df",
259+
"displayName": "System Administrator"
260+
}
261+
},
262+
"parameters": {
263+
"FQDN": "contoso.onmicrosoft.com",
264+
"TenantId": "2fcf1c68-b412-4c85-bfb2-cb20152a6843"
265+
}
266+
}
267+
]
268+
}
269+
```

‎api-reference/beta/api/configurationmanagement-list-configurationsnapshotjobs.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,88 @@ Content-Type: application/json
159159
]
160160
}
161161
```
162+
163+
### Example 2: Error response for failed snapshot jobs
164+
165+
The following example shows an error response when snapshot jobs encounter failures during execution.
166+
167+
#### Request
168+
169+
The following example shows a request.
170+
<!-- {
171+
"blockType": "request",
172+
"name": "list_configurationsnapshotjob_error"
173+
}-->
174+
``` http
175+
GET https://graph.microsoft.com/beta/admin/configurationManagement/configurationSnapshotJobs
176+
```
177+
178+
#### Response
179+
180+
The following example shows the response.
181+
<!-- {
182+
"blockType": "response",
183+
"truncated": false,
184+
"@odata.type": "Collection(microsoft.graph.configurationSnapshotJob)"
185+
}-->
186+
``` http
187+
HTTP/1.1 200 OK
188+
Content-Type: application/json
189+
190+
{
191+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/configurationManagement/configurationSnapshotJobs",
192+
"@microsoft.graph.tips": "This request only returns a subset of the resource's properties. Your app will need to use $select to return non-default properties. To find out what other properties are available for this resource see https://learn.microsoft.com/graph/api/resources/configurationSnapshotJob",
193+
"value": [
194+
{
195+
"@odata.type": "#microsoft.graph.configurationSnapshotJob",
196+
"id": "f2a8c9d1-4e5f-4b3a-9c8d-1e2f3a4b5c6d",
197+
"displayName": "Failed Snapshot",
198+
"description": "Snapshot that failed due to authentication issues",
199+
"tenantId": "2fcf1c68-b412-4c85-bfb2-cb20152a6843",
200+
"status": "failed",
201+
"resources": [
202+
"microsoft.exchange.sharedmailbox",
203+
"microsoft.exchange.transportrule"
204+
],
205+
"createdDateTime": "2025-02-18T15:33:51.9823159Z",
206+
"completedDateTime": "2025-02-18T15:35:12.4561234Z",
207+
"resourceLocation": "",
208+
"errorDetails": [
209+
"Authentication failed: Unable to authenticate with the Microsoft Exchange service.",
210+
"Resource access denied: Insufficient permissions to access transport rules."
211+
],
212+
"createdBy": {
213+
"user": {
214+
"id": "98ceffcc-7c54-4227-8844-835af5a023ce",
215+
"displayName": "Test Contoso User"
216+
}
217+
}
218+
},
219+
{
220+
"@odata.type": "#microsoft.graph.configurationSnapshotJob",
221+
"id": "a3b4c5d6-7e8f-9a0b-1c2d-3e4f5a6b7c8d",
222+
"displayName": "Partially Successful Snapshot",
223+
"description": "Snapshot with partial success",
224+
"tenantId": "2fcf1c68-b412-4c85-bfb2-cb20152a6843",
225+
"status": "partiallySuccessful",
226+
"resources": [
227+
"microsoft.exchange.sharedmailbox",
228+
"microsoft.exchange.accepteddomain",
229+
"microsoft.exchange.transportrule"
230+
],
231+
"createdDateTime": "2025-02-18T16:00:00.0000000Z",
232+
"completedDateTime": "2025-02-18T16:05:30.1234567Z",
233+
"resourceLocation": "https://storage.example.com/snapshots/a3b4c5d6",
234+
"errorDetails": [
235+
"Warning: Some transport rules could not be exported due to configuration restrictions."
236+
],
237+
"createdBy": {
238+
"user": {
239+
"id": "98ceffcc-7c54-4227-8844-835af5a023ce",
240+
"displayName": "Test Contoso User"
241+
}
242+
}
243+
}
244+
]
245+
}
246+
```

‎api-reference/beta/api/configurationmanagement-list-configurationsnapshots.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
title: "List configurationSnapshots"
3+
description: "Get a list of the configurationBaseline objects that represent configuration snapshots."
4+
author: "swatyario"
5+
ms.date: 01/19/2026
6+
ms.localizationpriority: medium
7+
ms.subservice: "tenant-administration"
8+
doc_type: apiPageType
9+
---
10+
11+
# List configurationSnapshots
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Get a list of [configurationBaseline](../resources/configurationbaseline.md) objects that represent configuration snapshots and their properties.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- { "blockType": "permissions", "name": "configurationmanagement_list_configurationsnapshots" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/configurationmanagement-list-configurationsnapshots-permissions.md)]
25+
26+
## HTTP request
27+
28+
<!-- {
29+
"blockType": "ignored"
30+
}
31+
-->
32+
``` http
33+
GET /admin/configurationManagement/configurationSnapshots
34+
```
35+
36+
## Optional query parameters
37+
38+
This method supports the `$select`, `$filter`, `$orderBy`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
39+
40+
## Request headers
41+
42+
|Name|Description|
43+
|:---|:---|
44+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
45+
46+
## Request body
47+
48+
Don't supply a request body for this method.
49+
50+
## Response
51+
52+
If successful, this method returns a `200 OK` response code and a collection of [configurationBaseline](../resources/configurationbaseline.md) objects in the response body.
53+
54+
## Examples
55+
56+
### Request
57+
58+
The following example shows a request.
59+
<!-- {
60+
"blockType": "request",
61+
"name": "list_configurationsnapshots"
62+
}
63+
-->
64+
``` http
65+
GET https://graph.microsoft.com/beta/admin/configurationManagement/configurationSnapshots
66+
```
67+
68+
### Response
69+
70+
The following example shows the response.
71+
>**Note:** The response object shown here might be shortened for readability.
72+
<!-- {
73+
"blockType": "response",
74+
"truncated": true,
75+
"@odata.type": "Collection(microsoft.graph.configurationBaseline)"
76+
}
77+
-->
78+
``` http
79+
HTTP/1.1 200 OK
80+
Content-Type: application/json
81+
82+
{
83+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/configurationManagement/configurationSnapshots",
84+
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET admin/configurationManagement/configurationSnapshots?$select=description,displayName",
85+
"value": [
86+
{
87+
"id": "5b15be20-897f-4b79-85a6-97871c708f6f",
88+
"displayName": "Demo Baseline",
89+
"description": "This is a baseline with SharedMailbox, AcceptedDomain and MailContact",
90+
"parameters": [],
91+
"resources": [
92+
{
93+
"displayName": "TestSharedMailbox Resource",
94+
"resourceType": "microsoft.exchange.sharedmailbox",
95+
"properties": {
96+
"DisplayName": "TestSharedMailbox",
97+
"Alias": "testSharedMailbox",
98+
"Identity": "TestSharedMailbox",
99+
"Ensure": "Present"
100+
}
101+
},
102+
{
103+
"displayName": "Accepted Domain",
104+
"resourceType": "microsoft.exchange.accepteddomain",
105+
"properties": {
106+
"Identity": "contoso.onmicrosoft.com",
107+
"DomainType": "InternalRelay",
108+
"Ensure": "Present"
109+
}
110+
}
111+
]
112+
}
113+
]
114+
}
115+
```

‎api-reference/beta/includes/permissions/configurationmanagement-list-configurationsnapshots-permissions.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|ConfigurationMonitoring.Read.All|ConfigurationMonitoring.ReadWrite.All|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|ConfigurationMonitoring.Read.All|ConfigurationMonitoring.ReadWrite.All|
12+

‎api-reference/beta/resources/configurationbaseline.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Inherits from [entity](../resources/entity.md).
2121
## Methods
2222
|Method|Return type|Description|
2323
|:---|:---|:---|
24+
|[List](../api/configurationmanagement-list-configurationsnapshots.md)|[configurationBaseline](../resources/configurationbaseline.md) collection|Get a list of [configurationBaseline](../resources/configurationbaseline.md) objects that represent configuration snapshots.|
2425
|[Get](../api/configurationbaseline-get.md)|[configurationBaseline](../resources/configurationbaseline.md)|Read the properties and relationships of a [configurationBaseline](../resources/configurationbaseline.md) object that is attached to a specific monitor.|
2526
|[Create snapshot](../api/configurationbaseline-createsnapshot.md)|[configurationSnapshotJob](../resources/configurationsnapshotjob.md)|Create a [configurationSnapshotJob](../resources/configurationsnapshotjob.md) asynchronously.|
2627

‎api-reference/beta/resources/configurationdrift.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ Inherits from [entity](../resources/entity.md).
2727
## Properties
2828
|Property|Type|Description|
2929
|:---|:---|:---|
30-
|baselineResourceDisplayName|String|Resource instance for which the drift is detected.|
31-
|driftedProperties|[driftedProperty](../resources/driftedproperty.md) collection|Properties within one or more resource instances in which drift is detected.|
32-
|firstReportedDateTime|DateTimeOffset|The date and time at which drift is first detected. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
33-
|id|String|Globally unique identifier (GUID) of the drift. System-generated. Inherited from [entity](../resources/entity.md).|
34-
|monitorId|String|Globally unique identifier (GUID) of the monitor. System-generated.|
35-
|resourceInstanceIdentifier|[openComplexDictionaryType](../resources/opencomplexdictionarytype.md)|An identifier that allows users to understand exactly where the drift is.|
36-
|resourceType|String|Resource for which the drift is detected.|
37-
|status|driftStatus|Status of the drift. The possible values are: `active`, `fixed`, `unknownFutureValue`.|
38-
|tenantId|String|Globally unique identifier (GUID) of the tenant for which the monitor runs. Fetched automatically by the system.|
30+
|baselineResourceDisplayName|String|Resource instance for which the drift is detected. <br><br>Supports `$filter` (`eq`, `ne`, `startsWith`) and `$orderby`.|
31+
|driftedProperties|[driftedProperty](../resources/driftedproperty.md) collection|Properties within one or more resource instances in which drift is detected. <br><br>Returned only on `$select`.|
32+
|firstReportedDateTime|DateTimeOffset|The date and time at which drift is first detected. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`) and `$orderby`.|
33+
|id|String|Globally unique identifier (GUID) of the drift. System-generated. Inherited from [entity](../resources/entity.md). <br><br>Supports `$filter` (`eq`, `ne`) and `$orderby`.|
34+
|monitorId|String|Globally unique identifier (GUID) of the monitor. System-generated. <br><br>Supports `$filter` (`eq`, `ne`).|
35+
|resourceInstanceIdentifier|[openComplexDictionaryType](../resources/opencomplexdictionarytype.md)|An identifier that allows users to understand exactly where the drift is. <br><br>Returned only on `$select`.|
36+
|resourceType|String|Resource for which the drift is detected. <br><br>Supports `$filter` (`eq`, `ne`, `startsWith`).|
37+
|status|driftStatus|Status of the drift. The possible values are: `active`, `fixed`, `unknownFutureValue`. <br><br>Supports `$filter` (`eq`, `ne`) and `$orderby`.|
38+
|tenantId|String|Globally unique identifier (GUID) of the tenant for which the monitor runs. Fetched automatically by the system. <br><br>Supports `$filter` (`eq`, `ne`).|
3939

4040
## Relationships
4141
None.

‎api-reference/beta/resources/configurationmonitor.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,24 @@ Inherits from [entity](../resources/entity.md).
3131
## Properties
3232
|Property|Type|Description|
3333
|:---|:---|:---|
34-
|createdBy|[identitySet](../resources/identityset.md)|The user who created the monitor.|
35-
|createdDateTime|DateTimeOffset|The date and time when the monitor was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
36-
|description|String|User-friendly description of the monitor given by the user.|
37-
|displayName|String|User-friendly name given by the user to the monitor.|
38-
|id|String|Globally unique identifier (GUID) for the monitor. System-generated. Inherited from [entity](../resources/entity.md).|
39-
|inactivationReason|String|The reason for the monitor's inactivation.|
40-
|lastModifiedBy|[identitySet](../resources/identityset.md)|The user who last modified the monitor.|
41-
|lastModifiedDateTime|DateTimeOffset|The date and time when the monitor was last modified. If no modifications are made to the monitor, it's the same as **createdDateTime**. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
42-
|mode|monitorMode|Monitor mode in which the monitor runs. The possible values are: `monitorOnly`, `unknownFutureValue`. The default value is `monitorOnly`.|
34+
|createdBy|[identitySet](../resources/identityset.md)|The user who created the monitor. <br><br>Returned only on `$select`. Supports `$filter` (`eq`).|
35+
|createdDateTime|DateTimeOffset|The date and time when the monitor was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`) and `$orderby`.|
36+
|description|String|User-friendly description of the monitor given by the user. <br><br>Supports `$filter` (`eq`, `ne`, `startsWith`) and `$orderby`.|
37+
|displayName|String|User-friendly name given by the user to the monitor. <br><br>Supports `$filter` (`eq`, `ne`, `startsWith`) and `$orderby`.|
38+
|id|String|Globally unique identifier (GUID) for the monitor. System-generated. Inherited from [entity](../resources/entity.md). <br><br>Supports `$filter` (`eq`, `ne`) and `$orderby`.|
39+
|inactivationReason|String|The reason for the monitor's inactivation. <br><br>Returned only on `$select`.|
40+
|lastModifiedBy|[identitySet](../resources/identityset.md)|The user who last modified the monitor. <br><br>Returned only on `$select`. Supports `$filter` (`eq`).|
41+
|lastModifiedDateTime|DateTimeOffset|The date and time when the monitor was last modified. If no modifications are made to the monitor, it's the same as **createdDateTime**. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`) and `$orderby`.|
42+
|mode|monitorMode|Monitor mode in which the monitor runs. The possible values are: `monitorOnly`, `unknownFutureValue`. The default value is `monitorOnly`. <br><br>Supports `$filter` (`eq`, `ne`).|
4343
|monitorRunFrequencyInHours|Int32|Frequency at which the monitor runs. The default frequency is six hours. Regardless of when you create or update a monitor, it gets triggered within the next 6 hours. Currently, monitors are picked up at fixed times: 6 AM, 12 PM, 6 PM, and 12 AM (all in GMT). For example, if you create a monitor at 9 AM, it gets triggered around 12 PM. If you update a monitor at 4 PM, it gets triggered around 6 PM.|
44-
|parameters|[openComplexDictionaryType](../resources/opencomplexdictionarytype.md)|Key-value pairs that contain parameter values which might be used in the baseline.|
45-
|status|monitorStatus|Status of the monitor The possible values are: `active`, `unknownFutureValue`. The default value is `active`.|
46-
|tenantId|String|Globally unique identifier (GUID) of the tenant for which the monitor runs. Fetched automatically by the system.|
44+
|parameters|[openComplexDictionaryType](../resources/opencomplexdictionarytype.md)|Key-value pairs that contain parameter values which might be used in the baseline. <br><br>Returned only on `$select`.|
45+
|status|monitorStatus|Status of the monitor The possible values are: `active`, `unknownFutureValue`. The default value is `active`. <br><br>Supports `$filter` (`eq`, `ne`) and `$orderby`.|
46+
|tenantId|String|Globally unique identifier (GUID) of the tenant for which the monitor runs. Fetched automatically by the system. <br><br>Supports `$filter` (`eq`, `ne`).|
4747

4848
## Relationships
4949
|Relationship|Type|Description|
5050
|:---|:---|:---|
51-
|baseline|[configurationBaseline](../resources/configurationbaseline.md)|A complex object that contains details of at least one resource and one property associated with the resource to be monitored.|
51+
|baseline|[configurationBaseline](../resources/configurationbaseline.md)|A complex object that contains details of at least one resource and one property associated with the resource to be monitored. Supports `$expand`.|
5252

5353
## JSON representation
5454
The following JSON representation shows the resource type.

0 commit comments

Comments
 (0)