| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
MSAzureAPI.StorageServices.FileService
Contents
Description
StorageServices.FileService
authorize with AD : https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-azure-active-directory
permissions for calling data operations : https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-azure-active-directory#permissions-for-calling-data-operations
Synopsis
- getFile :: Text -> Text -> Text -> AccessToken -> Req ByteString
- listDirectoriesAndFiles :: Text -> Text -> Text -> Maybe Text -> AccessToken -> Req (Either String DirItems)
- listDirectoriesAndFilesC :: (MonadIO m, MonadThrow m) => Text -> Text -> Text -> AccessToken -> ConduitT i [DirItem] m ()
- data DirItems = DirItems {
- disItems :: [DirItem]
- disResponseMarker :: Maybe Text
- data DirItem
- data FSException
Files
Arguments
| :: Text | storage account |
| -> Text | file share |
| -> Text | filepath, including directories |
| -> AccessToken | |
| -> Req ByteString |
get file https://learn.microsoft.com/en-us/rest/api/storageservices/get-file#request
GET https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile
Directories
listDirectoriesAndFiles Source #
Arguments
| :: Text | storage account |
| -> Text | file share |
| -> Text | directory path, including directories |
| -> Maybe Text | next page marker. Use |
| -> AccessToken | |
| -> Req (Either String DirItems) |
list directories and files https://learn.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files#request
NB the the response list contains at most 5000 elements
GET https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list
Paginated results
NB : The Marker, ShareSnapshot, and MaxResults elements are present only if you specify them on the request URI.
If the NextMarker element in the XML body has a value, it means that the result list is not complete. In that case
listDirectoriesAndFilesC Source #
Arguments
| :: (MonadIO m, MonadThrow m) | |
| => Text | storage account |
| -> Text | file share |
| -> Text | directory path, including directories |
| -> AccessToken | |
| -> ConduitT i [DirItem] m () |
Repeated call of listDirectoriesAndFiles supporting multi-page results
throws FSException if something goes wrong
Items in the listDirectoriesAndFiles response
Directory item, as returned by listDirectoriesAndFiles
Constructors
| DIFile | file |
| DIDirectory | directory |
Common types
data FSException Source #
Constructors
| FSXMLParsingE String | |
| FSHttpE HttpException |
Instances
| Exception FSException Source # | |
Defined in MSAzureAPI.StorageServices.FileService Methods toException :: FSException -> SomeException # fromException :: SomeException -> Maybe FSException # displayException :: FSException -> String # | |
| Show FSException Source # | |
Defined in MSAzureAPI.StorageServices.FileService Methods showsPrec :: Int -> FSException -> ShowS # show :: FSException -> String # showList :: [FSException] -> ShowS # | |