microsoft-agents-storage-blob 0.6.0.dev11__py3-none-any.whl

microsoft_agents/storage/blob/__init__.py

@@ -0,0 +1,4 @@
+from .blob_storage import BlobStorage
+from .blob_storage_config import BlobStorageConfig
+
+__all__ = ["BlobStorage", "BlobStorageConfig"]

microsoft_agents/storage/blob/blob_storage.py

@@ -0,0 +1,103 @@
+import json
+from typing import TypeVar, Union
+from io import BytesIO
+
+from azure.storage.blob.aio import (
+    ContainerClient,
+    BlobServiceClient,
+)
+
+from microsoft_agents.hosting.core.storage import StoreItem
+from microsoft_agents.hosting.core.storage.storage import AsyncStorageBase
+from microsoft_agents.hosting.core.storage._type_aliases import JSON
+from microsoft_agents.hosting.core.storage.error_handling import (
+    ignore_error,
+    is_status_code_error,
+)
+from microsoft_agents.storage.blob.errors import blob_storage_errors
+
+from .blob_storage_config import BlobStorageConfig
+
+StoreItemT = TypeVar("StoreItemT", bound=StoreItem)
+
+
+class BlobStorage(AsyncStorageBase):
+
+    def __init__(self, config: BlobStorageConfig):
+
+        if not config.container_name:
+            raise ValueError(str(blob_storage_errors.BlobContainerNameRequired))
+
+        self.config = config
+
+        blob_service_client: BlobServiceClient = self._create_client()
+        self._container_client: ContainerClient = (
+            blob_service_client.get_container_client(config.container_name)
+        )
+        self._initialized: bool = False
+
+    def _create_client(self) -> BlobServiceClient:
+        if self.config.url:  # connect with URL and credentials
+            if not self.config.credential:
+                raise ValueError(
+                    blob_storage_errors.InvalidConfiguration.format(
+                        "Credential is required when using a custom service URL"
+                    )
+                )
+            return BlobServiceClient(
+                account_url=self.config.url, credential=self.config.credential
+            )
+
+        else:  # connect with connection string
+            return BlobServiceClient.from_connection_string(
+                self.config.connection_string
+            )
+
+    async def initialize(self) -> None:
+        """Initializes the storage container"""
+        if not self._initialized:
+            # This should only happen once - assuming this is a singleton.
+            await ignore_error(
+                self._container_client.create_container(), is_status_code_error(409)
+            )
+            self._initialized = True
+
+    async def _read_item(
+        self, key: str, *, target_cls: StoreItemT = None, **kwargs
+    ) -> tuple[Union[str, None], Union[StoreItemT, None]]:
+        item = await ignore_error(
+            self._container_client.download_blob(blob=key),
+            is_status_code_error(404),
+        )
+        if not item:
+            return None, None
+
+        item_rep: str = await item.readall()
+        item_JSON: JSON = json.loads(item_rep)
+        try:
+            return key, target_cls.from_json_to_store_item(item_JSON)
+        except AttributeError as error:
+            raise TypeError(
+                f"BlobStorage.read_item(): could not deserialize blob item into {target_cls} class. Error: {error}"
+            )
+
+    async def _write_item(self, key: str, item: StoreItem) -> None:
+        item_JSON: JSON = item.store_item_to_json()
+        if item_JSON is None:
+            raise ValueError(
+                "BlobStorage.write(): StoreItem serialization cannot return None"
+            )
+        item_rep_bytes = json.dumps(item_JSON).encode("utf-8")
+
+        # getting the length is important for performance with large blobs
+        await self._container_client.upload_blob(
+            name=key,
+            data=BytesIO(item_rep_bytes),
+            overwrite=True,
+            length=len(item_rep_bytes),
+        )
+
+    async def _delete_item(self, key: str) -> None:
+        await ignore_error(
+            self._container_client.delete_blob(blob=key), is_status_code_error(404)
+        )

microsoft_agents/storage/blob/blob_storage_config.py

@@ -0,0 +1,28 @@
+from typing import Union
+
+from azure.core.credentials import TokenCredential
+
+
+class BlobStorageConfig:
+    """Configuration settings for BlobStorage."""
+
+    def __init__(
+        self,
+        container_name: str,
+        connection_string: str = "",
+        url: str = "",
+        credential: Union[TokenCredential, None] = None,
+    ):
+        """Configuration settings for BlobStorage.
+
+        container_name: The name of the blob container.
+        connection_string: The connection string to the storage account.
+        url: The URL of the blob service. If provided, credential must also be provided.
+        credential: The TokenCredential to use for authentication when using a custom URL.
+
+        credential-based authentication is prioritized over connection string authentication.
+        """
+        self.container_name: str = container_name
+        self.connection_string: str = connection_string
+        self.url: str = url
+        self.credential: Union[TokenCredential, None] = credential

