Skip to content

Commit 035d371

Browse files
committed
Update docs metadata
1 parent 232893a commit 035d371

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

docs-ref-services/latest/storage-blob-readme.md

+21-18
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Azure Storage Blobs client library for Python
33
keywords: Azure, python, SDK, API, azure-storage-blob, storage
44
author: annatisch
55
ms.author: antisch
6-
ms.date: 08/04/2022
6+
ms.date: 10/11/2022
77
ms.topic: reference
88
ms.devlang: python
99
ms.service: storage
1010
---
11-
# Azure Storage Blobs client library for Python - Version 12.13.1
11+
# Azure Storage Blobs client library for Python - version 12.14.0
1212

1313
Azure Blob storage is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data, such as text or binary data.
1414

@@ -20,13 +20,13 @@ Blob storage is ideal for:
2020
* Storing data for backup and restore, disaster recovery, and archiving
2121
* Storing data for analysis by an on-premises or Azure-hosted service
2222

23-
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/azure/storage/blob) | [Package (PyPI)](https://pypi.org/project/azure-storage-blob/) | [API reference documentation](https://aka.ms/azsdk-python-storage-blob-ref) | [Product documentation](/azure/storage/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples)
23+
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/azure/storage/blob) | [Package (PyPI)](https://pypi.org/project/azure-storage-blob/) | [API reference documentation](https://aka.ms/azsdk-python-storage-blob-ref) | [Product documentation](/azure/storage/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples)
2424

2525

2626
## Getting started
2727

2828
### Prerequisites
29-
* Python 3.6 or later is required to use this package.
29+
* Python 3.7 or later is required to use this package. For more details, please read our page on [Azure SDK for Python version support policy](https://github.com/Azure/azure-sdk-for-python/wiki/Azure-SDKs-Python-version-support-policy).
3030
* You must have an [Azure subscription](https://azure.microsoft.com/free/) and an
3131
[Azure storage account](/azure/storage/common/storage-account-overview) to use this package.
3232

@@ -80,12 +80,12 @@ The `credential` parameter may be provided in a number of different forms, depen
8080
[authorization](/azure/storage/common/storage-auth) you wish to use:
8181
1. To use an [Azure Active Directory (AAD) token credential](/azure/storage/common/storage-auth-aad),
8282
provide an instance of the desired credential type obtained from the
83-
[azure-identity](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/identity/azure-identity#credentials) library.
84-
For example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/identity/azure-identity#defaultazurecredential)
83+
[azure-identity](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/identity/azure-identity#credentials) library.
84+
For example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/identity/azure-identity#defaultazurecredential)
8585
can be used to authenticate the client.
8686

8787
This requires some initial setup:
88-
* [Install azure-identity](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/identity/azure-identity#install-the-package)
88+
* [Install azure-identity](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/identity/azure-identity#install-the-package)
8989
* [Register a new AAD application](/azure/active-directory/develop/quickstart-register-app) and give permissions to access Azure Storage
9090
* [Grant access](/azure/storage/common/storage-auth-aad-rbac-portal) to Azure Blob data with RBAC in the Azure Portal
9191
* Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
@@ -196,7 +196,7 @@ Four different clients are provided to interact with the various components of t
196196
This library includes a complete async API supported on Python 3.5+. To use it, you must
197197
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
198198
See
199-
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-blob_12.13.1/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
199+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-blob_12.14.0/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
200200
for more information.
201201

202202
Async clients and credentials should be closed when they're no longer needed. These
@@ -358,7 +358,10 @@ Other optional configuration keyword arguments that can be specified on the clie
358358
**Client keyword arguments:**
359359

360360
* __connection_timeout__ (int): The number of seconds the client will wait to establish a connection to the server.
361-
* __read_timeout__ (int): The number of seconds the client will wait, after the connections has been established, for the server to send a response.
361+
Defaults to 20 seconds.
362+
* __read_timeout__ (int): The number of seconds the client will wait, between consecutive read operations, for a
363+
response from the server. This is a socket level timeout and is not affected by overall data size. Client-side read
364+
timeouts will be automatically retried. Defaults to 60 seconds.
362365
* __transport__ (Any): User-provided transport to send the HTTP request.
363366

364367
**Per-operation keyword arguments:**
@@ -375,7 +378,7 @@ the client level to enable it for all requests.
375378

376379
## Troubleshooting
377380
### General
378-
Storage Blob clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-blob_12.13.1/sdk/core/azure-core/README.md).
381+
Storage Blob clients raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/azure-storage-blob_12.14.0/sdk/core/azure-core/README.md).
379382

380383
This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use the `error_code` attribute, i.e, `exception.error_code`.
381384

@@ -414,34 +417,34 @@ service_client.get_service_stats(logging_enable=True)
414417

415418
### More sample code
416419

417-
Get started with our [Blob samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples).
420+
Get started with our [Blob samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples).
418421

419422
Several Storage Blobs Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Storage Blobs:
420423

421-
* [blob_samples_container_access_policy.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_container_access_policy.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_container_access_policy_async.py)) - Examples to set Access policies:
424+
* [blob_samples_container_access_policy.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_container_access_policy.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_container_access_policy_async.py)) - Examples to set Access policies:
422425
* Set up Access Policy for container
423426

424-
* [blob_samples_hello_world.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_hello_world.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_hello_world_async.py)) - Examples for common Storage Blob tasks:
427+
* [blob_samples_hello_world.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_hello_world.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_hello_world_async.py)) - Examples for common Storage Blob tasks:
425428
* Set up a container
426429
* Create a block, page, or append blob
427430
* Upload blobs
428431
* Download blobs
429432
* Delete blobs
430433

431-
* [blob_samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_authentication_async.py)) - Examples for authenticating and creating the client:
434+
* [blob_samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_authentication_async.py)) - Examples for authenticating and creating the client:
432435
* From a connection string
433436
* From a shared access key
434437
* From a shared access signature token
435438
* From active directory
436439

