Merge pull request #25945 from microsoftgraph/main

FaithOmbongi · web-flow · commit 84b649f65ef8 · 2024-12-18T12:47:13.000+03:00
Merge to publish
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,6 @@
 {
     "githubPullRequests.ignoredPullRequestBranches": [
+        "main",
         "main"
     ],
     "json.schemas": [
diff --git a/api-reference/beta/api/activitybasedtimeoutpolicy-post-activitybasedtimeoutpolicies.md b/api-reference/beta/api/activitybasedtimeoutpolicy-post-activitybasedtimeoutpolicies.md
@@ -30,7 +30,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
 <!-- { "blockType": "ignored" } -->
 
 ```http
-POST policies/activityBasedTimeoutPolicies
+POST /policies/activityBasedTimeoutPolicies
 ```
 
 ## Request headers
diff --git a/api-reference/beta/api/activitybasedtimeoutpolicy-update.md b/api-reference/beta/api/activitybasedtimeoutpolicy-update.md
@@ -47,7 +47,6 @@ In the request body, supply the values for relevant fields that should be update
 | Property     | Type        | Description |
 |:-------------|:------------|:------------|
 |definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy.  Required.|
-|description|String| Description for this policy.|
 |displayName|String| Display name for this policy. Required.|
 |isOrganizationDefault|Boolean|If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.|
 
diff --git a/api-reference/beta/api/announcement-get.md b/api-reference/beta/api/announcement-get.md
@@ -109,6 +109,7 @@ Content-Type: application/json
     "announcementDateTime": "2022-09-30T00:00:00Z",
     "targetDateTime": "2024-09-30T00:00:00Z",
     "impactLink": null,
+    "changeType": "deprecation",
     "isCustomerActionRequired": true
   }
 }
diff --git a/api-reference/beta/api/announcement-list.md b/api-reference/beta/api/announcement-list.md
@@ -134,6 +134,7 @@ Content-Type: application/json
       "announcementDateTime": "2022-09-30T00:00:00Z",
       "targetDateTime": "2024-09-30T00:00:00Z",
       "impactLink": null,
+      "changeType": "deprecation",
       "isCustomerActionRequired": true
     }
   ]
diff --git a/api-reference/beta/api/directory-deleteditems-restore.md b/api-reference/beta/api/directory-deleteditems-restore.md
@@ -70,6 +70,7 @@ The following table lists the parameters that are required when you call this ac
 |Parameter|Type|Description|
 |:---|:---|:---|
 |autoReconcileProxyConflict|Boolean|Optional parameter. Indicates whether Microsoft Entra ID should remove any conflicting proxy addresses while restoring a soft-deleted user whose one or more proxy addresses are currently used for an active user. Used only for restoring soft-deleted [user](../resources/user.md). The default value for this paramater is `false`.|
+|newUserPrincipalName|String|The new **userPrincipalName** to add to the restored [user](../resources/user.md). Optional.|
 
 ## Response
 
@@ -239,4 +240,44 @@ Content-type: application/json
 }
 ```
 
+### Request
+
+<!-- {
+  "blockType": "request",
+  "name": "restore_directory_deleteditem_newUserPrincipalName"
+}-->
+```http
+POST https://graph.microsoft.com/beta/directory/deleteditems/78bf875b-9343-4edc-9130-0d3958113563/restore
+Content-Type: application/json
+
+{
+  "newUserPrincipalName": "johndoe@contoso.com"
+}
+```
+
+### Response
+> **Note:** The response object shown here might be shortened for readability.
+<!-- {
+  "blockType": "response",
+  "truncated": true,
+  "@odata.type": "microsoft.graph.directoryObject"
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+    "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects/$entity",
+    "@odata.type": "#microsoft.graph.user",
+    "id": "78bf875b-9343-4edc-9130-0d3958113563",
+    "businessPhones": [],
+    "displayName": "SampleUser",
+    "givenName": "Sample",
+    "mobilePhone": "+1 425 555 0109",
+    "officeLocation": "18/2111",
+    "preferredLanguage": "en-US",
+    "surname": "Vance",
+    "userPrincipalName": "johndoe@contoso.com"
+}
+```
 