microsoft_agents/storage/blob/errors/__init__.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+Error resources for Microsoft Agents Storage Blob package.
+"""
+
+from microsoft_agents.hosting.core.errors import ErrorMessage
+
+from .error_resources import BlobStorageErrorResources
+
+# Singleton instance
+blob_storage_errors = BlobStorageErrorResources()
+
+__all__ = ["ErrorMessage", "BlobStorageErrorResources", "blob_storage_errors"]

microsoft_agents/storage/blob/errors/error_resources.py

@@ -0,0 +1,42 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+Blob storage error resources for Microsoft Agents SDK.
+
+Error codes are in the range -61100 to -61199.
+"""
+
+from microsoft_agents.hosting.core.errors import ErrorMessage
+
+
+class BlobStorageErrorResources:
+    """
+    Error messages for blob storage operations.
+
+    Error codes are organized in the range -61100 to -61199.
+    """
+
+    BlobStorageConfigRequired = ErrorMessage(
+        "BlobStorage: BlobStorageConfig is required.",
+        -61100,
+    )
+
+    BlobConnectionStringOrUrlRequired = ErrorMessage(
+        "BlobStorage: either connection_string or container_url is required.",
+        -61101,
+    )
+
+    BlobContainerNameRequired = ErrorMessage(
+        "BlobStorage: container_name is required.",
+        -61102,
+    )
+
+    InvalidConfiguration = ErrorMessage(
+        "Invalid configuration: {0}",
+        -61103,
+    )
+
+    def __init__(self):
+        """Initialize BlobStorageErrorResources."""
+        pass

