Skip to content

Commit 199e2f4

Browse files
authored
Merge branch 'main' into notes-api-beta-docs
2 parents 8b70c2d + ae67e70 commit 199e2f4

234 files changed

Lines changed: 6128 additions & 894 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/author-api-docs/common.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,21 @@ After updating the changelog, update the What's new section in `concepts/whats-n
219219
- For **v1.0** documentation: Do NOT append any query string parameters
220220
- Example format: `Added the [resourceName](/graph/api/resources/resourcename) resource to manage XYZ.`
221221

222+
**Authoring principles for What's New entries:**
223+
224+
- **Lead with the doc action verb.** Start with "Added", "Updated", or "Changed" to signal what was documented. For new resources, use `Added the [resource](/path) resource type and related methods for...`. For new properties or relationships on an existing resource, use `Added the **propertyName** relationship to the [resource](/path) resource.` For new enum members, use `Added the \`memberName\` member to the [enumName](/path) enumeration...` and describe the capability it enables.
225+
- **Describe the capability, not the objects.** Say what users can now *do*. Do not enumerate properties, methods, complex types, or enumerations — those are discoverable from the linked pages.
226+
- **Do not say "new"** — the section context implies it. Do not qualify with the API version — the section structure (v1.0 vs. beta) already communicates this.
227+
- **Link only to the root entry point** — the entity type, function, or property that triggers the capability. If the change introduces an entity type, everything else (properties, methods, complex types) depends on it and doesn't need separate mention. If the change is a function or property addition, link to that and its parent resource.
228+
- **Keep entries to 1–4 sentences.**
229+
230+
| Scenario | ❌ Avoid | ✅ Correct |
231+
|----------|----------|-----------|
232+
| New entity type with operations | List the resource, each method, and every complex type separately. | `Added the [driveItem](/graph/api/resources/driveitem) resource type and related methods for managing drive items. Use it to list, get, create, update, and delete files and folders.` |
233+
| New function + property addition | List the function, the property, and all supporting complex types. | `Added support for programmatic FIDO2 passkey registration. Use the [creationOptions](/graph/api/fido2authenticationmethod-creationoptions) function to get WebAuthn credential creation options, then complete registration by posting the **publicKeyCredential** property to the [fido2AuthenticationMethod](/graph/api/resources/fido2authenticationmethod) resource.` |
234+
| New property or relationship on existing resource | Name all new properties individually. | `Added the **inheritedAppRoleAssignments** and **inheritedOauth2PermissionGrants** relationships to the [agentIdentity](/graph/api/resources/agentidentity) resource. Use these to retrieve the permissions an agent identity inherits from its parent blueprint service principal.` |
235+
| New enum member | List only the enum type without explaining the capability, where possible. | `Added \`targetAgentIdentitySponsorOrOwner\` to the filter options for [access package assignments](/graph/api/accesspackageassignment-filterbycurrentuser), enabling sponsors and owners of agent identities to view access package activity for the agent identities they manage.` |
236+
222237
### Updating the Table of Contents (TOC)
223238

