Skip to content

Commit 31bb985

Browse files
authored
Merge pull request #28100 from microsoftgraph/main
Merge to publish.
2 parents 4d40343 + 2038879 commit 31bb985

104 files changed

Lines changed: 3455 additions & 375 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/cloudpcdeviceimage-getsourceimages.md

Lines changed: 69 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Choose the permission or permissions marked as least privileged for this API. Us
3636
GET /deviceManagement/virtualEndpoint/deviceImages/getSourceImages
3737
```
3838

39+
## Optional query parameters
40+
41+
This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
42+
3943
## Request headers
4044

4145
|Name|Description|
@@ -48,11 +52,15 @@ Don't supply a request body for this method.
4852

4953
## Response
5054

51-
If successful, this function returns a `200 OK` response code and a [cloudPcSourceDeviceImage](../resources/cloudpcsourcedeviceimage.md) collection in the response body.
55+
If successful, this function returns a `200 OK` response code and a collection of [cloudPcSourceDeviceImage](../resources/cloudpcsourcedeviceimage.md) objects in the response body.
5256

5357
## Examples
5458

55-
### Request
59+
### Example 1: Get cloudPcSourceDeviceImage objects without any query parameters
60+
61+
The following example shows how to get **cloudPcSourceDeviceImage** objects without any query parameters.
62+
63+
#### Request
5664

5765
The following example shows a request.
5866

@@ -93,7 +101,63 @@ GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImag
93101

94102
---
95103

96-
### Response
104+
#### Response
105+
106+
The following example shows the response.
107+
108+
>**Note:** The response object shown here might be shortened for readability.
109+
<!-- {
110+
"blockType": "response",
111+
"truncated": true,
112+
"@odata.type": "Collection(microsoft.graph.cloudPcSourceDeviceImage)"
113+
}
114+
-->
115+
116+
``` http
117+
HTTP/1.1 200 OK
118+
Content-Type: application/json
119+
120+
{
121+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.cloudPcSourceDeviceImage)",
122+
"value": [
123+
{
124+
"id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/images/exampleImageForDev",
125+
"resourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/images/exampleImageForDev",
126+
"displayName": "exampleImageForDev",
127+
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
128+
"subscriptionDisplayName": "Reserved for IT",
129+
"category": "managedImage"
130+
},
131+
{
132+
"id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/galleries/exampleGallery/images/exampleImageForDev/versions/1.0.0",
133+
"resourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/galleries/exampleGallery/images/exampleImageForDev/versions/1.0.0",
134+
"displayName": "1.0.0",
135+
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
136+
"subscriptionDisplayName": "Reserved for IT",
137+
"category": "azureComputeGallery"
138+
}
139+
]
140+
}
141+
```
142+
143+
### Example 2: Get cloudPcSourceDeviceImage objects with a specific category
144+
145+
The following example shows how to get **cloudPcSourceDeviceImage** objects with a specific category.
146+
147+
#### Request
148+
149+
The following example shows a request.
150+
151+
<!-- {
152+
"blockType": "request",
153+
"name": "cloudpcdeviceimage_getsourceimageswithcategory"
154+
}
155+
-->
156+
``` http
157+
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/getSourceImages?$filter=category eq 'managedImage'
158+
```
159+
160+
#### Response
97161

98162
The following example shows the response.
99163

@@ -117,7 +181,8 @@ Content-Type: application/json
117181
"resourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.Compute/images/exampleImageForDev",
118182
"displayName": "exampleImageForDev",
119183
"subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
120-
"subscriptionDisplayName": "Reserved for IT"
184+
"subscriptionDisplayName": "Reserved for IT",
185+
"category": "managedImage"
121186
}
122187
]
123188
}

api-reference/beta/api/cloudpcreports-getcloudpcrecommendationreports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following table shows the parameters that can be used with this action.
5656
|filter|String|OData `$filter` syntax. Supported filters are: `and`, `or`, `lt`, `le`, `gt`, `ge`, and `eq`.|
5757
|groupBy|String collection|Specifies how to group the reports. If used, must have the same content as the **select** parameter.|
5858
|orderBy|String collection|Specifies how to sort the reports.|
59-
|reportName|[cloudPcReportName](../resources/cloudpcexportjob.md#cloudpcreportname-values)|Specifies the report name. Supports a subset of the values for **cloudPcReportName**. Supported values are: `cloudPcUsageCategoryReports`.|
59+
|reportName|[cloudPcReportName](../resources/cloudpcreportname.md)|Specifies the report name. Supports only `cloudPcUsageCategoryReports` for **cloudPcReportName**.|
6060
|search|String|Specifies a String to search.|
6161
|select|String collection|OData `$select` syntax. The selected columns of the reports. |
6262
|skip|Int32|Number of records to skip.|

api-reference/beta/api/cloudpcreports-post-exportjobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can specify the following properties when you create a **cloudPcExportJob**.
5050
|:---|:---|:---|
5151
|filter|String|The filter applied on the report. Optional.|
5252
|format|String|The format of the exported report. Optional.|
53-
|reportName|[cloudPcReportName](../resources/cloudpcexportjob.md#cloudpcreportname-values)|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`, `performanceTrendReport`, `inaccessibleCloudPcTrendReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`, `cloudPcInsightReport`, `regionalInaccessibleCloudPcTrendReport`, `troubleshootDetailsReport`, `troubleshootTrendCountReport`, `troubleshootRegionalReport`, `troubleshootIssueCountReport` . Use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`, `performanceTrendReport`, `inaccessibleCloudPcTrendReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`, `cloudPcInsightReport`, `regionalInaccessibleCloudPcTrendReport`, `troubleshootDetailsReport`, `troubleshootTrendCountReport`, `troubleshootRegionalReport`, `troubleshootIssueCountReport`.|
53+
|reportName|[cloudPcReportName](../resources/cloudpcreportname.md)|The report name. |
5454
|select|String collection|The selected columns of the report. Optional.|
5555

5656
## Response

api-reference/beta/api/exchangemessagetrace-getdetailsbyrecipient.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,7 @@ Get a list of [exchangeMessageTraceDetail](../resources/exchangemessagetracedeta
2020

2121
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).
2222

23-
<!-- {
24-
"blockType": "permissions",
25-
"name": "exchangemessagetrace-getdetailsbyrecipient-permissions"
26-
}
27-
-->
23+
<!-- { "blockType": "permissions", "name": "exchangemessagetrace_getdetailsbyrecipient" } -->
2824
[!INCLUDE [permissions-table](../includes/permissions/exchangemessagetrace-getdetailsbyrecipient-permissions.md)]
2925

3026
## HTTP request

api-reference/beta/api/group-post-groups.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
3333
<!-- { "blockType": "permissions", "name": "group_post_groups" } -->
3434
[!INCLUDE [permissions-table](../includes/permissions/group-post-groups-permissions.md)]
3535

36-
For an app create a group with owners or members while it has the *Group.Create* permission, the app must have the privileges to read the object type that it wants to assign as the group owner or member. Therefore:
36+
For an app to create a group with owners or members while it has the *Group.Create* permission, the app must have the privileges to read the object type that it wants to assign as the group owner or member. Therefore:
3737
+ The app can assign itself as the group's owner or member.
3838
+ To create the group with users as owners or members, the app must have at least the *User.Read.All* permission.
3939
+ To create the group with other service principals as owners or members, the app must have at least the *Application.Read.All* permission.
@@ -63,7 +63,7 @@ The following table lists the properties that are required when you create the [
6363
| :-------------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6464
| displayName | string | The name to display in the address book for the group. Maximum length is 256 characters. Required. |
6565
| mailEnabled | Boolean | Set to `true` for mail-enabled groups. Required. |
66-
| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. |
66+
| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following characters: ` @ () \ [] " ; : <> , SPACE`. Required. |
6767
| securityEnabled | Boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. |
6868

