Skip to content

Commit

Permalink
Merging changes synced from https://github.com/microsoftgraph/microso…
Browse files Browse the repository at this point in the history
…ft-graph-docs (branch live)
  • Loading branch information
Learn Build Service GitHub App authored and Learn Build Service GitHub App committed Dec 26, 2024
2 parents 063c4d7 + 5ffa728 commit 35a1bab
Show file tree
Hide file tree
Showing 507 changed files with 2,538 additions and 1,003 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ HTTP/1.1 200 OK
"directoryObjectId": "384974e2-72cd-48de-a6e8-6985d7c5db90",
"displayName": "Jefferson Lee", // Newly Added
"email": "[email protected]", // Newly Added
"mailboxType": "user",
"status": "unprotectRequested",
"createdBy": {
"application": {
Expand Down Expand Up @@ -163,6 +164,7 @@ HTTP/1.1 200 OK
"displayName": "Mastura Ibrahim", // Newly Added
"email": "[email protected]", // Newly Added
"status": "unprotected",
"mailboxType": "shared",
"createdBy": {
"application": {
"id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
Expand Down Expand Up @@ -196,6 +198,7 @@ HTTP/1.1 200 OK
"directoryObjectId": "2d1d9337-d8f0-456e-92cd-00a3abdd2093",
"displayName": "Ahmad Hakiki", // Newly Added
"email": "[email protected]", // Newly Added
"mailboxType": "user",
"status": "protectRequested",
"createdBy": {
"application": {
Expand Down Expand Up @@ -230,6 +233,7 @@ HTTP/1.1 200 OK
"directoryObjectId": "2e1d9337-d8f0-456e-92cd-00a3abdd2093",
"displayName": "Jeffry Goh", // Newly Added
"email": "[email protected]", // Newly Added
"mailboxType": "user",
"status": "protected",
"createdBy": {
"application": {
Expand Down Expand Up @@ -264,6 +268,7 @@ HTTP/1.1 200 OK
"displayName": "Suresh Pasupuleti", // Newly Added
"email": "[email protected]", // Newly Added
"status": "unprotected",
"mailboxType": "shared",
"createdBy": {
"application": {
"id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
Expand Down Expand Up @@ -331,6 +336,7 @@ HTTP/1.1 200 OK
"displayName": "Jefferson Lee", // Newly Added
"email": "[email protected]", // Newly Added
"status": "protectRequested",
"mailboxType": "user",
"createdBy": {
"application": {
"id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
Expand Down Expand Up @@ -364,6 +370,7 @@ HTTP/1.1 200 OK
"directoryObjectId": "184d9337-d8f0-456e-92cd-00a3abdd2093",
"displayName": "Mastura Ibrahim", // Newly Added
"email": "[email protected]", // Newly Added
"mailboxType": "shared",
"status": "protectRequested",
"createdBy": {
"application": {
Expand Down Expand Up @@ -399,6 +406,7 @@ HTTP/1.1 200 OK
"displayName": "Esmira Musayeva", // Newly Added
"email": "[email protected]", // Newly Added
"status": "protectRequested",
"mailboxType": "user",
"createdBy": {
"application": {
"id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
Expand Down Expand Up @@ -433,6 +441,7 @@ HTTP/1.1 200 OK
"displayName": "Ahmad Hakiki", // Newly Added
"email": "[email protected]", // Newly Added
"status": "protectRequested",
"mailboxType": "user",
"createdBy": {
"application": {
"id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
Expand Down Expand Up @@ -467,6 +476,7 @@ HTTP/1.1 200 OK
"displayName": "Rashmi Mishra ", // Newly Added
"email": "[email protected]", // Newly Added
"status": "protectRequested",
"mailboxType": "shared",
"createdBy": {
"application": {
"id": "1fec8e78-bce4-4aaf-ab1b-5451cc387264",
Expand Down
4 changes: 2 additions & 2 deletions api-reference/beta/api/drive-get.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
author: spgraph-docs-team
title: "Get drive"
description: "Retrieve the properties and relationships of a Drive resource."
ms.date: 09/10/2017
title: Get drive
author: spgraph-docs-team
ms.localizationpriority: medium
ms.subservice: "sharepoint"
doc_type: apiPageType
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/aaduserconversationmember.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ Inherits from [conversationMember](conversationmember.md).
|userId| String | The GUID of the user. |
|visibleHistoryStartDateTime| DateTimeOffset | The timestamp that denotes how far back the history of a conversation is shared with the conversation member. This property is settable only for members of a chat.|

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ Inherits from [actionResultPart](actionresultpart.md).
|error|[publicError](publicerror.md) |The error that occurred, if any, during the course of the bulk operation.|
|userId|String|The user object ID of the Microsoft Entra user that was being added as part of the bulk operation.|

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/acceptjoinresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Represents a response to accept a participant who tries to join the meeting.

None.

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
6 changes: 4 additions & 2 deletions api-reference/beta/resources/accessaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ ms.subservice: "sharepoint"
Namespace: microsoft.graph



The presence of the **accessAction** resource on an [**itemActivity**][activity] indicates that the activity accessed an item.

>**Note:** Access activity records are currently only available on SharePoint and OneDrive for Business.
Expand All @@ -21,7 +20,10 @@ The presence of the **accessAction** resource on an [**itemActivity**][activity]

## Properties

This resource type has no properties.
None.

## Relationships
None.

## JSON representation

Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/accessreviewhistoryinstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ Namespace: microsoft.graph
|runDateTime|DateTimeOffset|The date and time when the instance's history data is scheduled to be generated.|
|status|accessReviewHistoryStatus|Represents the status of the review history data collection. The possible values are: `done`, `inProgress`, `error`, `requested`, `unknownFutureValue`. Once the **status** is marked as `done`, you can generate a link retrieve the instance's data by calling [generateDownloadUri](../api/accessreviewhistoryinstance-generatedownloaduri.md) method.|

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Represents a base class for different types of review targets, each one with its
## Properties
None.

## Relationships
None.

## JSON representation
The following JSON representation shows the resource type.
<!-- {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ The **accessReviewRecurrenceSettings** resource type is used in the [accessRevie
| durationInDays | Int32 | The duration in days for recurrence. |
| recurrenceCount | Int32 | The count of recurrences, if the value of **recurrenceEndType** is `occurrences`, or `0` otherwise. |

## Relationships
None.

## JSON representation

<!-- {
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/accessreviewsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Provides more settings when creating an access review, to control the feature be
| autoApplyReviewResultsEnabled | Boolean | Indicates whether the auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review. |
| accessRecommendationsEnabled | Boolean | Indicates whether showing recommendations to reviewers is enabled. |

## Relationships
None.

## JSON representation
<!-- {
"blockType": "resource",
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/addin.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Defines custom behavior that a consuming service can use to call an app in speci
|properties|[keyValue](keyvalue.md) collection|The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the **addIns** collection. Required.|
|type|string|The unique name for the functionality exposed by the app. |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/adminreportsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Represents the tenant-level settings for Microsoft 365 reports.
| -------------- | -------------- | ------------------------------------------- |
| displayConcealedNames | Boolean | If set to `true`, all reports conceal user information such as usernames, groups, and sites. If `false`, all reports show identifiable information. This property represents a setting in the Microsoft 365 admin center. Required. |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
9 changes: 6 additions & 3 deletions api-reference/beta/resources/album.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,13 @@ A photo album is a way to virtually group [driveItems][driveItem] with [photo][]
| :--------------- | :----- | :--------------------------------------------------------------------- |
| coverImageItemId | String | Unique identifier of the [driveItem][] that is the cover of the album. |

**Note:** If a **coverImageItemId** hasn't been set before, the thumbnails for an album are chosen automatically.
After **coverImageItemId** has been set, the thumbnails for an album will always be the item associated with that id.
**Note:** If a **coverImageItemId** isn't set, the thumbnails for an album are chosen automatically.
After **coverImageItemId** is set, the thumbnails for an album are always the item associated with that id.
You can override the default cover by PATCHing the [bundle item][bundle] and setting the **coverImageItemId** property on the `album` to the id of an image contained within the album.
To remove a custom-set cover, you can set the **coverImageItemId** property to null, and a default one will be chosen automatically again.
To remove a custom-set cover, you can set the **coverImageItemId** property to null, and a default one is automatically chosen again.

## Relationships
None.

## JSON representation

Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/alerthistorystate.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Stores changes made to alerts.
|updatedDateTime|DateTimeOffset| Date and time of the alert update. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`|
|user|String| UPN of the signed-in user that updated the alert (taken from the bearer token - if in user/delegated auth mode). |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/alerttrigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Contains information about the properties that triggered a detection (properties
|type|String|Type of the property in the key:value pair for interpretation. For example, String, Boolean etc.|
|value|String|Value of the property serving as a detection trigger.|

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/alternativesecurityid.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ For internal use only. This complex type will be deprecated in the future.
| key | Edm.Binary | For internal use only.|
| type | Int32 | For internal use only.|

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/apiapplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ Specifies settings for an [application](application.md) that implements a web AP
|preAuthorizedApplications| [preAuthorizedApplication](preauthorizedapplication.md) collection | Lists the client applications that are preauthorized with the specified delegated permissions to access this application's APIs. Users aren't required to consent to any preauthorized application (for the permissions specified). However, any other permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. |
|requestedAccessTokenVersion| Int32 | Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. <br><br> The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure **requestedAccessTokenVersion** to indicate the supported access token format. <br><br> Possible values for **requestedAccessTokenVersion** are `1`, `2`, or `null`. If the value is `null`, this defaults to `1`, which corresponds to the v1.0 endpoint. <br><br> If **signInAudience** on the application is configured as `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`, the value for this property must be `2`. |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/apphostedmediaconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Media stack hosted by the application.
| blob | String | The media configuration blob generated by smart media agent. |
| removeFromDefaultAudioGroup | Boolean | Remove audio from the default audio group |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/applemanagedidentityprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ For the list of API operations for managing Apple-managed identity providers, se

Retrieve the **developerId**, **serviceId**, **keyId**, and the **certificateData** from the Apple developer portal. For more information, follow the guide to [create an Apple ID application](/azure/active-directory-b2c/identity-provider-apple-id?pivots=b2c-user-flow#create-an-apple-id-application).

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ The data in this object is returned only for callers with privileges to read con



## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
11 changes: 7 additions & 4 deletions api-reference/beta/resources/approle.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Namespace: microsoft.graph

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

Represents an application role that can be requested by (and granted to) a client application, or that can be used to assign an application to users or groups in a specified role.
Represents an application role. Client applications can request application roles. Application roles can also be used to assign an application to users or groups in a specified role.

To add, update, or remove app roles for an application, [update the application](../api/application-update.md) for the app or service. App roles on the application entity will be available in all tenants where the application is used. To define app roles that are only applicable in your tenant (for example, app roles representing custom roles in your instance of a multi-tenant application), you can also [update the service principal](../api/serviceprincipal-update.md) for the app, to add or update app roles to the **appRoles** collection.
To add, update, or remove app roles for an application, [update the application](../api/application-update.md) for the app or service. App roles on the application entity will be available in all tenants where the application is used. To define app roles that are only applicable in your tenant (for example, app roles representing custom roles in your instance of a multitenant application), you can also [update the service principal](../api/serviceprincipal-update.md) for the app, to add or update app roles to the **appRoles** collection.

With [appRoleAssignments](approleassignment.md), app roles can be assigned to users, groups, or other applications' service principals.

Expand All @@ -28,9 +28,12 @@ With [appRoleAssignments](approleassignment.md), app roles can be assigned to us
|description|String|The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.|
|displayName|String|Display name for the permission that appears in the app role assignment and consent experiences.|
|id|Guid|Unique role identifier inside the **appRoles** collection. You must specify a new GUID identifier when you create a new app role. |
|isEnabled|Boolean|When creating or updating an app role, this must be set to **true** (which is the default). To delete a role, this must first be set to **false**. At that point, in a subsequent call, this role may be removed.|
|isEnabled|Boolean|When you create or updating an app role, this value must be **true**. To delete a role, this must first be set to **false**. At that point, in a subsequent call, this role might be removed. Default value is **true**.|
|origin|String| Specifies if the app role is defined on the [application](application.md) object or on the [servicePrincipal](serviceprincipal.md) entity. Must _not_ be included in any POST or PATCH requests. Read-only. |
|value|String|Specifies the value to include in the `roles` claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are `:` `!` `#` `$` `%` `&` `'` `(` `)` `*` `+` `,` `-` `.` `/` `:` `;` <code>&lt;</code> `=` <code>&gt;</code> `?` `@` `[` `]` `^` `+` `_` <code>&#96;</code> `{` <code>&#124;</code> `}` `~`, and characters in the ranges `0-9`, `A-Z` and `a-z`. Any other character, including the space character, aren't allowed. May not begin with `.`. |
|value|String|Specifies the value to include in the `roles` claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are `:` `!` `#` `$` `%` `&` `'` `(` `)` `*` `+` `,` `-` `.` `/` `:` `;` <code>&lt;</code> `=` <code>&gt;</code> `?` `@` `[` `]` `^` `+` `_` <code>&#96;</code> `{` <code>&#124;</code> `}` `~`, and characters in the ranges `0-9`, `A-Z`, and `a-z`. Any other character, including the space character, aren't allowed. May not begin with `.`. |

## Relationships
None.

## JSON representation

Expand Down
3 changes: 3 additions & 0 deletions api-reference/beta/resources/approleassignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ An app role assignment where the assigned principal is a service principal is an
| resourceDisplayName | String | The display name of the resource app's service principal to which the assignment is made. Maximum length is 256 characters. |
| appRoleId | Guid | The identifier (**id**) for the [app role](approle.md) that is assigned to the principal. This app role must be exposed in the **appRoles** property on the resource application's service principal (**resourceId**). If the resource application hasn't declared any app roles, a default app role ID of `00000000-0000-0000-0000-000000000000` can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
7 changes: 5 additions & 2 deletions api-reference/beta/resources/assignedlabel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "assignedLabel resource type"
description: "Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity labels allow administrators to enforce specific group settings on a group by assigning a classification to the group (such as Confidential, Highly Confidential or General)."
description: "Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity labels allow administrators to enforce specific group settings on a group by assigning a classification to the group (such as Confidential, Highly Confidential, or General)."
ms.localizationpriority: medium
author: "yuhko-msft"
ms.reviewer: "mbhargav, khotzteam, aadgroupssg"
Expand All @@ -15,7 +15,7 @@ Namespace: microsoft.graph

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

Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity labels allow administrators to enforce specific group settings on a group by assigning a classification to the group (such as Confidential, Highly Confidential or General). Sensitivity labels are published by administrators in Microsoft 365 Security & Compliance Center as part of Microsoft Information Protection capabilities. For more information about sensitivity labels, see [Sensitivity labels overview](/Office365/SecurityCompliance/sensitivity-labels).
Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity labels allow administrators to enforce specific group settings on a group by assigning a classification to the group (such as Confidential, Highly Confidential, or General). Sensitivity labels are published by administrators in Microsoft 365 Security & Compliance Center as part of Microsoft Information Protection capabilities. For more information about sensitivity labels, see [Sensitivity labels overview](/Office365/SecurityCompliance/sensitivity-labels).

## Properties

Expand All @@ -24,6 +24,9 @@ Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity la
| labelId | String | The unique identifier of the label. |
| displayName | String | The display name of the label. Read-only. |

## Relationships
None.

## JSON representation

The following JSON representation shows the resource type.
Expand Down
Loading

0 comments on commit 35a1bab

Please sign in to comment.