Azure: Blob Storage =================== ******** Overview ******** `Azure Blob Storage `_ is a cloud file storage system that uses storage accounts to organize containers (similar to "buckets" for other storage providers) in which to store arbitrary files referred to as 'blobs'. This Parsons integration currently only implements `block blobs, not page or append blobs `_. .. note:: Authentication This connector requires authentication credentials for an Azure Blob Storage storage account. The ``azure-storage-blob`` library is used for this connector, and examples of how to create and use `multiple types of credentials `_ are included in the documentation. ********** Quickstart ********** This class requires a ``credentials`` argument and *either* an ``account_name`` or an ``account_url`` argument that includes the account name. You can store these as environmental variables (``AZURE_CREDENTIAL``, ``AZURE_ACCOUNT_NAME``, and ``AZURE_ACCOUNT_URL``, respectively) or pass them in as arguments: **Instantiate class** .. code-block:: python from parsons import AzureBlobStorage # First approach: Use API credentials via environmental variables azure_blob = AzureBlobStorage() # Second approach: Pass API credentials as arguments azure_blob = AzureBlobStorage(account_name='my_account_name', credential='1234') **List containers and blobs** .. code-block:: python # Get all container names for a storage account container_names = azure_blob.list_containers() # Get all blob names for a storage account and container blob_names = azure_blob.list_blobs(container_names[0]) **Create a blob from a file or Table** .. code-block:: python # Upload a CSV file from a local file path and set the content type azure_blob.put_blob('blob_name', 'test1.csv', './test1.csv', content_type='text/csv') # Create a Table and upload it as a JSON blob table = Table([{'first': 'Test', 'last': 'Person'}]) azure_blob.upload_table(table, 'blob_name', 'test2.json', data_type='json') **Download a blob** .. code-block:: python # Download to a temporary file path temp_file_path = azure_blob.download_blob('blob_name', 'test.csv') # Download to a specific file path azure_blob.download_blob('blob_name', 'test.csv', local_path='/tmp/test.csv') *** API *** .. autoclass:: parsons.AzureBlobStorage :inherited-members: