Skip to content

Commit e9d0a5e

Browse files
authored
Merge branch 'main' into hut/healthMonitoringDocs
2 parents d5c0c83 + 5eecd77 commit e9d0a5e

File tree

549 files changed

+1307
-5383
lines changed

Some content is hidden

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

549 files changed

+1307
-5383
lines changed

api-reference/beta/api/chatmessage-delta.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ In this example, the chat messages synchronize for the first time and the initia
9999

100100
The request specifies the optional `$top` query parameter that returns two messages at a time.
101101

102+
# [HTTP](#tab/http)
102103
<!-- {
103104
"blockType": "request",
104105
"name": "get_chatmessagedeltachats_1"
@@ -107,6 +108,12 @@ The request specifies the optional `$top` query parameter that returns two messa
107108
GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$top=2
108109
```
109110

111+
# [JavaScript](#tab/javascript)
112+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-chatmessagedeltachats-1-javascript-snippets.md)]
113+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
114+
115+
---
116+
110117
#### Initial request response
111118

112119
The response includes two messages and an **@odata.nextLink** response header with a `skipToken`. The **@odata.nextLink** URL indicates that more messages in the chats are available to retrieve.
@@ -206,6 +213,7 @@ Content-type: application/json
206213

207214
The second request specifies the **@odata.nextLink** URL returned from the previous response. Notice that it no longer has to specify the same `$top` parameter as in the initial request, as the `skipToken` in the **@odata.nextLink** URL encodes and includes those parameters.
208215

216+
# [HTTP](#tab/http)
209217
<!-- {
210218
"blockType": "request",
211219
"name": "get_chatmessagedeltachats_2"
@@ -214,6 +222,12 @@ The second request specifies the **@odata.nextLink** URL returned from the previ
214222
GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?&%24skiptoken=a-5fqdzHFr_L_cc7C0q1F-HCB8Z9SjwOsMN37XV5yfSnYgK4jVGVGEl25GFlxKWq0Wv6quL-5qcNg4nUnxzof6namZ_DM5no-hcL515cSrRGDoRLn38fZE1AXoDugSTOohOq3YRCYLqJbFGIoovMPTar32oLuoltHixme-Bf1lZtscv1wv5uu-MtkpYZIT0uDw-umQUK7mLNjMcyhNaifMIVTT-htmEOClLVwgcyWLR-sl9Qb73uTTtPXdFdMK6FDE4gpwvvKxvo2ChsW2c4eo77LDh6ZL_WQ8Luq00koQ6vHIrLBHPMUdOAxDxu-U7N7H4hsFn9aRDRdwRky7067A.V2a-J-86yXTd9SJMA4CHP6enI-Ab-bQzRgYujwsIwDo
215223
```
216224

225+
# [JavaScript](#tab/javascript)
226+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-chatmessagedeltachats-2-javascript-snippets.md)]
227+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
228+
229+
---
230+
217231
#### Second request response
218232

219233
The second response returns the next two messages and an **@odata.nextLink** response header with a `skipToken` that indicates that more messages are available to retrieve.
@@ -313,6 +327,7 @@ Content-type: application/json
313327

314328
The third request continues to use the latest **@odata.nextLink** returned from the last sync request.
315329

330+
# [HTTP](#tab/http)
316331
<!-- {
317332
"blockType": "request",
318333
"name": "get_chatmessagedeltachats_3"
@@ -321,6 +336,12 @@ The third request continues to use the latest **@odata.nextLink** returned from
321336
GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$skiptoken=8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4
322337
```
323338

339+
# [JavaScript](#tab/javascript)
340+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-chatmessagedeltachats-3-javascript-snippets.md)]
341+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
342+
343+
---
344+
324345
#### Third request response
325346

326347
The third response returns the only remaining messages and an **@odata.deltaLink** response header with a `deltaToken` which indicates that all messages are returned. Save and use the **@odata.deltaLink** URL to query for any new messages added or changed from this point onwards.
@@ -387,6 +408,7 @@ Using the **@odata.deltaLink** from the last request in the last round, you can
387408

388409
The following example shows a request.
389410

411+
# [HTTP](#tab/http)
390412
<!-- {
391413
"blockType": "request",
392414
"name": "get_chatmessagedeltachats_4"
@@ -395,6 +417,12 @@ The following example shows a request.
395417
GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$deltatoken=aQdvS1VwGCSRxVmZJqykmDik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4
396418
```
397419

420+
# [JavaScript](#tab/javascript)
421+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-chatmessagedeltachats-4-javascript-snippets.md)]
422+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
423+
424+
---
425+
398426
#### Response
399427

400428
The following example shows the response.

api-reference/beta/api/cloudpc-getprovisionedcloudpcs.md

Lines changed: 79 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Choose the permission or permissions marked as least privileged for this API. Us
3535
GET /deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='{groupId}',servicePlanId='{servicePlanId}')
3636
```
3737

38+
## Optional query parameters
39+
40+
This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. You can use `$select` to get specific properties, including those properties that aren't returned by default.
41+
3842
## Request headers
3943

4044
|Name|Description|
@@ -58,14 +62,18 @@ If successful, this method returns a `200 OK` response code and a collection of
5862

5963
## Examples
6064

61-
### Request
65+
### Example 1: Get all provisioned Cloud PCs and their default properties
66+
67+
The following example shows how to get all provisioned Cloud PCs and their default properties.
68+
69+
#### Request
6270

6371
The following example shows a request.
6472

6573
# [HTTP](#tab/http)
6674
<!-- {
6775
"blockType": "request",
68-
"name": "cloudpc.getProvisionedCloudPCs"
76+
"name": "cloudpc.getProvisionedCloudPCs_1"
6977
}
7078
-->
7179
``` http
@@ -106,14 +114,16 @@ GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/g
106114

107115
---
108116

109-
### Response
117+
#### Response
110118

111-
The following example shows the response.
119+
The following example shows the response. It includes only the default properties.
120+
121+
> **Note:** The response object shown here might be shortened for readability. All the default properties are returned in an actual call.
112122
113123
<!-- {
114124
"blockType": "response",
115125
"@odata.type": "Collection(microsoft.graph.cloudPC)",
116-
"name": "cloudpc.getProvisionedCloudPCs",
126+
"name": "cloudpc.getProvisionedCloudPCs_1",
117127
"truncated": true
118128
}
119129
-->
@@ -138,22 +148,16 @@ Content-Type: application/json
138148
"servicePlanName": "Cloud PC Enterprise 4vCPU/16GB/256GB",
139149
"servicePlanType": "enterprise",
140150
"status": "provisioned",
141-
"powerState": "running",
142151
"userPrincipalName": "pmitchell@contoso.com",
143152
"lastModifiedDateTime": "2020-07-23T10:29:57Z",
144153
"statusDetails": null,
145154
"provisioningType": "dedicated",
146155
"allotmentDisplayName": null,
147156
"deviceRegionName": "eastus2",
148-
"connectivityResult": "",
149157
"gracePeriodEndDateTime": null,
150-
"lastLoginResult": "2020-07-23T10:29:57Z",
151-
"lastRemoteActionResult": "Succeed",
152158
"onPremisesConnectionName": "Test-OPNC",
153-
"osVersion": null,
154159
"partnerAgentInstallResults": null,
155-
"provisioningPolicyName": "Test-Policy",
156-
"userAccountType": null
160+
"provisioningPolicyName": "Test-Policy"
157161
},
158162
{
159163
"@odata.type": "#microsoft.graph.cloudPC",
@@ -169,23 +173,79 @@ Content-Type: application/json
169173
"servicePlanName": "Cloud PC Enterprise 4vCPU/16GB/256GB",
170174
"servicePlanType": "enterprise",
171175
"status": "provisioned",
172-
"powerState": "running",
173176
"userPrincipalName": "pmitchell@contoso.com",
174177
"lastModifiedDateTime": "2020-07-28T18:14:34Z",
175178
"statusDetails": null,
176179
"provisioningType": "dedicated",
177180
"allotmentDisplayName": null,
178181
"deviceRegionName": "eastus2",
179-
"connectivityResult": "",
180182
"gracePeriodEndDateTime": null,
181-
"lastLoginResult": "2020-07-23T10:29:57Z",
182-
"lastRemoteActionResult": "Succeed",
183183
"onPremisesConnectionName": "Test-OPNC",
184-
"osVersion": null,
185184
"partnerAgentInstallResults": null,
186-
"provisioningPolicyName": "Test-Policy",
187-
"userAccountType": null
185+
"provisioningPolicyName": "Test-Policy"
188186
}
189187
]
190188
}
191189
```
190+
191+
### Example 2: Get all provisioned Cloud PCs and specific properties
192+
193+
The following example shows how to get all provisioned Cloud PCs and use `$select` to get specific properties, including those properties that aren't returned by default.
194+
195+
#### Request
196+
197+
The following example shows a request.
198+
199+
<!-- {
200+
"blockType": "request",
201+
"name": "cloudpc.getProvisionedCloudPCs_2"
202+
}
203+
-->
204+
``` http
205+
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='30d0e128-de93-41dc-89ec-33d84bb662a0',servicePlanId='9ecf691d-8b82-46cb-b254-cd061b2c02fb')?$select=id,displayName,powerState,connectivityResult,lastLoginResult,lastRemoteActionResult,osVersion,provisioningPolicyName,userAccountType
206+
```
207+
208+
#### Response
209+
210+
The following example shows the response.
211+
212+
<!-- {
213+
"blockType": "response",
214+
"@odata.type": "Collection(microsoft.graph.cloudPC)",
215+
"name": "cloudpc.getProvisionedCloudPCs_2",
216+
"truncated": true
217+
}
218+
-->
219+
``` http
220+
HTTP/1.1 200 OK
221+
Content-Type: application/json
222+
223+
{
224+
"value": [
225+
{
226+
"@odata.type": "#microsoft.graph.cloudPC",
227+
"id": "662009bc-7732-4f6f-8726-25883518b33e",
228+
"displayName": "Demo-0",
229+
"powerState": "running",
230+
"connectivityResult": "",
231+
"lastLoginResult": "2020-07-23T10:29:57Z",
232+
"lastRemoteActionResult": "Succeed",
233+
"osVersion": null,
234+
"provisioningPolicyName": "Test-Policy",
235+
"userAccountType": null
236+
},
237+
{
238+
"@odata.type": "#microsoft.graph.cloudPC",
239+
"id": "ac74ae8b-85f7-4272-88cc-5419267403ed",
240+
"displayName": "Demo-1",
241+
"powerState": "running",
242+
"connectivityResult": "",
243+
"lastLoginResult": "2020-07-23T10:29:57Z",
244+
"lastRemoteActionResult": "Succeed",
245+
"osVersion": null,
246+
"provisioningPolicyName": "Test-Policy",
247+
"userAccountType": null
248+
}
249+
]
250+
}
251+
```

api-reference/beta/api/educationalactivity-delete.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Delete an [educationalActivity](../resources/educationalactivity.md) object from
1919

2020
## Permissions
2121

22-
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+
The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged 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).
2323

2424
Permissions for the following HTTP syntax:
2525

@@ -29,12 +29,12 @@ Permissions for the following HTTP syntax:
2929
DELETE /me/profile/educationalActivities/{id}
3030
```
3131