437-
* [blob_samples_service.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_service.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_service_async.py)) - Examples for interacting with the blob service:
440+
* [blob_samples_service.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_service.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_service_async.py)) - Examples for interacting with the blob service:
438441
* Get account information
439442
* Get and set service properties
440443
* Get service statistics
441444
* Create, list, and delete containers
442445
* Get the Blob or Container client
443446

444-
* [blob_samples_containers.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_containers.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_containers_async.py)) - Examples for interacting with containers:
447+
* [blob_samples_containers.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_containers.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_containers_async.py)) - Examples for interacting with containers:
445448
* Create a container and delete containers
446449
* Set metadata on containers
447450
* Get container properties
@@ -450,15 +453,15 @@ Several Storage Blobs Python SDK samples are available to you in the SDK's GitHu
450453
* Upload, list, delete blobs in container
451454
* Get the blob client to interact with a specific blob
452455

453-
* [blob_samples_common.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_common.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_common_async.py)) - Examples common to all types of blobs:
456+
* [blob_samples_common.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_common.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_common_async.py)) - Examples common to all types of blobs:
454457
* Create a snapshot
455458
* Delete a blob snapshot
456459
* Soft delete a blob
457460
* Undelete a blob
458461
* Acquire a lease on a blob
459462
* Copy a blob from a URL
460463

461-
* [blob_samples_directory_interface.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.13.1/sdk/storage/azure-storage-blob/samples/blob_samples_directory_interface.py) - Examples for interfacing with Blob storage as if it were a directory on a filesystem:
464+
* [blob_samples_directory_interface.py](https://github.com/Azure/azure-sdk-for-python/tree/azure-storage-blob_12.14.0/sdk/storage/azure-storage-blob/samples/blob_samples_directory_interface.py) - Examples for interfacing with Blob storage as if it were a directory on a filesystem:
462465
* Copy (upload or download) a single file or directory
463466
* List files or directories at a single level or recursively
464467
* Delete a single file or recursively delete a directory
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-storage-blob",
3-
"Version": "12.13.1",
3+
"Version": "12.14.0",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/storage/azure-storage-blob",
66
"ServiceDirectory": "storage",
@@ -10,5 +10,5 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-storage-blob",
13-
"ReleaseStatus": "2022-08-04"
13+
"ReleaseStatus": "2022-10-11"
1414
}

0 commit comments

Comments
 (0)