azure-storage-file-share-py

用途

该技能用于通过 Python 的 Azure Storage File Share SDK 管理 Azure 云上的 SMB 文件共享，适用于云原生应用以及迁移上云（lift-and-shift）的场景。可执行账户级、共享级、目录级和文件级的操作。

安装与环境变量

安装命令：

pip install azure-storage-file-share

环境变量：

AZURE_STORAGE_CONNECTION_STRING=DefaultEndpointsProtocol=https;AccountName=...;AccountKey=...
# Or
AZURE_STORAGE_ACCOUNT_URL=https://<account>.file.core.windows.net

认证方式

连接字符串：

from azure.storage.fileshare import ShareServiceClient

service = ShareServiceClient.from_connection_string(
    os.environ["AZURE_STORAGE_CONNECTION_STRING"]
)

Entra ID：

from azure.storage.fileshare import ShareServiceClient
from azure.identity import DefaultAzureCredential

service = ShareServiceClient(
    account_url=os.environ["AZURE_STORAGE_ACCOUNT_URL"],
    credential=DefaultAzureCredential()
)

共享操作

创建共享：

share = service.create_share("my-share")

列出共享：

for share in service.list_shares():
    print(f"{share.name}: {share.quota} GB")

获取共享客户端：

share_client = service.get_share_client("my-share")

删除共享：

service.delete_share("my-share")

目录操作

创建目录：

share_client = service.get_share_client("my-share")
share_client.create_directory("my-directory")

# Nested directory
share_client.create_directory("my-directory/sub-directory")

列出目录与文件：

directory_client = share_client.get_directory_client("my-directory")

for item in directory_client.list_directories_and_files():
    if item["is_directory"]:
        print(f"[DIR] {item['name']}")
    else:
        print(f"[FILE] {item['name']} ({item['size']} bytes)")

删除目录：

share_client.delete_directory("my-directory")

文件操作

上传文件：

file_client = share_client.get_file_client("my-directory/file.txt")

# From string
file_client.upload_file("Hello, World!")

# From file
with open("local-file.txt", "rb") as f:
    file_client.upload_file(f)

# From bytes
file_client.upload_file(b"Binary content")

下载文件：

file_client = share_client.get_file_client("my-directory/file.txt")

# To bytes
data = file_client.download_file().readall()

# To file
with open("downloaded.txt", "wb") as f:
    data = file_client.download_file()
    data.readinto(f)

# Stream chunks
download = file_client.download_file()
for chunk in download.chunks():
    process(chunk)

获取文件属性：

properties = file_client.get_file_properties()
print(f"Size: {properties.size}")
print(f"Content type: {properties.content_settings.content_type}")
print(f"Last modified: {properties.last_modified}")

删除文件：

file_client.delete_file()

复制文件：

source_url = "https://account.file.core.windows.net/share/source.txt"
dest_client = share_client.get_file_client("destination.txt")
dest_client.start_copy_from_url(source_url)

范围（Range）操作

上传范围：

# Upload to specific range
file_client.upload_range(data=b"content", offset=0, length=7)

下载范围：

# Download specific range
download = file_client.download_file(offset=0, length=100)
data = download.readall()

快照操作

创建快照：

snapshot = share_client.create_snapshot()
print(f"Snapshot: {snapshot['snapshot']}")

访问快照：

snapshot_client = service.get_share_client(
    "my-share",
    snapshot=snapshot["snapshot"]
)

异步客户端

from azure.storage.fileshare.aio import ShareServiceClient
from azure.identity.aio import DefaultAzureCredential

async def upload_file():
    credential = DefaultAzureCredential()
    service = ShareServiceClient(account_url, credential=credential)

    share = service.get_share_client("my-share")
    file_client = share.get_file_client("test.txt")

    await file_client.upload_file("Hello!")

    await service.close()
    await credential.close()

客户端类型

Client	Purpose
ShareServiceClient	Account-level operations
ShareClient	Share operations
ShareDirectoryClient	Directory operations
ShareFileClient	File operations

最佳实践

使用连接字符串进行最简单的设置
在生产环境中配合 RBAC 使用 Entra ID
使用 chunks() 流式处理大文件，避免内存问题
在进行重大更改前创建快照
设置配额以防止意外的存储成本
使用范围（Range）进行部分文件更新
显式关闭异步客户端

适用场景与限制

当任务明确匹配上述范围时适用。请勿将输出视为环境特定验证、测试或专家审查的替代品。如果缺少必需的输入、权限、安全边界或成功标准，应停止并请求澄清。