224239
After updating What's new, update the appropriate TOC mapping file to make new documentation discoverable:

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ If successful, this method returns a `200 OK` response code and a [approvedClien
5858

5959
### Request
6060
The following example shows a request.
61+
# [HTTP](#tab/http)
6162
<!-- {
6263
"blockType": "request",
6364
"name": "get_approvedclientapp"
@@ -67,6 +68,36 @@ The following example shows a request.
6768
GET https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration/approvedClientApps/cd57c330-a543-4249-9486-c1c257341de6
6869
```
6970

71+
# [C#](#tab/csharp)
72+
[!INCLUDE [sample-code](../includes/snippets/csharp/get-approvedclientapp-csharp-snippets.md)]
73+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
74+
75+
# [Go](#tab/go)
76+
[!INCLUDE [sample-code](../includes/snippets/go/get-approvedclientapp-go-snippets.md)]
77+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
78+
79+
# [Java](#tab/java)
80+
[!INCLUDE [sample-code](../includes/snippets/java/get-approvedclientapp-java-snippets.md)]
81+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
82+
83+
# [JavaScript](#tab/javascript)
84+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-approvedclientapp-javascript-snippets.md)]
85+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
86+
87+
# [PHP](#tab/php)
88+
[!INCLUDE [sample-code](../includes/snippets/php/get-approvedclientapp-php-snippets.md)]
89+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
90+
91+
# [PowerShell](#tab/powershell)
92+
[!INCLUDE [sample-code](../includes/snippets/powershell/get-approvedclientapp-powershell-snippets.md)]
93+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
94+
95+
# [Python](#tab/python)
96+
[!INCLUDE [sample-code](../includes/snippets/python/get-approvedclientapp-python-snippets.md)]
97+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
98+
99+
---
100+
70101
### Response
71102
The following example shows the response.
72103
>**Note:** The response object shown here might be shortened for readability.

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ If successful, this method returns a `200 OK` response code and an [azureADPremi
6868
### Request
6969

7070
The following example shows a request.
71+
# [HTTP](#tab/http)
7172
<!-- {
7273
"blockType": "request",
7374
"name": "get_azureadpremiumlicenseinsight"
@@ -77,6 +78,32 @@ The following example shows a request.
7778
GET https://graph.microsoft.com/beta/reports/azureADPremiumLicenseInsight
7879
```
7980

81+
# [C#](#tab/csharp)
82+
[!INCLUDE [sample-code](../includes/snippets/csharp/get-azureadpremiumlicenseinsight-csharp-snippets.md)]
83+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
84+
85+
# [Go](#tab/go)
86+
[!INCLUDE [sample-code](../includes/snippets/go/get-azureadpremiumlicenseinsight-go-snippets.md)]
87+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
88+
89+
# [Java](#tab/java)
90+
[!INCLUDE [sample-code](../includes/snippets/java/get-azureadpremiumlicenseinsight-java-snippets.md)]
91+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
92+
93+
# [JavaScript](#tab/javascript)
94+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-azureadpremiumlicenseinsight-javascript-snippets.md)]
95+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
96+
97+
# [PHP](#tab/php)
98+
[!INCLUDE [sample-code](../includes/snippets/php/get-azureadpremiumlicenseinsight-php-snippets.md)]
99+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
100+
101+
# [Python](#tab/python)
102+
[!INCLUDE [sample-code](../includes/snippets/python/get-azureadpremiumlicenseinsight-python-snippets.md)]
103+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
104+
105+
---
106+
80107

81108
### Response
82109

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ Don't supply a request body for this method.
6161

6262
## Response
6363

64-
If successful, this method returns a `200 OK` response code and collection of [Channel](../resources/channel.md) objects in the response body.
64+
If successful, this method returns a `200 OK` response code and a collection of [channel](../resources/channel.md) objects in the response body.
65+
66+
When the result set spans multiple pages, the response includes an **@odata.nextLink** property with a URL for retrieving the next page of results. For details about how to page through results, see [Paging Microsoft Graph data in your app](/graph/paging).
6567

6668
## Examples
6769