diff --git a/api-reference/beta/api/identitycontainer-list-productchanges.md b/api-reference/beta/api/identitycontainer-list-productchanges.md
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
 
 [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
 
-Get a list of the [changeItemBase](../resources/changeitembase.md) objects and their properties.
+Get a list of the [changeItemBase](../resources/changeitembase.md) objects and their properties. The API returns both Microsoft Entra change announcements and releases.
 
 ## Permissions
 
@@ -113,27 +113,50 @@ HTTP/1.1 200 OK
 Content-Type: application/json
 
 {
-  "value": [
-    {
-      "@odata.type": "#microsoft.graph.roadmap",
-      "id": "0146c01e-02c1-47a7-ad5b-8458a9351f95",
-      "changeItemState": "available",
-      "changeItemService": "reporting",
-      "tags": [
-        ""
-      ],
-      "systemTags": [],
-      "documentationUrls": [
-        "https://entra.microsoft.com/#view/Microsoft_AAD_DXP/ScenarioHealthSummary.ReactView"
-      ],
-      "shortDescription": "",
-      "title": "SLA Attainment Report at Tenant Level",
-      "description": "*Omitted for brevity*",
-      "deliveryStage": "ga",
-      "category": "monitoringReporting",
-      "publishedDateTime": "2024-06-24T07:00:00Z",
-      "gotoLink": null
-    }
-  ]
+    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/productChanges",
+    "@odata.nextLink": "https://graph.microsoft.com/beta/identity/productChanges?$skip=10",
+    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identity/productChanges?$select=changeItemService,description",
+    "value": [
+        {
+            "@odata.type": "#microsoft.graph.announcement",
+            "id": "01ec4ab4-e288-4e1c-8f8c-d5b0bc68b866",
+            "changeItemService": "msGraph",
+            "tags": [
+                "Identity Security"
+            ],
+            "systemTags": [],
+            "documentationUrls": [
+                "https://techcommunity.microsoft.com/t5/microsoft-entra-blog/important-update-azure-ad-graph-api-retirement/ba-p/4090534"
+            ],
+            "shortDescription": "Latest update on migrating your applications from Azure AD Graph to Microsoft Graph",
+            "title": "Migrate your apps to Microsoft Graph API",
+            "description": "In June of 2023, we shared an update on completion of a three-year notice period for the deprecation of the Azure AD Graph API service. The service is now in the retirement cycle and retirement (shut down) will be done with incremental stages. In the first stage of this retirement cycle, applications that are created after June 30, 2024, will receive an error (HTTP 403) for any requests to Azure AD Graph APIs ( https://graph.windows.net ). \n \n We understand that some apps may not have fully completed migration to Microsoft Graph. We are providing an optional configuration that will allow an application created after June 30, 2024, to resume use of Azure AD Graph APIs through June 2025. If you develop or distribute software that requires applications to be created as part of the installation or setup, and these applications will need to access Azure AD Graph APIs, you must prepare now to avoid interruption. \n \n We have recently begun rollout of Microsoft Entra recommendations to help monitor the status of your tenant, plus provide information about applications and service principals that are using Azure AD Graph APIs in your tenant. These new recommendations provide information to support your efforts to migrate the impacted applications and service principals to Microsoft Graph. \n \n For more information on Azure AD Graph retirement, the new recommendations for Azure AD Graph, and configuring applications created after June 30, 2024, for an extension of Azure AD Graph APIs, please click 'Learn more' below.",
+            "announcementDateTime": "2020-06-23T00:00:00Z",
+            "targetDateTime": "2024-06-30T00:00:00Z",
+            "impactLink": null,
+            "changeType": "retirement",
+            "isCustomerActionRequired": true
+        },
+        {
+            "@odata.type": "#microsoft.graph.roadmap",
+            "id": "0d17a065-f34c-4954-9a0a-2f9b45c5c166",
+            "changeItemService": "entitlementManagement",
+            "tags": [
+                ""
+            ],
+            "systemTags": [],
+            "documentationUrls": [
+                "https://learn.microsoft.com/en-us/entra/identity/role-based-access-control/permissions-reference#organizational-branding-administrator"
+            ],
+            "shortDescription": "",
+            "title": "Organizational Branding role for Entra ID Company Branding",
+            "description": "The new Organizational Branding Administrator privileges are limited to branding, allowing you to adhere to the principle of least privilege by eliminating the need for the Global Administrator role to configure branding.",
+            "changeItemState": "available",
+            "deliveryStage": "ga",
+            "category": "accessControl",
+            "publishedDateTime": "2024-05-06T07:00:00Z",
+            "gotoLink": null
+        }
+    ]
 }
 ```
diff --git a/api-reference/beta/api/roadmap-get.md b/api-reference/beta/api/roadmap-get.md
@@ -94,7 +94,9 @@ Content-Type: application/json
     "id": "8370d119-d695-4dd9-bce2-00e893fadf7d",
     "changeItemState": "available",
     "changeItemService": "microsoftAuthenticatorApp",
-    "tags": null,
+    "tags": [
+        ""
+    ],
     "systemTags": [
       "entra_roadmap_highlight_new_feature"
     ],
diff --git a/api-reference/beta/api/roadmap-list.md b/api-reference/beta/api/roadmap-list.md
@@ -119,7 +119,9 @@ Content-Type: application/json
       "id": "8370d119-d695-4dd9-bce2-00e893fadf7d",
       "changeItemState": "available",
       "changeItemService": "microsoftAuthenticatorApp",
-      "tags": null,
+      "tags": [
+        ""
+      ],
       "systemTags": [
         "entra_roadmap_highlight_new_feature"
       ],
diff --git a/api-reference/beta/resources/activitybasedtimeoutpolicy.md b/api-reference/beta/resources/activitybasedtimeoutpolicy.md
@@ -35,7 +35,6 @@ Inherits from [stsPolicy](stsPolicy.md).
 |:-------------|:------------|:------------|
 |id|String| Unique identifier for this policy. Read-only.|
 |definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required.|
-|description|String| Description for this policy.|
 |displayName|String| Display name for this policy. Required.|
 |isOrganizationDefault|Boolean|If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.|
 
diff --git a/api-reference/beta/resources/announcement.md b/api-reference/beta/resources/announcement.md
@@ -29,6 +29,7 @@ Inherits from [changeItemBase](../resources/changeitembase.md).
 |Property|Type|Description|
 |:---|:---|:---|
 |announcementDateTime|DateTimeOffset|Change announcement date. Supports `$filter` (`eq`, `ne`, `gt`, `lt`, `le` and `ge` on `year()`, `month()`, `day()`, `hour()`, `minute()`, and `second()` built in functions) and `$orderby`.|
+|changeType|changeAnnouncementChangeType|Specifies the nature of the change. The possible values are: `breakingChange`, `deprecation`, `endOfSupport`, `featureChange`, `other`, `retirement`, `securityIncident`, `uxChange`, `unknownFutureValue`. Supports `$filter` (`eq`, `ne`, `in`) and `$orderby`.|
 |changeItemService|String|Specifies the Microsoft Entra service name to which this item belongs. Inherited from [changeItemBase](../resources/changeitembase.md). Supports `$filter` (`eq`, `ne`, `in`) and `$orderby`.|
 |description|String|Description of the change announcement. Inherited from [changeItemBase](../resources/changeitembase.md). Supports `$filter` (`eq`, `ne`, `in`, `startswith`) and `$orderby`.|
 |documentationUrls|String collection|Link to the change documentation. Inherited from [changeItemBase](../resources/changeitembase.md). Supports `$filter` (`any` with `eq`).|
@@ -59,6 +60,7 @@ The following JSON representation shows the resource type.
   "@odata.type": "#microsoft.graph.announcement",
   "id": "String (identifier)",
   "changeItemService": "String",
+  "changeType": "String",
   "tags": [
     "String"
   ],
diff --git a/api-reference/beta/resources/changeitembase.md b/api-reference/beta/resources/changeitembase.md
@@ -17,8 +17,8 @@ Namespace: microsoft.graph
 
 Represents either a planned change or planned new feature in Microsoft Entra. This resource is an abstract type from which the following resources inherit:
 
-- [announcement](../resources/announcement.md)
-- [roadmap](../resources/roadmap.md).
+- [announcement](../resources/announcement.md) - represents a Microsoft Entra change announcement, such as deprecations, breaking changes, retirements, feature changes, and Microsoft-managed policies
+- [roadmap](../resources/roadmap.md) - represents previews and generally available releases
 
 Inherits from [entity](../resources/entity.md).
 
diff --git a/api-reference/beta/resources/enums.md b/api-reference/beta/resources/enums.md
@@ -12,6 +12,20 @@ ms.date: 12/06/2024
 
 Namespace: microsoft.graph
 
+### changeAnnouncementChangeType values
+
+|Member|
+|:---|
+|breakingChange|
+|deprecation|
+|endOfSupport|
+|featureChange|
+|other|
+|retirement|
+|securityIncident|
+|uxChange|
+|unknownFutureValue|
+
 ### hardwareOathTokenHashFunction values
 
 |Member|
diff --git a/api-reference/v1.0/api/activitybasedtimeoutpolicy-list.md b/api-reference/v1.0/api/activitybasedtimeoutpolicy-list.md
@@ -30,7 +30,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
 <!-- { "blockType": "ignored" } -->
 
 ```http
-GET policies/activityBasedTimeoutPolicies
+GET /policies/activityBasedTimeoutPolicies
 ```
 
 ## Optional query parameters
diff --git a/api-reference/v1.0/api/activitybasedtimeoutpolicy-update.md b/api-reference/v1.0/api/activitybasedtimeoutpolicy-update.md
@@ -47,7 +47,6 @@ In the request body, supply the values for relevant fields that should be update
 | Property     | Type        | Description |
 |:-------------|:------------|:------------|
 |definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy.  Required.|
-|description|String| Description for this policy.|
 |displayName|String| Display name for this policy. Required.|
 |isOrganizationDefault|Boolean|If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.|
 
diff --git a/api-reference/v1.0/resources/activitybasedtimeoutpolicy.md b/api-reference/v1.0/resources/activitybasedtimeoutpolicy.md
@@ -32,7 +32,6 @@ Inherits from [stsPolicy](stsPolicy.md).
 | Property     | Type        | Description |
 |:-------------|:------------|:------------|
 |definition|String collection| A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required.|
-|description|String| Description for this policy.|
 |displayName|String| Display name for this policy. Required.|
 |id|String| Unique identifier for this policy. Read-only.|
 |isOrganizationDefault|Boolean|If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.|
diff --git a/changelog/Microsoft.DirectoryServices.json b/changelog/Microsoft.DirectoryServices.json
@@ -13889,7 +13889,33 @@
       "CreatedDateTime": "2024-10-09T23:15:04.1920065Z",
       "WorkloadArea": "Identity and access",
       "SubArea": "Directory management"
-  }
+  },
+  {
+      "ChangeList": [
+        {
+          "Id": "8cd03a79-71de-467d-bd73-0b3449a28bfc",
+          "ApiChange": "Method",
+          "ChangedApiName": "restore",
+          "ChangeType": "Deletion",
+          "Description": "Removed the **restore** method from the [directoryObject](https://learn.microsoft.com/en-us/graph/api/resources/directoryObject?view=graph-rest-beta) resource.",
+          "Target": "directoryObject"
+        },
+        {
+          "Id": "8cd03a79-71de-467d-bd73-0b3449a28bfc",
+          "ApiChange": "Method",
+          "ChangedApiName": "restore",
+          "ChangeType": "Addition",
+          "Description": "Added the [restore](https://learn.microsoft.com/en-us/graph/api/directory-deleteditems-restore?view=graph-rest-beta) method to the [directoryObject](https://learn.microsoft.com/en-us/graph/api/resources/directoryObject?view=graph-rest-beta) resource.",
+          "Target": "directoryObject"
+        }
+      ],
+      "Id": "8cd03a79-71de-467d-bd73-0b3449a28bfc",
+      "Cloud": "Prod",
+      "Version": "beta",
+      "CreatedDateTime": "2024-12-17T00:35:00.3307839Z",
+      "WorkloadArea": "Identity and access",
+      "SubArea": "Directory management"
+    }
   ]
 }
   
diff --git a/concepts/delta-query-overview.md b/concepts/delta-query-overview.md
@@ -33,12 +33,14 @@ The typical call pattern is as follows:
 
      b.  If Microsoft Graph returns a `@odata.deltaLink` URL, there's no more data about the existing state of the resource to return in the current session. For future requests, the application uses the `@odata.deltaLink` URL to learn about changes to the resource.
 
+     c. A page can't contain both `@odata.deltaLink` and `@odata.nextLink`.
+
     > [!NOTE]
     > The Microsoft Graph response in Step 2 includes the resources that *currently* exist in the collection. Resources that were deleted prior to the initial delta query aren't returned. Updates made before the initial request are summarized on the resource returned as its latest state.
 
-3. When the application needs to learn about changes to the resource, it uses the `@odata.deltaLink` URL it received in step 2 to make requests. The application can make this request immediately after completing step 2 or when it checks for changes.
+4. When the application needs to learn about changes to the resource, it uses the `@odata.deltaLink` URL it received in step 2 to make requests. The application can make this request immediately after completing step 2 or when it checks for changes.
 
-4. Microsoft Graph returns a response describing changes to the resource since the previous request, and either a `@odata.nextLink` URL or a `@odata.deltaLink` URL.
+5. Microsoft Graph returns a response describing changes to the resource since the previous request, and either a `@odata.nextLink` URL or a `@odata.deltaLink` URL.
 
 > [!NOTE]
 > - Resources stored in Microsoft Entra ID (such as users and groups) support "sync from now" scenarios. This allows you to skip steps 1 and 2 (if you're not interested in retrieving the full state of the resource) and ask for the latest `@odata.deltaLink` instead. Append `$deltatoken=latest` to the `delta` function and the response will contain a `@odata.deltaLink` and no resource data. Resources in OneDrive and SharePoint also support this feature but require `token=latest` instead.
diff --git a/concepts/whats-new-overview.md b/concepts/whats-new-overview.md
@@ -49,6 +49,17 @@ Use the new restore bulk addition request API for more convenient, efficient, an
 - Deprecated the **crossRegionDisasterRecoveryEnabled** property of the [cloudPcCrossRegionDisasterRecoverySetting](/graph/api/resources/cloudpccrossregiondisasterrecoverysetting?view=graph-rest-beta&preserve-view=true) resource. Going forward use the **disasterRecoveryType** property.
 - Enabled `endpointConnectivityCheckVMAgentEndPointCommunicationError` as a supported error type in the **errorType** property of the [cloudPcOnPremisesConnectionHealthCheck](/graph/api/resources/cloudpconpremisesconnectionhealthcheck?view=graph-rest-beta&preserve-view=true) resource.
 
+### Identity and access | Directory management
+
+While [restoring soft-deleted users](/graph/api/directory-deleteditems-restore?view=graph-rest-beta&preserve-view=true), you can now specify whether Microsoft Entra ID should replace the user's **userPrincipalName** with a new value.
+
+### Identity and access | Identity and sign-in
+
+- Use Microsoft Graph APIs to stay informed about the latest [product updates](/graph/api/resources/changeitembase?view=graph-rest-beta&preserve-view=true), including the [product roadmap](/graph/api/resources/roadmap?view=graph-rest-beta&preserve-view=true) and [change announcements](/graph/api/resources/announcement?view=graph-rest-beta&preserve-view=true), the programmatic alternative to the *What's new* tab on the Microsoft Entra admin center.
+- You can now manage hardware OATH tokens for your organization and users programmatically via the following Microsoft Graph APIs:
+  - [hardwareOathTokenAuthenticationMethodDevice resource type and its associated methods](/graph/api/resources/hardwareoathtokenauthenticationmethoddevice?view=graph-rest-beta&preserve-view=true) to manage the hardware tokens in your tenant, including assigning to users
+  - [hardwareOathAuthenticationMethod resource type and its associated methods](/graph/api/resources/hardwareoathauthenticationmethod?view=graph-rest-beta&preserve-view=true) to manage tokens that are already assigned to users by activating or deactivating them
+
 ### Reports | Microsoft 365 monitoring reports
 
 The Microsoft 365 monitoring APIs provide telemetry data to monitor the health of various Microsoft services within a Microsoft 365 subscription for your organization. Use the new operations in the [serviceActivity](/graph/api/resources/serviceactivity?view=graph-rest-beta&preserve-view=true) resource to get telemetry data for Exchange Online, Microsoft 365 Apps, and Microsoft Teams.

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"githubPullRequests.ignoredPullRequestBranches": [`
	`3`	`+ "main",`
`3`	`4`	`"main"`
`4`	`5`	`],`
`5`	`6`	`"json.schemas": [`
Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,7 @@ Content-Type: application/json`
`109`	`109`	`"announcementDateTime": "2022-09-30T00:00:00Z",`
`110`	`110`	`"targetDateTime": "2024-09-30T00:00:00Z",`
`111`	`111`	`"impactLink": null,`
	`112`	`+ "changeType": "deprecation",`
`112`	`113`	`"isCustomerActionRequired": true`
`113`	`114`	`}`
`114`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,7 @@ Content-Type: application/json`
`134`	`134`	`"announcementDateTime": "2022-09-30T00:00:00Z",`
`135`	`135`	`"targetDateTime": "2024-09-30T00:00:00Z",`
`136`	`136`	`"impactLink": null,`
	`137`	`+ "changeType": "deprecation",`
`137`	`138`	`"isCustomerActionRequired": true`
`138`	`139`	`}`
`139`	`140`	`]`