6969
> [!IMPORTANT]
@@ -76,7 +76,7 @@ The following table lists the properties that are required when you create the [
7676
>
7777
> - A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419).
7878
>
79-
> - To following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**.
79+
> - The following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **welcomeMessageEnabled**, **isSubscribedByMail**, **unseenCount**.
8080
8181
Because the **group** resource supports [extensions](/graph/extensibility-overview), you can add custom properties with your own data to the group while creating it.
8282

@@ -97,7 +97,7 @@ If successful, this method returns a `201 Created` response code and a [group](.
9797

9898
### Example 1: Create a Microsoft 365 group
9999

100-
The following example creates a Microsoft 365 group. Because the owners have not been specified, the calling user is automatically added as the owner of the group.
100+
The following example creates a Microsoft 365 group. When owners are not specified, the calling user is automatically added as the owner of the group.
101101

102102
#### Request
103103

@@ -212,7 +212,7 @@ Content-type: application/json
212212

213213
### Example 2: Create a security group with an owner and members
214214

215-
The following example creates a security group with an owner and members specified. Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. You can subsequently add more members by using the [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching.
215+
The following example creates a security group with an owner and members specified. Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. You can then add more members by using the [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching.
216216

217217
A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419).
218218

@@ -281,7 +281,7 @@ Content-Type: application/json
281281

282282
#### Response
283283

284-
The following is an example of a successful response. It includes only default properties. You can subsequently get the **owners** or **members** navigation properties of the group to verify the owner or members. The value of the **preferredDataLocation** property is inherited from the group creator's preferred data location.
284+
The following example shows a successful response. It includes only default properties. You can then get the **owners** or **members** navigation properties of the group to verify the owner or members. The value of the **preferredDataLocation** property is inherited from the group creator's preferred data location.
285285

286286
> **Note:** The response object shown here might be shortened for readability.
287287

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,11 @@ The following table specifies the properties that can be updated.
5858
| securityEnabled | Boolean | Specifies whether the group is a security group, including Microsoft 365 groups. |
5959
| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Can updated only if `null` and is immutable once set. |
6060
| visibility | String | Specifies the visibility of a Microsoft 365 group. The possible values are: **Private**, **Public**, or empty (which is interpreted as **Public**). |
61+
| welcomeMessageEnabled | Boolean | Default is `true`. Indicates whether a welcome message is sent to new members when they are added to the Microsoft 365 group. |
6162
| writebackConfiguration | [groupWritebackConfiguration](../resources/groupwritebackconfiguration.md) | Specifies whether or not a group is configured to write back group object properties to on-premise Active Directory. These properties are used when group writeback is configured in the [Microsoft Entra Connect](/azure/active-directory/hybrid/how-to-connect-group-writeback-v2) sync client.|
6263

6364
> [!IMPORTANT]
64-
> - To update these properties (**allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**), you must:
65+
> - To update these properties (**allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**, **welcomeMessageEnabled**), you must:
6566
> - Specify them in their own PATCH request without including other properties from the previous table
6667
> - Have the Group.ReadWrite.All permission (*Directory.ReadWrite.All* is not supported for these properties)
6768
> - Only a subset of the group API that pertains to core group administration and management supports application and delegated permissions. All other members of the group API, including updating **autoSubscribeNewMembers**, support only delegated permissions.
@@ -78,7 +79,7 @@ Use this API to manage the [directory, schema, and open extensions](/graph/exten
7879

7980
## Response
8081

81-
If successful, this method returns a `204 No Content` response code—except a `200 OK` response code when updating the following properties: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**.
82+
If successful, this method returns a `204 No Content` response code—except a `200 OK` response code when updating the following properties: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**, **welcomeMessageEnabled**.
8283

8384
## Examples
8485

0 commit comments

Comments
 (0)