32-
<!-- { "blockType": "permissions", "name": "educationalactivity_delete", "requestUrls": ["DELETE /me/profile/educationalActivities/{id}"]} -->
33-
|Permission type|Least privileged permissions|Higher privileged permissions|
34-
|:---|:---|:---|
35-
|Delegated (work or school account)|User.ReadWrite|User.ReadWrite.All|
36-
|Delegated (personal Microsoft account)|User.ReadWrite|Not available.|
37-
|Application|Not supported.|Not supported.|
32+
<!-- {
33+
"blockType": "permissions",
34+
"name": "educationalactivity_delete",
35+
"requestUrls": ["DELETE /me/profile/educationalActivities/{id}"]
36+
} -->
37+
[!INCLUDE [permissions-table](../includes/permissions/educationalactivity-delete-permissions.md)]
3838

3939
Permissions for the following HTTP syntax:
4040

@@ -44,12 +44,12 @@ Permissions for the following HTTP syntax:
4444
DELETE /users/{id | userPrincipalName}/profile/educationalActivities/{id}
4545
```
4646

47-
<!-- { "blockType": "permissions", "name": "educationalactivity_delete", "requestUrls": ["DELETE /users/{id | userPrincipalName}/profile/educationalActivities/{id}"]} -->
48-
|Permission type|Least privileged permissions|Higher privileged permissions|
49-
|:---|:---|:---|
50-
|Delegated (work or school account)|User.ReadWrite|User.ReadWrite.All|
51-
|Delegated (personal Microsoft account)|User.ReadWrite|Not available.|
52-
|Application|User.ReadWrite.All|Not available.|
47+
<!-- {
48+
"blockType": "permissions",
49+
"name": "educationalactivity_delete_2",
50+
"requestUrls": ["DELETE /users/{id | userPrincipalName}/profile/educationalActivities/{id}"]
51+
} -->
52+
[!INCLUDE [permissions-table](../includes/permissions/educationalactivity-delete-2-permissions.md)]
5353

5454
## HTTP request
5555

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Retrieve the properties and relationships of an [educationalActivity](../resourc
1919

2020
## Permissions
2121

22-
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+
The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged 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).
2323

2424
Permissions for the following HTTP syntax:
2525

@@ -29,12 +29,12 @@ Permissions for the following HTTP syntax:
2929
GET /me/profile/educationalActivities/{id}
3030
```
3131

