file package

Packages

aio

Modules

directory_client
file_client
file_service_client
models
share_client
version

Classes

FileClient

A client to interact with a specific file, although that file may not yet exist.

DirectoryClient

A client to interact with a specific directory, although it may not yet exist.

For operations relating to a specific subdirectory or file in this share, the clients for those entities can also be retrieved using the get_subdirectory_client and get_file_client functions.s

ShareClient

A client to interact with a specific share, although that share may not yet exist.

For operations relating to a specific directory or file in this share, the clients for those entities can also be retrieved using the get_directory_client and get_file_client functions.

FileServiceClient

A client to interact with the File Service at the account level.

This client provides operations to retrieve and configure the account properties as well as list, create and delete shares within the account. For operations relating to a specific share, a client for that entity can also be retrieved using the get_share_client function.

ExponentialRetry

Exponential retry.

LinearRetry

Linear retry.

NoRetry
LocationMode

Specifies the location the request should be sent to. This mode only applies for RA-GRS accounts which allow secondary read access. All other account types must use PRIMARY.

ResourceTypes

Specifies the resource types that are accessible with the account SAS.

AccountPermissions

ResourceTypes class to be used with generate_shared_access_signature method and for the AccessPolicies used with set_*_acl. There are two types of SAS which may be used to grant resource access. One is to grant access to a specific resource (resource-specific). Another is to grant access to the entire service for a specific account and allow certain operations based on perms found here.

StorageErrorCode

An enumeration.

Metrics

A summary of request statistics grouped by API in hour or minute aggregates for files.

All required parameters must be populated in order to send to Azure.

RetentionPolicy

The retention policy which determines how long the associated data should persist.

All required parameters must be populated in order to send to Azure.

CorsRule

CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.

All required parameters must be populated in order to send to Azure.

AccessPolicy

Access Policy class used by the set and get acl methods in each service.

A stored access policy can specify the start time, expiry time, and permissions for the Shared Access Signatures with which it's associated. Depending on how you want to control access to your resource, you can specify all of these parameters within the stored access policy, and omit them from the URL for the Shared Access Signature. Doing so permits you to modify the associated signature's behavior at any time, as well as to revoke it. Or you can specify one or more of the access policy parameters within the stored access policy, and the others on the URL. Finally, you can specify all of the parameters on the URL. In this case, you can use the stored access policy to revoke the signature, but not to modify its behavior.

Together the Shared Access Signature and the stored access policy must include all fields required to authenticate the signature. If any required fields are missing, the request will fail. Likewise, if a field is specified both in the Shared Access Signature URL and in the stored access policy, the request will fail with status code 400 (Bad Request).

FilePermissions

FilePermissions class to be used with generating shared access signature operations.

SharePermissions

SharePermissions class to be used to be used with generating shared access signature and access policy operations.

ShareProperties

Share's properties class.

SharePropertiesPaged

An iterable of Share properties.

DirectoryProperties

Directory's properties class.

DirectoryPropertiesPaged

An iterable for the contents of a directory.

This iterable will yield dicts for the contents of the directory. The dicts will have the keys 'name' (str) and 'is_directory' (bool). Items that are files (is_directory=False) will have an additional 'content_length' key.

FileProperties

File's properties class.

ContentSettings

Used to store the content settings of a file.

Handle

A listed Azure Storage handle item.

All required parameters must be populated in order to send to Azure.

HandlesPaged

An iterable of Handles.

NTFSAttributes

Valid set of attributes to set for file or directory. To set attribute for directory, 'Directory' should always be enabled except setting 'None' for directory.