Skip to content

Commit 6be46bc

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #28032 from microsoftgraph/singhman/add-fileStorageContainer-archive-unarchive-api-doc
Add file storage container archive unarchive api doc
2 parents aa9a002 + afac403 commit 6be46bc

9 files changed

Lines changed: 260 additions & 12 deletions

‎api-reference/beta/api/filestoragecontainer-archive.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "fileStorageContainer: archive"
3+
description: "Archive an active fileStorageContainer."
4+
author: "singhman-msft"
5+
ms.date: 11/15/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "onedrive"
8+
doc_type: apiPageType
9+
---
10+
11+
# fileStorageContainer: archive
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Archive an active [fileStorageContainer](../resources/filestoragecontainer.md).
18+
19+
This action updates the [archivalDetails](../resources/sitearchivaldetails.md).
20+
21+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
22+
23+
## Permissions
24+
25+
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).
26+
27+
<!-- { "blockType": "permissions", "name": "filestoragecontainer_archive" } -->
28+
[!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-archive-permissions.md)]
29+
30+
[!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)]
31+
32+
> [!NOTE]
33+
> When delegated permissions are used, only members who are assigned the `PrincipalOwner` or `Owner` role can call this method.
34+
35+
## HTTP request
36+
37+
```http
38+
POST /storage/fileStorage/containers/{containerId}/archive
39+
```
40+
41+
## Request body
42+
43+
Don't supply a request body for this method.
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Response
52+
53+
If successful, this method returns a `204 No Content` response code.
54+
55+
## Examples
56+
57+
### Request
58+
59+
The following example shows a request.
60+
61+
<!-- {
62+
"blockType": "request",
63+
"name": "archive_fileStorageContainer",
64+
"sampleKeys": ["b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0"]
65+
}
66+
-->
67+
```http
68+
POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0/archive
69+
```
70+
71+
### Response
72+
73+
The following example shows the response.
74+
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true
78+
}
79+
-->
80+
```http
81+
HTTP/1.1 204 No Content
82+
```

‎api-reference/beta/api/filestoragecontainer-unarchive.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "fileStorageContainer: unarchive"
3+
description: "Unarchive an archived fileStorageContainer."
4+
author: "singhman-msft"
5+
ms.date: 11/15/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "onedrive"
8+
doc_type: apiPageType
9+
---
10+
11+
# fileStorageContainer: unarchive
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Unarchive an archived [fileStorageContainer](../resources/filestoragecontainer.md).
18+
19+
This action updates the [archivalDetails](../resources/sitearchivaldetails.md).
20+
21+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
22+
23+
## Permissions
24+
25+
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).
26+
27+
<!-- { "blockType": "permissions", "name": "filestoragecontainer_unarchive" } -->
28+
[!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-unarchive-permissions.md)]
29+
30+
[!INCLUDE [app-permissions](../includes/sharepoint-embedded-app-permissions.md)]
31+
32+
> [!NOTE]
33+
> When delegated permissions are used, only members who are assigned the `PrincipalOwner` or `Owner` role can call this method.
34+
35+
## HTTP request
36+
37+
```http
38+
POST /storage/fileStorage/containers/{containerId}/unarchive
39+
```
40+
41+
## Request body
42+
43+
Don't supply a request body for this method.
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Response
52+
53+
If successful, this method returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the container that is unarchived. To check the status of the unarchive operation, make a GET request to the location URL.
54+
55+
## Examples
56+
57+
### Request
58+
59+
The following example shows a request.
60+
61+
<!-- {
62+
"blockType": "request",
63+
"name": "unarchive_fileStorageContainer",
64+
"sampleKeys": ["b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0"]
65+
}
66+
-->
67+
```http
68+
POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0/unarchive
69+
```
70+
71+
### Response
72+
73+
The following example shows the response.
74+
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true
78+
}
79+
-->
80+
```http
81+
HTTP/1.1 202 Accepted
82+
Location: https://graph.microsoft.com/beta/storage/fileStorage/containers/b!d2XNj_LW80yZbxDjj4Uj4E1ZFa6_76xEroXu_lX_DFE59ZD-2EcGRZlA0R8Vm3f0
83+
```

‎api-reference/beta/includes/permissions/filestoragecontainer-archive-permissions.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|FileStorageContainer.Selected|FileStorageContainer.Manage.All|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|FileStorageContainer.Selected|Not available.|

‎api-reference/beta/includes/permissions/filestoragecontainer-unarchive-permissions.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|FileStorageContainer.Selected|FileStorageContainer.Manage.All|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|FileStorageContainer.Selected|Not available.|