32-
<!-- { "blockType": "permissions", "name": "educationalactivity_get", "requestUrls": ["GET /me/profile/educationalActivities/{id}"]} -->
33-
|Permission type|Least privileged permissions|Higher privileged permissions|
34-
|:---|:---|:---|
35-
|Delegated (work or school account)|User.Read|User.ReadWrite, User.Read.All, User.ReadBasic.All, User.ReadWrite.All|
36-
|Delegated (personal Microsoft account)|User.Read|User.ReadWrite|
37-
|Application|Not supported.|Not supported.|
32+
<!-- {
33+
"blockType": "permissions",
34+
"name": "educationalactivity_get",
35+
"requestUrls": ["GET /me/profile/educationalActivities/{id}"]
36+
} -->
37+
[!INCLUDE [permissions-table](../includes/permissions/educationalactivity-get-permissions.md)]
3838

3939
Permissions for the following HTTP syntax:
4040

@@ -44,12 +44,12 @@ Permissions for the following HTTP syntax:
4444
GET /users/{id | userPrincipalName}/profile/educationalActivities/{id}
4545
```
4646

47-
<!-- { "blockType": "permissions", "name": "educationalactivity_get", "requestUrls": ["GET /users/{id | userPrincipalName}/profile/educationalActivities/{id}"]} -->
48-
|Permission type|Least privileged permissions|Higher privileged permissions|
49-
|:---|:---|:---|
50-
|Delegated (work or school account)|User.Read|User.ReadWrite, User.Read.All, User.ReadBasic.All, User.ReadWrite.All|
51-
|Delegated (personal Microsoft account)|User.Read|User.ReadWrite|
52-
|Application|User.Read.All|User.ReadWrite.All|
47+
<!-- {
48+
"blockType": "permissions",
49+
"name": "educationalactivity_get_2",
50+
"requestUrls": ["GET /users/{id | userPrincipalName}/profile/educationalActivities/{id}"]
51+
} -->
52+
[!INCLUDE [permissions-table](../includes/permissions/educationalactivity-get-2-permissions.md)]
5353

5454
## HTTP request
5555

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Update the properties of an [educationalActivity](../resources/educationalactivi
1919

2020
## Permissions
2121

22-
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+
The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged 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).
2323

2424
Permissions for the following HTTP syntax:
2525

@@ -29,12 +29,12 @@ Permissions for the following HTTP syntax:
2929
PATCH /me/profile/educationalActivities/{id}
3030
```
3131

32-
<!-- { "blockType": "permissions", "name": "educationalactivity_update", "requestUrls": ["PATCH /me/profile/educationalActivities/{id}"]} -->
33-
|Permission type|Least privileged permissions|Higher privileged permissions|
34-
|:---|:---|:---|
35-
|Delegated (work or school account)|User.ReadWrite|User.ReadWrite.All|
36-
|Delegated (personal Microsoft account)|User.ReadWrite|Not avaialable.|
37-
|Application|Not supported.|Not supported.|
32+
<!-- {
33+
"blockType": "permissions",
34+
"name": "educationalactivity_update",
35+
"requestUrls": ["PATCH /me/profile/educationalActivities/{id}"]
36+
} -->
37+
[!INCLUDE [permissions-table](../includes/permissions/educationalactivity-update-permissions.md)]
3838

3939
Permissions for the following HTTP syntax:
4040

@@ -44,12 +44,12 @@ Permissions for the following HTTP syntax:
4444
PATCH /users/{id | userPrincipalName}/profile/educationalActivities/{id}
4545
```
4646

47-
<!-- { "blockType": "permissions", "name": "educationalactivity_update", "requestUrls": ["PATCH /users/{id | userPrincipalName}/profile/educationalActivities/{id}"]} -->
48-
|Permission type|Least privileged permissions|Higher privileged permissions|
49-
|:---|:---|:---|
50-
|Delegated (work or school account)|User.ReadWrite|User.ReadWrite.All|
51-
|Delegated (personal Microsoft account)|User.ReadWrite|Not avaialable.|
52-
|Application|User.ReadWrite.All|Not available.|
47+
<!-- {
48+
"blockType": "permissions",
49+
"name": "educationalactivity_update_2",
50+
"requestUrls": ["PATCH /users/{id | userPrincipalName}/profile/educationalActivities/{id}"]
51+
} -->
52+
[!INCLUDE [permissions-table](../includes/permissions/educationalactivity-update-2-permissions.md)]
5353

5454
## HTTP request
5555

api-reference/beta/api/filestoragecontainer-list-columns.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0
9797

9898
---
9999

100-
101100
### Response
102101

103102
The following example shows the response.

0 commit comments

Comments
 (0)