AzureFileDatastore Class
Represents a datastore that saves connection information to Azure File storage.
You should not work with this class directly. To create a datastore of this type, use the register_azure_file_share method of Datastore.
Note: When using a datastore to access data, you must have permission to access that data, which depends on the credentials registered with the datastore.
Initialize a new Azure File Share Datastore.
- Inheritance
-
AzureFileDatastore
Constructor
AzureFileDatastore(workspace, name, container_name, account_name, sas_token=None, account_key=None, protocol=None, endpoint='core.windows.net', request_session=None)
Parameters
- sas_token
- str, <xref:optional>
The SAS token for accessing this container. The default is None.
- protocol
- str, <xref:optional>
The protocol to use to connect to the storage account. If None, defaults to https.
- endpoint
- str, <xref:optional>
The endpoint of the blob container. If None, defaults to core.windows.net.
- request_session
- <xref:requests.sessions.Session>, <xref:optional>
The session object to use for http requests. The default is None.
- sas_token
- str, <xref:optional>
The SAS token for accessing this container. The default is None.
- protocol
- str, <xref:optional>
The protocol to use to connect to the storage account. If None, defaults to https.
- endpoint
- str, <xref:optional>
The endpoint of the blob container. If None, defaults to core.windows.net.
- request_session
- <xref:requests.sessions.Session>, <xref:optional>
The session object to use for http requests. The default is None.
Methods
download |
Download the data from the file share to the local file system. |
upload |
Upload the data from the local file system to the file share this datastore points to. Note: For this method to work, the datastore object must have either account key or SAS
token property populated. If datastore object doesn't contain any form of credential, this
method will fail.
Moreover, this method has been deprecated, may be removed in future. We suggest that you use
the |
upload_files |
Upload the data from the local file system to the file share this datastore points to. Note: This method is deprecated and will no longer be supported. Recommend to use
|
download
Download the data from the file share to the local file system.
download(target_path, prefix=None, overwrite=False, show_progress=True)
Parameters
- prefix
- str, <xref:optional>
The path to the folder in the file share to download. If set to None, Azure Machine Learning will download everything in the file share.
- show_progress
- bool, <xref:optional>
Indicates whether to show the progress of download in the console.
Returns
The number of files successfully downloaded.
Return type
upload
Upload the data from the local file system to the file share this datastore points to.
Note: For this method to work, the datastore object must have either account key or SAS
token property populated. If datastore object doesn't contain any form of credential, this
method will fail.
Moreover, this method has been deprecated, may be removed in future. We suggest that you use
the Dataset.File.upload_directory
method to upload your files from local directory and
create FileDataset in a single method call.
upload(src_dir, target_path=None, overwrite=False, show_progress=True)
Parameters
- show_progress
- bool, <xref:optional>
Indicates whether to show the progress of upload in the console.
Returns
The DataReference instance for the target path uploaded.
Return type
upload_files
Upload the data from the local file system to the file share this datastore points to.
Note: This method is deprecated and will no longer be supported. Recommend to use
FileDatasetFactory.upload_directory
instead.
upload_files(files, relative_root=None, target_path=None, overwrite=False, show_progress=True)
Parameters
- relative_root
- str, <xref:optional>
The base path used to determine the path
of the files in the file share. For example, if you upload /path/to/file.txt, and you define
base path to be /path, when file.txt is uploaded to the file share, it will have
the path of /to/file.txt. If target_path
is also specified, then it will be used as
the prefix for the derived path from above. The base path must be a common path of
all of the files, otherwise an exception will be thrown. The default is None, which will find
the common path.
- target_path
- str, <xref:optional>
The location in the file share to upload the data to. The default is None, the root.
- show_progress
- bool, <xref:optional>
Indicates whether to show the progress of upload in the console.
Returns
The DataReference instance for the target path uploaded.
Return type
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for