Skip to content

filestoragecontainer.md

Latest commit

 

History

History
131 lines (120 loc) · 12.8 KB

filestoragecontainer.md

File metadata and controls

131 lines (120 loc) · 12.8 KB
title fileStorageContainer resource type
description Represents a location where multiple users or a group of users can store files and access them via an application.
author tonchan-msft
ms.localizationpriority medium
ms.subservice onedrive
doc_type resourcePageType
ms.date 09/27/2024

fileStorageContainer resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents a location where multiple users or a group of users can store files and access them via an application. All file system objects in a fileStorageContainer are returned as driveItem resources.

Methods

Method Return type Description
List fileStorageContainer collection Get a list of fileStorageContainer objects that are accessible to a caller.
Create fileStorageContainer Create a new fileStorageContainer object.
Get fileStorageContainer Read the properties and relationships of a fileStorageContainer object.
Update fileStorageContainer Update the properties of a fileStorageContainer object.
Delete None Delete a fileStorageContainer object.
Activate None Activate a fileStorageContainer object.
Restore deleted fileStorageContainer Restore a deleted fileStorageContainer object.
Remove deleted None Remove a deleted fileStorageContainer object.
Permanently delete None Permanently delete a fileStorageContainer object.
Get drive drive Get the drive resource from a fileStorageContainer object.
List permissions permission collection List permissions on a fileStorageContainer.
Add permissions permission Add permission to a fileStorageContainer.
Update permissions permission Update permission on a fileStorageContainer.
Delete permissions None Delete permission from a fileStorageContainer.
List custom property filestoragecontainercustompropertyvalue collection List custom properties of the fileStorageContainer.
Add custom property filestoragecontainercustompropertyvalue Create custom property to the fileStorageContainer.
Update custom property filestoragecontainercustompropertyvalue Update custom property on a fileStorageContainer.
Delete custom property None Delete a custom property from a fileStorageContainer.
List columns columnDefinition collection Get the collection of columns represented as columnDefinition resources in a fileStorageContainer.
Create column columnDefinition Create a column for a fileStorageContainer that specifies a columnDefinition.
Get column columnDefinition Get the properties of a column represented as a columnDefinition in a fileStorageContainer.
Update column columnDefinition Update an existing column represented as a columnDefinition in a fileStorageContainer.
Delete column None Delete a columnDefinition from a fileStorageContainer.
Update recycle bin settings recyclebinsettings Update recycleBin settings for a fileStorageContainer.
Restore recycle bin items recycleBinItem collection Restore recycle bin items in a fileStorageContainer.
Delete recycle bin items None Delete recycleBinItem objects permanently from the recycleBin of a fileStorageContainer.
List recycle bin items recycleBinItem collection List recycle bin items in a fileStorageContainer.
Lock None Lock a fileStorageContainer to prevent modifications to its content.
Unlock None Unlock a fileStorageContainer for users and application-only identities to allow the addition, updating, and deletion of content.
Create migration job sharePointMigrationJob Create a new sharePointMigrationJob object that is scheduled to run at a later time to migrate content from an intermediary storage to the target fileStorageContainer.
Provision migration containers sharePointMigrationContainerInfo Provision SharePoint-managed Azure blob containers as temporary storage for migration content and metadata.
Archive None Archive an active fileStorageContainer.
Unarchive None Unarchive an archived fileStorageContainer.

Properties

Property Type Description
archivalDetails siteArchivalDetails Archival details of the fileStorageContainer. Read-write.
assignedSensitivityLabel assignedLabel Sensitivity label assigned to the fileStorageContainer. Read-write.
containerTypeId GUID Container type ID of the fileStorageContainer. Each container must have only one container type. Read-only.
createdDateTime DateTimeOffset Date and time of the fileStorageContainer creation. Read-only.
customProperties fileStorageContainerCustomPropertyDictionary Custom property collection for the fileStorageContainer. Read-write.
description String Provides a user-visible description of the fileStorageContainer. Read-write.
displayName String The display name of the fileStorageContainer. Read-write.
id String The unique stable identifier of the fileStorageContainer. Read-only.
owners userIdentity collection List of users who own the fileStorageContainer. Read-only.
ownershipType fileStorageContainerOwnershipType Ownership type of the fileStorageContainer. The possible values are: tenantOwned. Read-only.
status fileStorageContainerStatus Status of the fileStorageContainer. Containers are created as inactive and require activation. Inactive containers are subjected to automatic deletion in 24 hours. The possible values are: inactive, active. Read-only.
storageUsedInBytes Int64 Storage used in the fileStorageContainer, in bytes. Read-only.
viewpoint fileStorageContainerViewpoint Data specific to the current user. Read-only.
lockState siteLockState Indicates the lock state of the fileStorageContainer. The possible values are unlocked and lockedReadOnly. Read-only.
settings fileStorageContainerSettings Settings associated with a fileStorageContainer. Read-write.
informationBarrier informationBarrier Information barrier of a fileStorageContainer. Read-write.

Relationships

Relationship Type Description
columns columnDefinition collection The set of custom structured metadata supported by the fileStorageContainer. Read-write.
drive drive The drive of the resource fileStorageContainer. Read-only.
permissions permission collection The set of permissions for users in the fileStorageContainer. The permission for each user is set by the roles property. The possible values are reader, writer, manager, and owner. Read-write.
recycleBin recycleBin Recycle bin of the fileStorageContainer. Read-only.
sharePointGroups sharePointGroup collection The collection of sharePointGroup objects local to the container. Read-write.
migrationJobs sharePointMigrationJob collection The collection of sharePointMigrationJob objects local to the container. Read-write.

roles property values

Value Description
reader Readers can read fileStorageContainer metadata and the content inside.
writer Writers can read and modify fileStorageContainer metadata and contents inside.
manager Managers can read and modify fileStorageContainer metadata and contents inside and manage the permissions to the container.
owner Owners can read and modify fileStorageContainer metadata and contents inside, manage container permissions, and delete and restore containers.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.fileStorageContainer",
  "id": "string (identifier)",
  "displayName": "string",
  "description": "string",
  "containerTypeId": "string",
  "containerTypeDisplayName": "string",
  "permissions": [ { "@odata.type": "microsoft.graph.permission" } ],
  "customProperties": "Dictionary(Edm.String, microsoft.graph.fileStorageContainerCustomPropertyValue)",
  "viewpoint": {"@odata.type": "microsoft.graph.fileStorageContainerViewpoint" },
  "drive": {"@odata.type": "microsoft.graph.drive"},
  "recycleBin": {"@odata.type": "microsoft.graph.recycleBin"},
  "status": {"@odata.type": "microsoft.graph.fileStorageContainerStatus"},
  "columns": [ {"@odata.type": "microsoft.graph.columnDefinition" } ],
  "createdDateTime": {"@odata.type": "microsoft.graph.dateTimeOffset"},
  "storageUsedInBytes": "int64",
  "assignedSensitivityLabel": {"@odata.type": "microsoft.graph.assignedLabel"},
  "owners":  [ { "@odata.type": "microsoft.graph.userIdentity" } ],
  "ownershipType": {"@odata.type": "microsoft.graph.fileStorageContainerOwnershipType"},
  "expiryDateTime": "string (timestamp)",
  "lockState": {"@odata.type": "microsoft.graph.siteLockState"},
  "settings": { "@odata.type": "microsoft.graph.fileStorageContainerSettings" },
  "informationBarrier": { "@odata.type": "microsoft.graph.informationBarrier" },
  "archivalDetails": { "@odata.type": "microsoft.graph.siteArchivalDetails" }
}