‎api-reference/beta/resources/filestoragecontainer.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,13 @@ Represents a location where multiple users or a group of users can store files a
5050
|[Unlock](../api/filestoragecontainer-unlock.md)|None|Unlock a [fileStorageContainer](../resources/filestoragecontainer.md) for users and application-only identities to allow the addition, updating, and deletion of content.|
5151
|[Create migration job](../api/filestoragecontainer-post-migrationjobs.md)|[sharePointMigrationJob](../resources/sharepointmigrationjob.md)|Create a new [sharePointMigrationJob](../resources/sharepointmigrationjob.md) object that is scheduled to run at a later time to migrate content from an intermediary storage to the target [fileStorageContainer](../resources/filestoragecontainer.md).|
5252
|[Provision migration containers](../api/filestoragecontainer-provisionmigrationcontainers.md)|[sharePointMigrationContainerInfo](../resources/sharepointmigrationcontainerinfo.md)|Provision SharePoint-managed Azure blob containers as temporary storage for migration content and metadata.|
53+
|[Archive](../api/filestoragecontainer-archive.md)|None|Archive an active [fileStorageContainer](../resources/filestoragecontainer.md).|
54+
|[Unarchive](../api/filestoragecontainer-unarchive.md)|None|Unarchive an archived [fileStorageContainer](../resources/filestoragecontainer.md).|
5355

