Skip to content

docs: add beginner Quickstart example to Blob README #41288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+69 −0
Open

docs: add beginner Quickstart example to Blob README #41288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions sdk/storage/azure-storage-blob/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,75 @@ or [Azure CLI](https://learn.microsoft.com/cli/azure/storage/account?view=azure-
az storage account show -n my-storage-account-name -g my-resource-group --query "primaryEndpoints.blob"
```

## Quickstart: Upload a Blob and List Files

The following is a minimal, fully working example for new users to verify their Azure Blob Storage setup.

This script demonstrates how to:

- Connect to Azure Blob Storage using a connection string
- Create a container if it does not exist
- Upload a text file to the container
- Retrieve and list all blobs (files) in the container

This is useful for validating installation, credentials, and access before building more advanced integrations.

> Prerequisites:
>
> - Python 3.8 or higher
> - An Azure Storage Account
> - A connection string from the Azure Portal
> (Navigate to your storage account → Access Keys → Copy "Connection string")
>
> Install the Azure Blob Storage SDK for Python:
>
> ```bash
> pip install azure-storage-blob
> ```

```python
from azure.storage.blob import BlobServiceClient

# Replace this with your connection string
connection_string = "your_connection_string_here"
container_name = "mycontainer"
blob_name = "example.txt"

# Connect to the Blob service
blob_service_client = BlobServiceClient.from_connection_string(connection_string)

# Create the container (if it doesn't exist)
try:
container_client = blob_service_client.get_container_client(container_name)
container_client.create_container()
except Exception:
print(f"Container '{container_name}' may already exist.")

# Create a file locally to upload
with open("example.txt", "w") as f:
f.write("Hello from Azure Blob Storage!")

# Upload the file
blob_client = blob_service_client.get_blob_client(container=container_name, blob=blob_name)
with open("example.txt", "rb") as data:
blob_client.upload_blob(data, overwrite=True)

print("✅ Upload successful.")

# List blobs in the container
print("📦 Files in the container:")
for blob in container_client.list_blobs():
print("-", blob.name)
```

This basic example is ideal for:

- Students and early-stage developers exploring Azure for the first time
- Data practitioners validating authentication and storage access
- Teams automating data workflows and needing a fast local-to-cloud file transfer

To learn more about using other credential types, SAS tokens, or asynchronous APIs, continue to the next section.

#### Types of credentials
The `credential` parameter may be provided in a number of different forms, depending on the type of
[authorization](https://learn.microsoft.com/azure/storage/common/storage-auth) you wish to use:
Expand Down
Loading