@@ -145,7 +147,7 @@ Content-type: application/json
145147
```
146148

147149
> [!NOTE]
148-
> This API has a [known issue](https://microsoftgraph.visualstudio.com/Known%20Issues/_workitems/edit/40502/) related to listing channels. The **layoutType** property returns `null` when listing channels. To get the layout type of a specific channel, use the [Get channel](../api/channel-get.md) API. Full support for **layoutType** in list operations is planned for a future release.
150+
> This API has a [known issue](/graph/known-issues#layouttype-property-returns-null-when-listing-all-channels) related to listing channels. The **layoutType** property returns `null` when listing channels. To get the layout type of a specific channel, use the [Get channel](../api/channel-get.md) API.
149151
150152
### Example 2: List all private channels
151153

api-reference/beta/api/channel-patch.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,13 @@ HTTP/1.1 204 No Content
165165
}
166166
-->
167167

168-
### Example 4: Update a channel's layout type
168+
### Example 4: Update the layout type of a channel
169169

170-
This example shows how to update an existing channel's layout type from post to chat.
170+
The following example shows how to update the existing layout type of a channel from post to chat.
171171

172172
#### Request
173173

174-
The following example shows a request to change a channel's layout from the traditional post-reply format to a chat-like threading experience.
174+
The following example shows a request to change the layout of a channel from the traditional post-reply format to a chat-like threading experience.
175175

176176
# [HTTP](#tab/http)
177177
<!-- {
@@ -232,10 +232,10 @@ HTTP/1.1 204 No Content
232232

233233
### Example 5: Switch a channel back to post layout type
234234

235-
This example shows how to convert a chat-layout channel back to the traditional post-reply format.
235+
The following example shows how to convert a chat-layout channel back to the traditional post-reply format.
236236

237237
#### Request
238-
238+
The following example shows a request.
239239
# [HTTP](#tab/http)
240240
<!-- {
241241
"blockType": "request",

api-reference/beta/api/channel-post.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,11 +241,11 @@ Content-type: application/json
241241

242242
### Example 3: Create a channel with chat layout type
243243

244-
This example shows how to create a channel with the chat layout type, which provides a chat-like threading experience similar to group chats.
244+
The following example shows how to create a channel with the chat layout type that provides a chat-like threading experience similar to group chats.
245245

246246
#### Request
247247

248-
The following example shows a request to create a channel with `layoutType` set to `chat`.
248+
The following example shows a request to create a channel with **layoutType** set to `chat`.
249249

250250
# [HTTP](#tab/http)
251251
<!-- {
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: "workflow: cancelProcessing"
3+
description: "Cancel workflow runs that are currently in progress or queued."
4+
author: "KristinaSmith"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-id-governance"
7+
doc_type: apiPageType
8+
ms.date: 03/26/2026
9+
---
10+
11+
# workflow: cancelProcessing
12+
13+
Namespace: microsoft.graph.identityGovernance
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Cancel one or more [workflow](../resources/identitygovernance-workflow.md) runs that are currently in `queued` or `inProgress` status. Currently limited to canceling one run per request.
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": "identitygovernance_workflow_cancelprocessing" } -->
24+
25+
[!INCLUDE [permissions-table](../includes/permissions/identitygovernance-workflow-cancelprocessing-permissions.md)]
26+
27+
[!INCLUDE [rbac-lifecycle-workflows-apis-write](../includes/rbac-for-apis/rbac-lifecycle-workflows-apis-write.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
```http
36+
POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/cancelProcessing
37+
```
38+
39+
## Request headers
40+
41+
|Name|Description|
42+
|:---|:---|
43+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
44+
|Content-Type|application/json. Required.|
45+
46+
## Request body
47+
48+
In the request body, supply a JSON representation of the parameters.
49+
50+
The following table shows the parameters that are required with this action.
51+
52+
|Parameter|Type|Description|
53+
|:---|:---|:---|
54+
|scope|[microsoft.graph.identityGovernance.cancelScope](../resources/identitygovernance-cancelscope.md)|Defines the scope of workflow runs to cancel. Currently only [cancelRunsScope](../resources/identitygovernance-cancelrunsscope.md) is supported. Required.|
55+
56+
### cancelRunsScope properties
57+
58+
When using [cancelRunsScope](../resources/identitygovernance-cancelrunsscope.md), the `@odata.type` property is required in the request body.
59+
60+
|Property|Type|Description|
61+
|:---|:---|:---|
62+
|@odata.type|String|Must be `#microsoft.graph.identityGovernance.cancelRunsScope`. Required.|
63+
|runs|[microsoft.graph.identityGovernance.run](../resources/identitygovernance-run.md) collection|The workflow runs to cancel. Currently limited to one run per request. Required.|
64+
65+
## Response
66+
67+
If successful, this action returns a `204 No Content` response code.
68+
69+
## Examples
70+
71+
### Example 1: Successfully cancel a workflow run
72+
73+
The following example shows a request that successfully cancels a single workflow run.
74+
75+
#### Request
76+
77+
The following example shows a request.
78+
79+
<!-- {
80+
"blockType": "request",
81+
"name": "lifecycleworkflows_workflow_cancelprocessing_success"
82+
}
83+
-->
84+
```http
85+
POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/cancelProcessing
86+
Content-Type: application/json
87+
88+
{
89+
"scope": {
90+
"@odata.type": "#microsoft.graph.identityGovernance.cancelRunsScope",
91+
"runs": [
92+
{
93+
"id": "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"
94+
}
95+
]
96+
}
97+
}
98+
```
99+
100+
---
101+
102+
#### Response
103+
104+
The following example shows the response.
105+
106+
<!-- {
107+
"blockType": "response",
108+
"truncated": true
109+
} -->
110+
```http
111+
HTTP/1.1 204 No Content
112+
```

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,43 @@ This method doesn't support [OData query parameters](/graph/query-parameters) to
4747
### Request
4848

4949

50+
# [HTTP](#tab/http)
5051
<!-- { "blockType": "request", "name": "list-activities" } -->
5152