5456
## Properties
5557
|Property|Type|Description|
5658
|:---|:---|:---|
59+
|archivalDetails|[siteArchivalDetails](../resources/sitearchivaldetails.md)|Archival details of the **fileStorageContainer**. Read-write.|
5760
|assignedSensitivityLabel|[assignedLabel](../resources/assignedlabel.md)|Sensitivity label assigned to the **fileStorageContainer**. Read-write.|
5861
|containerTypeId|GUID|Container type ID of the **fileStorageContainer**. Each container must have only one container type. Read-only.|
5962
|createdDateTime|DateTimeOffset|Date and time of the **fileStorageContainer** creation. Read-only.|
@@ -121,7 +124,8 @@ The following JSON representation shows the resource type.
121124
"expiryDateTime": "string (timestamp)",
122125
"lockState": {"@odata.type": "microsoft.graph.siteLockState"},
123126
"settings": { "@odata.type": "microsoft.graph.fileStorageContainerSettings" },
124-
"informationBarrier": { "@odata.type": "microsoft.graph.informationBarrier" }
127+
"informationBarrier": { "@odata.type": "microsoft.graph.informationBarrier" },
128+
"archivalDetails": { "@odata.type": "microsoft.graph.siteArchivalDetails" }
125129
}
126130
```
127131

‎api-reference/beta/resources/sitearchivaldetails.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
author: "vanshisingh"
2+
author: "guptasandeep"
33
description: "Represents the archival details of a siteCollection."
44
title: "siteArchivalDetails resource type"
5+
ms.date: 02/06/2025
56
ms.localizationpriority: "medium"
67
ms.subservice: "sharepoint"
78
doc_type: resourcePageType
8-
ms.date: 08/01/2024
99
---
1010

1111
# siteArchivalDetails resource type
@@ -16,6 +16,8 @@ Represents the archival details of a [siteCollection](../resources/sitecollectio
1616

1717
| Property | Type | Description |
1818
|:------------- |:------ |:-----------------------------------------------|
19+
|archivedBy|[identitySet](../resources/identityset.md)| The user or application that archived the container. |
20+
|archivedDateTime|DateTimeOffset| Time when the container was archived. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. |
1921
| archiveStatus | siteArchiveStatus | Represents the current archive status of the site collection. Returned only on `$select`.|
2022

2123
### siteArchiveStatus values
@@ -25,7 +27,7 @@ Represents the archival details of a [siteCollection](../resources/sitecollectio
2527
| recentlyArchived | The site collection was recently archived. |
2628
| fullyArchived | The site collection is fully archived. |
2729
| reactivating | The site collection is reactivating. |
28-
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
30+
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
2931

3032
## Relationships
3133
None.
@@ -40,12 +42,9 @@ The following JSON representation shows the resource type.
4042

4143
```json
4244
{
43-
"archiveStatus": "fullyArchived"
45+
"@odata.type": "#microsoft.graph.siteArchivalDetails",
46+
"archivedBy": {"@odata.type": "microsoft.graph.identitySet"},
47+
"archivedDateTime": "String (timestamp)",
48+
"archiveStatus": "String"
4449
}
4550
```
46-
47-
<!-- {
48-
"type": "#page.annotation",
49-
"createdBy": "API Clinic",
50-
"section": "documentation"
51-
}-->

‎api-reference/beta/toc/files/toc.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,10 @@ items:
218218
href: ../../api/filestoragecontainer-post-migrationjobs.md
219219
- name: Provision migration containers
220220
href: ../../api/filestoragecontainer-provisionmigrationcontainers.md
221+
- name: Archive
222+
href: ../../api/filestoragecontainer-archive.md
223+
- name: Unarchive
224+
href: ../../api/filestoragecontainer-unarchive.md
221225
- name: File storage container type
222226
items:
223227
- name: File storage container type

‎changelog/Microsoft.FileServices.json‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,55 @@
11
{
22
"changelog": [
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "8ac5619f-4267-4d2d-b466-205c42c4ab6e",
7+
"ApiChange": "Property",
8+
"ChangedApiName": "archivalDetails",
9+
"ChangeType": "Addition",
10+
"Description": "Added the **archivalDetails** property to the [fileStorageContainer](https://learn.microsoft.com/en-us/graph/api/resources/fileStorageContainer?view=graph-rest-beta) resource.",
11+
"Target": "fileStorageContainer"
12+
},
13+
{
14+
"Id": "8ac5619f-4267-4d2d-b466-205c42c4ab6e",
15+
"ApiChange": "Method",
16+
"ChangedApiName": "archive",
17+
"ChangeType": "Addition",
18+
"Description": "Added the [archive](https://learn.microsoft.com/en-us/graph/api/fileStorageContainer-archive?view=graph-rest-beta) method to the [fileStorageContainer](https://learn.microsoft.com/en-us/graph/api/resources/fileStorageContainer?view=graph-rest-beta) resource.",
19+
"Target": "fileStorageContainer"
20+
},
21+
{
22+
"Id": "8ac5619f-4267-4d2d-b466-205c42c4ab6e",
23+
"ApiChange": "Method",
24+
"ChangedApiName": "unarchive",
25+
"ChangeType": "Addition",
26+
"Description": "Added the [unarchive](https://learn.microsoft.com/en-us/graph/api/fileStorageContainer-unarchive?view=graph-rest-beta) method to the [fileStorageContainer](https://learn.microsoft.com/en-us/graph/api/resources/fileStorageContainer?view=graph-rest-beta) resource.",
27+
"Target": "fileStorageContainer"
28+
},
29+
{
30+
"Id": "8ac5619f-4267-4d2d-b466-205c42c4ab6e",
31+
"ApiChange": "Property",
32+
"ChangedApiName": "archivedBy",
33+
"ChangeType": "Addition",
34+
"Description": "Added the **archivedBy** property to the [siteArchivalDetails](https://learn.microsoft.com/en-us/graph/api/resources/siteArchivalDetails?view=graph-rest-beta) resource.",
35+
"Target": "siteArchivalDetails"
36+
},
37+
{
38+
"Id": "8ac5619f-4267-4d2d-b466-205c42c4ab6e",
39+
"ApiChange": "Property",
40+
"ChangedApiName": "archivedDateTime",
41+
"ChangeType": "Addition",
42+
"Description": "Added the **archivedDateTime** property to the [siteArchivalDetails](https://learn.microsoft.com/en-us/graph/api/resources/siteArchivalDetails?view=graph-rest-beta) resource.",
43+
"Target": "siteArchivalDetails"
44+
}
45+
],
46+
"Id": "8ac5619f-4267-4d2d-b466-205c42c4ab6e",
47+
"Cloud": "Prod",
48+
"Version": "beta",
49+
"CreatedDateTime": "2026-03-11T08:51:41.6874556Z",
50+
"WorkloadArea": "Files",
51+
"SubArea": ""
52+
},
353
{
454
"ChangeList": [
555
{
@@ -5497,4 +5547,4 @@
54975547
"SubArea": ""
54985548
}
54995549
]
5500-
}
5550+
}

‎concepts/whats-new-overview.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ Using the **signInAudience** and **signInAudienceRestrictions** properties to li
4646

4747
Added the `includeNewerItems` member as supported value for the **tags** property on [restorePoint](/graph/api/resources/restorepoint?view=graph-rest-beta&preserve-view=true) to get a restore point within a specified time period that includes any newer items created during that period.
4848

49+
### Files | File storage container
50+
51+
[Archive](/graph/api/filestoragecontainer-archive?view=graph-rest-beta&preserve-view=true) or [unarchive](/graph/api/filestoragecontainer-unarchive?view=graph-rest-beta&preserve-view=true) a SharePoint Embedded storage container.
52+
4953
### Identity and access | Governance
5054

5155
Added the [targetAgentIdentitySponsorsOrOwners](/graph/api/resources/targetagentidentitysponsorsorowners?view=graph-rest-beta&preserve-view=true) resource type that defines the sponsors or owners of a specific agent identity.

0 commit comments

Comments
 (0)