Skip to content

Commit 7e1b2f0

Browse files
committed
2 parents eb127ea + 4b6a862 commit 7e1b2f0

202 files changed

Lines changed: 3302 additions & 1603 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.

.github/prompts/review-api-docs.prompt.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,16 @@ Reference the [copilot-instructions.md](.github/copilot-instructions.md) file fo
143143
- Changelog files validation
144144
- Version-specific guidelines (v1.0 vs beta)
145145

146-
---
146+
Reference the [author-api-docs.prompt.md](.github/prompts/author-api-docs.prompt.md) file for quality checklist items related to the different scenarios:
147+
- [Quality checklist](author-api-docs.prompt.md#author-api-docs.prompt.md#quality-checklist-1)
148+
- [Promotion from beta to v1.0](author-api-docs.prompt.md#quality-checklist-for-promotion-scenarios)
149+
- [Deprecation scenarios](author-api-docs.prompt.md#quality-checklist)
150+
- Documentation standards to follow for:
151+
- [General guidelines](author-api-docs.prompt.md#general-guidelines)
152+
- [API method reference files](author-api-docs.prompt.md#api-method-reference-files)
153+
- [Resource reference files](author-api-docs.prompt.md#resource-reference-files)
154+
- [Version-specific guidelines](author-api-docs.prompt.md#version-specific-guidelines)
155+
- [General rules (applies to both resource and API files)](author-api-docs.prompt.md#general-rules-applies-to-both-resource-and-api-files)
147156

148157
## File Type-Specific Review Checklist
149158

api-reference/beta/api/alert-get.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
2-
title: "Get alert"
2+
title: "Get alert (deprecated)"
33
description: "Retrieve the properties and relationships of an alert object"
44
ms.localizationpriority: medium
55
author: "preetikr"
66
ms.subservice: "security"
77
doc_type: apiPageType
88
ms.date: 04/05/2024
9+
ROBOTS: NOINDEX
910
---
1011

11-
# Get alert
12+
# Get alert (deprecated)
1213

1314
Namespace: microsoft.graph
1415

1516
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1617

18+
[!INCLUDE [security-alerts-v1-deprecation](../includes/security-alerts-v1-deprecation.md)]
19+
1720
Retrieve the properties and relationships of an [alert](../resources/alert.md) object.
1821

1922
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]

api-reference/beta/api/alert-list.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
2-
title: "List alerts"
2+
title: "List alerts (deprecated)"
33
description: "Retrieve a list of alert objects."
44
ms.localizationpriority: medium
55
author: "preetikr"
66
ms.subservice: "security"
77
doc_type: apiPageType
88
ms.date: 04/05/2024
9+
ROBOTS: NOINDEX
910
---
1011

11-
# List alerts
12+
# List alerts (deprecated)
1213

1314
Namespace: microsoft.graph
1415

1516
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1617

18+
[!INCLUDE [security-alerts-v1-deprecation](../includes/security-alerts-v1-deprecation.md)]
19+
1720
Retrieve a list of [alert](../resources/alert.md) objects.
1821

1922
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]

api-reference/beta/api/alert-update.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
2-
title: "Update alert"
2+
title: "Update alert (deprecated)"
33
description: "Update an editable alert property within any integrated solution to keep alert status and assignments in sync across solutions."
44
ms.localizationpriority: medium
55
author: "preetikr"
66
ms.subservice: "security"
77
doc_type: apiPageType
88
ms.date: 04/05/2024
9+
ROBOTS: NOINDEX
910
---
1011

11-
# Update alert
12+
# Update alert (deprecated)
1213

1314
Namespace: microsoft.graph
1415

1516
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1617

18+
[!INCLUDE [security-alerts-v1-deprecation](../includes/security-alerts-v1-deprecation.md)]
19+
1720
Update an editable **alert** property within any integrated solution to keep alert status and assignments in sync across solutions. This method updates any solution that has a record of the referenced alert ID.
1821

1922
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
@@ -43,7 +46,7 @@ PATCH /security/alerts/{alert_id}
4346

4447
## Request body
4548

46-
In the request body, supply a JSON representation of the values for relevant fields that should be updated. The body **must** contain the **vendorInformation** property with valid `provider` and `vendor` fields. The following table lists the fields that can be updated for an alert. The values for existing properties that are not included in the request body will not change. For best performance, don't include existing values that haven't changed.
49+
[!INCLUDE [table-intro](../../includes/update-property-table-intro.md)]
4750

4851
| Property | Type |Description|
4952
|:---------------|:--------|:----------|
@@ -128,7 +131,7 @@ Content-type: application/json
128131

129132
#### Response
130133

131-
The following is an example of a successful response.
134+
The following example shows a successful response.
132135
<!-- {
133136
"blockType": "response"
134137
} -->
@@ -202,7 +205,7 @@ Prefer: return=representation
202205

203206
#### Response
204207

205-
The following is an example of the response when the optional `Prefer: return=representation` request header is used.
208+
The following example shows a response when the optional `Prefer: return=representation` request header is used.
206209

207210
>**Note:** The response object shown here might be shortened for readability.
208211
<!-- {

api-reference/beta/api/alert-updatealerts.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
2-
title: "alert: updateAlerts"
2+
title: "alert: updateAlerts (deprecated)"
33
description: "Update multiple alerts in one request instead of multiple requests."
44
ms.localizationpriority: medium
55
author: "preetikr"
66
ms.subservice: "security"
77
doc_type: apiPageType
88
ms.date: 08/13/2024
9+
ROBOTS: NOINDEX
910
---
1011

11-
# alert: updateAlerts
12+
# alert: updateAlerts (deprecated)
1213

1314
Namespace: microsoft.graph
1415

1516
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1617

18+
[!INCLUDE [security-alerts-v1-deprecation](../includes/security-alerts-v1-deprecation.md)]
19+
1720
Update multiple alerts in one request instead of multiple requests.
1821

1922
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]

api-reference/beta/api/authentication-delete-externalauthenticationmethods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2727

2828
## HTTP request
2929

30-
To delete another user's external authentication method:
30+
To delete another user's external MFA:
3131
<!-- { "blockType": "ignored" } -->
3232
```http
3333
DELETE /users/{usersId}/authentication/externalAuthenticationMethods/{externalAuthenticationMethodId}/$ref

api-reference/beta/api/authentication-list-externalauthenticationmethods.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
4545

4646
## HTTP request
4747

48-
To retrieve details of your own external authentication methods:
48+
To retrieve details of your own external MFA:
4949

5050
[!INCLUDE [me-apis-sign-in-note](../includes/me-apis-sign-in-note.md)]
5151

@@ -54,7 +54,7 @@ To retrieve details of your own external authentication methods:
5454
GET /me/authentication/externalAuthenticationMethods
5555
```
5656

57-
To retrieve details of your own or another user's external authentication methods:
57+
To retrieve details of your own or another user's external MFA:
5858

5959
[!INCLUDE [authentication-methods-apis-users-selfservice](../includes/authentication-methods-apis-users-selfservice.md)]
6060

api-reference/beta/api/authentication-post-externalauthenticationmethods.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2929

3030
## HTTP request
3131

32-
Assign an external authentication method to another user. This API doesn't support self-service operations.
32+
Assign an external MFA to another user. This API doesn't support self-service operations.
3333
<!-- { "blockType": "ignored" } -->
3434
```http
3535
POST /users/{usersId}/authentication/externalAuthenticationMethods
@@ -51,7 +51,7 @@ You can specify the following properties when creating an **externalAuthenticati
5151
|Property|Type|Description|
5252
|:---|:---|:---|
5353
|configurationId|String|A unique identifier used to manage and integrate external auth methods within Microsoft Entra ID. Required.|
54-
|displayName|String|Custom name given to the registered external authentication method. Required.|
54+
|displayName|String|Custom name given to the registered external MFA. Required.|
5555

5656

5757

api-reference/beta/api/authorizationpolicy-get.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ Choose the permission or permissions marked as least privileged for this API. Us
2626
<!-- { "blockType": "permissions", "name": "authorizationpolicy_get" } -->
2727
[!INCLUDE [permissions-table](../includes/permissions/authorizationpolicy-get-permissions.md)]
2828

29-
[!INCLUDE [rbac-authorization-policy-apis-read](../includes/rbac-for-apis/rbac-authorization-policy-apis-read.md)]
30-
3129
## HTTP request
3230

3331
<!-- { "blockType": "ignored" } -->

api-reference/beta/api/backuprestoreroot-list-protectionpolicies.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/Prote
144144
}
145145
},
146146
"lastModifiedDateTime": "2015-06-19T12:01:03.45Z",
147+
"offboardRequestedDateTime": "2015-06-20T09:30:00Z",
147148
"retentionSettings": [
148149
{
149150
"interval": "R/PT10M",
@@ -185,6 +186,7 @@ Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/Prote
185186
}
186187
},
187188
"lastModifiedDateTime": "2015-06-19T12:01:03.45Z",
189+
"offboardRequestedDateTime": "2016-01-01T00:00:00Z",
188190
"retentionSettings": [
189191
{
190192
"interval": "R/PT10M",
@@ -226,6 +228,7 @@ Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/Prote
226228
}
227229
},
228230
"lastModifiedDateTime": "2015-06-19T12:01:03.45Z",
231+
"offboardRequestedDateTime": "2024-01-15T10:00:00Z",
229232
"retentionSettings": [
230233
{
231234
"interval": "R/PT10M",

0 commit comments

Comments
 (0)