-
Notifications
You must be signed in to change notification settings - Fork 284
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24394 from microsoftgraph/main
Merge to publish.
- Loading branch information
Showing
49 changed files
with
2,019 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| title: "Delete fileStorageContainer" | ||
| description: "Delete a fileStorageContainer object." | ||
| author: "tonchan-msft" | ||
| ms.localizationpriority: medium | ||
| ms.subservice: "onedrive" | ||
| doc_type: apiPageType | ||
| --- | ||
|
|
||
| # Delete fileStorageContainer | ||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object. This method moves the **fileStorageContainer** to the recycle bin, instead of permanently deleting it. | ||
|
|
||
| ## Permissions | ||
|
|
||
| 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). | ||
|
|
||
|
|
||
| <!-- { "blockType": "permissions", "name": "filestorage_delete_containers" } --> | ||
| [!INCLUDE [permissions-table](../includes/permissions/filestorage-delete-containers-permissions.md)] | ||
|
|
||
| [!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)] | ||
|
|
||
| ## HTTP request | ||
|
|
||
| <!-- { | ||
| "blockType": "ignored" | ||
| } | ||
| --> | ||
| ``` http | ||
| DELETE /storage/fileStorage/containers/{containerId} | ||
| ``` | ||
|
|
||
| ## Request headers | ||
|
|
||
| |Name|Description| | ||
| |:---|:---| | ||
| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | ||
|
|
||
| ## Request body | ||
|
|
||
| Don't supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this method returns a `204 No Content` response code. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
|
|
||
| The following example shows a request. | ||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "delete_filestoragecontainer" | ||
| } | ||
| --> | ||
| ``` http | ||
| DELETE https://graph.microsoft.com/v1.0/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z | ||
| ``` | ||
|
|
||
|
|
||
| ### Response | ||
|
|
||
| The following example shows the response. | ||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true | ||
| } | ||
| --> | ||
| ``` http | ||
| HTTP/1.1 204 No Content | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| title: "List containers" | ||
| description: "Get a list of fileStorageContainers and their properties." | ||
| author: "tonchan-msft" | ||
| ms.localizationpriority: medium | ||
| ms.subservice: "onedrive" | ||
| doc_type: apiPageType | ||
| --- | ||
|
|
||
| # List containers | ||
|
|
||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| Retrieve a list of [fileStorageContainer](../resources/filestoragecontainer.md) objects that are visible to the caller. The `containerTypeId` filter parameter is required. | ||
|
|
||
| ## Permissions | ||
|
|
||
| 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). | ||
|
|
||
| <!-- { "blockType": "permissions", "name": "filestorage_list_containers" } --> | ||
| [!INCLUDE [permissions-table](../includes/permissions/filestorage-list-containers-permissions.md)] | ||
|
|
||
| [!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)] | ||
|
|
||
| ## HTTP request | ||
|
|
||
| <!-- { | ||
| "blockType": "ignored" | ||
| } | ||
| --> | ||
| ``` http | ||
| GET /storage/fileStorage/containers?$filter=containerTypeId eq {containerTypeId} | ||
| GET /storage/fileStorage/containers?$filter=containerTypeId eq {containerTypeId} and viewpoint/effectiveRole eq 'principalOwner' | ||
| ``` | ||
|
|
||
| ## Query parameters | ||
|
|
||
| This method required the `containerTypeId` parameter. It supports the `$expand` OData query parameter, except for the **drive**, **permissions**, and **customProperties** properties. For more information, see [OData query parameters](/graph/query-parameters). | ||
|
|
||
| ## Request headers | ||
|
|
||
| |Name|Description| | ||
| |:---|:---| | ||
| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | ||
|
|
||
| ## Request body | ||
|
|
||
| Don't supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this method returns a `200 OK` response code and a collection of [fileStorageContainer](../resources/filestoragecontainer.md) objects in the response body. Only a limited subset of properties is returned for each **fileStorageContainer**. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
|
|
||
| The following example enumerates all containers of a given container type. | ||
|
|
||
|
|
||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "list_filestoragecontainer" | ||
| } | ||
| --> | ||
| ``` http | ||
| GET https://graph.microsoft.com/v1.0/storage/fileStorage/containers?$filter=containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082 | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| The following example shows the response. | ||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true, | ||
| "@odata.type": "Collection(microsoft.graph.fileStorageContainer)" | ||
| } | ||
| --> | ||
| ``` http | ||
| HTTP/1.1 200 OK | ||
| Content-Type: application/json | ||
| { | ||
| "@odata.context": "https://graph.microsoft.com/v1.0/storage/fileStorage/containers", | ||
| "@odata.count": 1, | ||
| "value": [ | ||
| { | ||
| "@odata.type": "#microsoft.graph.fileStorageContainer", | ||
| "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z", | ||
| "displayName": "My File Storage Container", | ||
| "containerTypeId": "e2756c4d-fa33-4452-9c36-2325686e1082", | ||
| "createdDateTime": "2021-11-24T15:41:52.347Z" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| --- | ||
| title: "fileStorageContainer: activate" | ||
| description: "Activate a fileStorageContainer object." | ||
| author: "tonchan-msft" | ||
| ms.localizationpriority: medium | ||
| ms.subservice: "onedrive" | ||
| doc_type: apiPageType | ||
| --- | ||
|
|
||
| # fileStorageContainer: activate | ||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| Activate a [fileStorageContainer](../resources/filestoragecontainer.md) object. | ||
|
|
||
| A **fileStorageContainer** object is created in an inactive state, as indicated by the **status** property. A container must be activated within 24 hours after creation, or it will be automatically deleted. Upon activation, the value of the status property changes from `inactive` to `active`. | ||
|
|
||
| A **fileStorageContainer** can be activated by calling the **activate** API, or any other API that updates or modifies the **fileStorageContainer** or its content. For example, uploading a file to a **fileStorageContainer**, adding permission to a **fileStorageContainer**, creating a custom property on a **fileStorageContainer**, or updating the properties of a **fileStorageContainer** can activate it. | ||
|
|
||
|
|
||
| ## Permissions | ||
|
|
||
| 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). | ||
|
|
||
|
|
||
| <!-- { "blockType": "permissions", "name": "filestoragecontainer_activate" } --> | ||
| [!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-activate-permissions.md)] | ||
|
|
||
| [!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)] | ||
|
|
||
| ## HTTP request | ||
|
|
||
| <!-- { | ||
| "blockType": "ignored" | ||
| } | ||
| --> | ||
| ``` http | ||
| POST /storage/fileStorage/containers/{containerId}/activate | ||
| ``` | ||
|
|
||
| ## Request headers | ||
|
|
||
| |Name|Description| | ||
| |:---|:---| | ||
| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | ||
|
|
||
| ## Request body | ||
|
|
||
| Don't supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this action returns a `204 No Content` response code. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
|
|
||
| The following example shows a request. | ||
|
|
||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "activate_filestoragecontainer" | ||
| } | ||
| --> | ||
| ``` http | ||
| POST https://graph.microsoft.com/v1.0/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/activate | ||
| ``` | ||
|
|
||
| ### Response | ||
|
|
||
| The following example shows the response. | ||
|
|
||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true | ||
| } | ||
| --> | ||
| ``` http | ||
| HTTP/1.1 204 No Content | ||
| ``` | ||
|
|
Oops, something went wrong.