Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Retrieve a list of fileStorageContainer objects that are visible to the caller. The containerTypeId filter parameter is required.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
✅ |
✅ |
✅ |
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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
FileStorageContainer.Selected |
Not supported. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
FileStorageContainer.Selected |
Not supported. |
HTTP request
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.
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 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.
GET https://graph.microsoft.com/beta/storage/fileStorage/containers?$filter=containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Storage.FileStorage.Containers.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082";
});
mgc-beta storage file-storage containers list --filter "containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082"
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphstorage "github.com/microsoftgraph/msgraph-beta-sdk-go/storage"
//other-imports
)
requestFilter := "containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082"
requestParameters := &graphstorage.FileStorageContainersRequestBuilderGetQueryParameters{
Filter: &requestFilter,
}
configuration := &graphstorage.FileStorageContainersRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
containers, err := graphClient.Storage().FileStorage().Containers().Get(context.Background(), configuration)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
FileStorageContainerCollectionResponse result = graphClient.storage().fileStorage().containers().get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082";
});
const options = {
authProvider,
};
const client = Client.init(options);
let containers = await client.api('/storage/fileStorage/containers')
.version('beta')
.filter('containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082')
.get();
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Storage\FileStorage\Containers\ContainersRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new ContainersRequestBuilderGetRequestConfiguration();
$queryParameters = ContainersRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->storage()->fileStorage()->containers()->get($requestConfiguration)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.storage.file_storage.containers.containers_request_builder import ContainersRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = ContainersRequestBuilder.ContainersRequestBuilderGetQueryParameters(
filter = "containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.storage.file_storage.containers.get(request_configuration = request_configuration)
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/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"
}
]
}