5253
```msgraph-interactive
5354
GET https://graph.microsoft.com/beta/me/drive/activities
5455
```
5556

57+
# [C#](#tab/csharp)
58+
[!INCLUDE [sample-code](../includes/snippets/csharp/list-activities-csharp-snippets.md)]
59+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
60+
61+
# [Go](#tab/go)
62+
[!INCLUDE [sample-code](../includes/snippets/go/list-activities-go-snippets.md)]
63+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
64+
65+
# [Java](#tab/java)
66+
[!INCLUDE [sample-code](../includes/snippets/java/list-activities-java-snippets.md)]
67+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
68+
69+
# [JavaScript](#tab/javascript)
70+
[!INCLUDE [sample-code](../includes/snippets/javascript/list-activities-javascript-snippets.md)]
71+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
72+
73+
# [PHP](#tab/php)
74+
[!INCLUDE [sample-code](../includes/snippets/php/list-activities-php-snippets.md)]
75+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
76+
77+
# [PowerShell](#tab/powershell)
78+
[!INCLUDE [sample-code](../includes/snippets/powershell/list-activities-powershell-snippets.md)]
79+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
80+
81+
# [Python](#tab/python)
82+
[!INCLUDE [sample-code](../includes/snippets/python/list-activities-python-snippets.md)]
83+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
84+
85+
---
86+
5687
### Response
5788

5889
<!-- { "blockType": "response", "@type": "Collection(microsoft.graph.itemActivity)", "truncated": true } -->

api-reference/beta/api/remotedesktopsecurityconfiguration-delete-approvedclientapps.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ If successful, this method returns a `204 No Content` response code.
5454

5555
### Request
5656
The following example shows a request.
57+
# [HTTP](#tab/http)
5758
<!-- {
5859
"blockType": "request",
5960
"name": "delete_approvedclientapp"
@@ -63,6 +64,36 @@ The following example shows a request.
6364
DELETE https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration/approvedClientApps/cd57c330-a543-4249-9486-c1c257341de6
6465
```
6566

67+
# [C#](#tab/csharp)
68+
[!INCLUDE [sample-code](../includes/snippets/csharp/delete-approvedclientapp-csharp-snippets.md)]
69+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
70+
71+
# [Go](#tab/go)
72+
[!INCLUDE [sample-code](../includes/snippets/go/delete-approvedclientapp-go-snippets.md)]
73+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
74+
75+
# [Java](#tab/java)
76+
[!INCLUDE [sample-code](../includes/snippets/java/delete-approvedclientapp-java-snippets.md)]
77+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
78+
79+
# [JavaScript](#tab/javascript)
80+
[!INCLUDE [sample-code](../includes/snippets/javascript/delete-approvedclientapp-javascript-snippets.md)]
81+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
82+
83+
# [PHP](#tab/php)
84+
[!INCLUDE [sample-code](../includes/snippets/php/delete-approvedclientapp-php-snippets.md)]
85+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
86+
87+
# [PowerShell](#tab/powershell)
88+
[!INCLUDE [sample-code](../includes/snippets/powershell/delete-approvedclientapp-powershell-snippets.md)]
89+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
90+
91+
# [Python](#tab/python)
92+
[!INCLUDE [sample-code](../includes/snippets/python/delete-approvedclientapp-python-snippets.md)]
93+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
94+
95+
---
96+
6697
### Response
6798
The following example shows the response.
6899
<!-- {

api-reference/beta/api/remotedesktopsecurityconfiguration-delete-targetdevicegroups.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ If successful, this method returns a `204 No Content` response code.
5555
### Request
5656
The following example shows a request.
5757

58+
# [HTTP](#tab/http)
5859
<!-- {
5960
"blockType": "request",
6061
"name": "delete_targetdevicegroup"
@@ -64,6 +65,12 @@ The following example shows a request.
6465
DELETE https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration/targetDeviceGroups/1a9db3ab-0acf-4808-99ae-e8ed581cb2e0/$ref
6566
```
6667

68+
# [JavaScript](#tab/javascript)
69+
[!INCLUDE [sample-code](../includes/snippets/javascript/delete-targetdevicegroup-javascript-snippets.md)]
70+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
71+
72+
---
73+
6774
### Response
6875
The following example shows the response.
6976
<!-- {

0 commit comments

Comments
 (0)