microsoft_agents_storage_blob-0.6.0.dev11.dist-info/METADATA

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-storage-blob
+Version: 0.6.0.dev11
+Summary: A blob storage library for Microsoft Agents
+Author: Microsoft Corporation
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: microsoft-agents-hosting-core==0.6.0.dev11
+Requires-Dist: azure-core
+Requires-Dist: azure-storage-blob
+Dynamic: license-file
+Dynamic: requires-dist
+
+# Microsoft Agents Storage - Blob
+
+[![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/)
+
+Azure Blob Storage integration for Microsoft 365 Agents SDK. This library provides persistent storage for conversation state, user data, and custom agent information using Azure Blob Storage.
+
+This library implements the storage interface for the Microsoft 365 Agents SDK using Azure Blob Storage as the backend. It enables your agents to persist conversation state, user preferences, and custom data across sessions. Perfect for production deployments where you need reliable, scalable cloud storage.
+
+# What is this?
+This library is part of the **Microsoft 365 Agents SDK for Python** - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.
+
+## Release Notes
+<table style="width:100%">
+  <tr>
+    <th style="width:20%">Version</th>
+    <th style="width:20%">Date</th>
+    <th style="width:60%">Release Notes</th>
+  </tr>
+  <tr>
+    <td>0.5.0</td>
+    <td>2025-10-22</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md">
+        0.5.0 Release Notes
+      </a>
+    </td>
+  </tr>
+</table>
+
+## Packages Overview
+
+We offer the following PyPI packages to create conversational experiences based on Agents:
+
+| Package Name | PyPI Version | Description |
+|--------------|-------------|-------------|
+| `microsoft-agents-activity` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-activity)](https://pypi.org/project/microsoft-agents-activity/) | Types and validators implementing the Activity protocol spec. |
+| `microsoft-agents-hosting-core` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-core)](https://pypi.org/project/microsoft-agents-hosting-core/) | Core library for Microsoft Agents hosting. |
+| `microsoft-agents-hosting-aiohttp` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-aiohttp)](https://pypi.org/project/microsoft-agents-hosting-aiohttp/) | Configures aiohttp to run the Agent. |
+| `microsoft-agents-hosting-teams` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-teams)](https://pypi.org/project/microsoft-agents-hosting-teams/) | Provides classes to host an Agent for Teams. |
+| `microsoft-agents-storage-blob` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/) | Extension to use Azure Blob as storage. |
+| `microsoft-agents-storage-cosmos` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-cosmos)](https://pypi.org/project/microsoft-agents-storage-cosmos/) | Extension to use CosmosDB as storage. |
+| `microsoft-agents-authentication-msal` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-authentication-msal)](https://pypi.org/project/microsoft-agents-authentication-msal/) | MSAL-based authentication for Microsoft Agents. |
+
+Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:
+
+| Package Name | PyPI Version | Description |
+|--------------|-------------|-------------|
+| `microsoft-agents-copilotstudio-client` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-copilotstudio-client)](https://pypi.org/project/microsoft-agents-copilotstudio-client/) | Direct to Engine client to interact with Agents created in CopilotStudio |
+
+## Installation
+
+```bash
+pip install microsoft-agents-storage-blob
+```
+
+**Benefits:**
+- ✅ No secrets in code
+- ✅ Managed Identity support
+- ✅ Automatic token renewal
+- ✅ Fine-grained access control via Azure RBAC
+
+### Configuration Parameters
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `container_name` | `str` | Yes | Name of the blob container to use |
+| `connection_string` | `str` | No* | Storage account connection string |
+| `url` | `str` | No* | Blob service URL (e.g., `https://account.blob.core.windows.net`) |
+| `credential` | `TokenCredential` | No** | Azure credential for authentication |
+
+*Either `connection_string` OR (`url` + `credential`) must be provided  
+**Required when using `url`
+
+
+### Azure Managed Identity
+
+When running in Azure (App Service, Functions, Container Apps), use Managed Identity:
+
+```python
+from azure.identity import ManagedIdentityCredential
+
+config = BlobStorageConfig(
+    container_name="agent-storage",
+    url="https://myaccount.blob.core.windows.net",
+    credential=ManagedIdentityCredential()
+)
+```
+
+**Azure RBAC Roles Required:**
+- `Storage Blob Data Contributor` - For read/write access
+- `Storage Blob Data Reader` - For read-only access
+
+**Benefits of switching to BlobStorage:**
+- ✅ Data persists across restarts
+- ✅ Scalable to millions of items
+- ✅ Multi-instance support (load balancing)
+- ✅ Automatic backups and geo-replication
+- ✅ Built-in monitoring and diagnostics
+
+## Best Practices
+
+1. **Use Token Authentication in Production** - Avoid storing connection strings; use Managed Identity or DefaultAzureCredential
+2. **Initialize Once** - Call `storage.initialize()` during app startup, not on every request
+3. **Implement Retry Logic** - Handle transient failures with exponential backoff
+4. **Monitor Performance** - Use Azure Monitor to track storage operations
+5. **Set Lifecycle Policies** - Configure automatic cleanup of old data in Azure Portal
+6. **Use Consistent Naming** - Establish key naming conventions (e.g., `user:{id}`, `conversation:{id}`)
+7. **Batch Operations** - Read/write multiple items together when possible
+
+## Key Classes Reference
+
+- **`BlobStorage`** - Main storage implementation using Azure Blob Storage
+- **`BlobStorageConfig`** - Configuration settings for connection and authentication
+- **`StoreItem`** - Base class for data models (inherit to create custom types)
+
+# Quick Links
+
+- 📦 [All SDK Packages on PyPI](https://pypi.org/search/?q=microsoft-agents)
+- 📖 [Complete Documentation](https://aka.ms/agents)
+- 💡 [Python Samples Repository](https://github.com/microsoft/Agents/tree/main/samples/python)
+- 🐛 [Report Issues](https://github.com/microsoft/Agents-for-python/issues)
+
+# Sample Applications
+
+|Name|Description|README|
+|----|----|----|
+|Quickstart|Simplest agent|[Quickstart](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/README.md)|
+|Auto Sign In|Simple OAuth agent using Graph and GitHub|[auto-signin](https://github.com/microsoft/Agents/blob/main/samples/python/auto-signin/README.md)|
+|OBO Authorization|OBO flow to access a Copilot Studio Agent|[obo-authorization](https://github.com/microsoft/Agents/blob/main/samples/python/obo-authorization/README.md)|
+|Semantic Kernel Integration|A weather agent built with Semantic Kernel|[semantic-kernel-multiturn](https://github.com/microsoft/Agents/blob/main/samples/python/semantic-kernel-multiturn/README.md)|
+|Streaming Agent|Streams OpenAI responses|[azure-ai-streaming](https://github.com/microsoft/Agents/blob/main/samples/python/azureai-streaming/README.md)|
+|Copilot Studio Client|Console app to consume a Copilot Studio Agent|[copilotstudio-client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/README.md)|
+|Cards Agent|Agent that uses rich cards to enhance conversation design |[cards](https://github.com/microsoft/Agents/blob/main/samples/python/cards/README.md)|

microsoft_agents_storage_blob-0.6.0.dev11.dist-info/RECORD

@@ -0,0 +1,10 @@
+microsoft_agents/storage/blob/__init__.py,sha256=5IxnH_hkyJrp5Gdk92cfK78d39m_DAEyjX-iFr9g1Do,137
+microsoft_agents/storage/blob/blob_storage.py,sha256=oVIiXIVQ64csXZtCCCa6Gj4fCcyStPoUlH40tA2W-_I,3692
+microsoft_agents/storage/blob/blob_storage_config.py,sha256=wKK7WJAdy4FIIx5HCVIDNecPefZB5Hy6jM82gKdCBF8,1009
+microsoft_agents/storage/blob/errors/__init__.py,sha256=NwwZ_tWm6azLlfZ-HtGN7Mmt-Hc-npivp4c77X69GXs,433
+microsoft_agents/storage/blob/errors/error_resources.py,sha256=NQbiy51rmy0HqTBHGtV28KSP-EvNAIsT1kUqqILM9ug,1023
+microsoft_agents_storage_blob-0.6.0.dev11.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+microsoft_agents_storage_blob-0.6.0.dev11.dist-info/METADATA,sha256=ARw7KKbws5SM5aQSD25ZNlhyM7SS2iognH_Fc3p28o8,8483
+microsoft_agents_storage_blob-0.6.0.dev11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microsoft_agents_storage_blob-0.6.0.dev11.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
+microsoft_agents_storage_blob-0.6.0.dev11.dist-info/RECORD,,

microsoft_agents_storage_blob-0.6.0.dev11.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

microsoft_agents_storage_blob-0.6.0.dev11.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

microsoft_agents_storage_blob-0.6.0.dev11.dist-info/top_level.txt

@@ -0,0 +1 @@
+microsoft_agents