通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

使用 Go 管理容器属性和元数据

  • 项目

除 Blob 容器包含的数据外，它们还支持系统属性和用户定义的元数据。 本文介绍如何使用适用于 Go 的 Azure 存储客户端模块管理系统属性和用户定义的元数据。

先决条件

设置你的环境

如果没有现有项目，请查看本部分，其中介绍了如何设置项目来使用适用于 Go 的 Azure Blob 存储客户端模块。 步骤包括模块安装、添加 import 路径以及创建授权的客户端对象。 有关详细信息，请参阅 Azure Blob 存储和 Go 入门。

安装模块

使用以下命令安装 azblob 模块：

go get github.com/Azure/azure-sdk-for-go/sdk/storage/azblob

若要使用 Microsoft Entra ID 进行身份验证（建议），请使用以下命令安装 azidentity 模块：

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity

添加导入路径

在代码文件中添加以下导入路径：

import (
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
)

这些导入路径代表了开始之前需要满足的最低要求。 本文中的某些代码示例可能需要其他导入路径。 有关具体详细信息和示例用法，请参阅代码示例。

创建客户端对象

若要将应用连接到 Blob 存储，请使用 azblob.NewClient 创建客户端对象。 以下示例演示如何使用 DefaultAzureCredential 创建客户端对象进行授权：

func getServiceClientTokenCredential(accountURL string) *azblob.Client {
    // Create a new service client with token credential
    credential, err := azidentity.NewDefaultAzureCredential(nil)
    handleError(err)

    client, err := azblob.NewClient(accountURL, credential, nil)
    handleError(err)

    return client
}

授权

授权机制必须具有处理容器属性或元数据所需的权限。 若要使用 Microsoft Entra ID 进行授权（建议），需具有 Azure RBAC 内置角色“存储 Blob 数据读取者”或更高级别的角色以便能够执行获取操作，并具有“存储 Blob 数据参与者”或更高级别的角色以便能够执行设置操作。 有关详细信息，请参阅获取容器属性 (REST API)、设置容器元数据 (REST API) 或获取容器元数据 (REST API) 的授权指南。

关于属性和元数据

  • 系统属性：每个 Blob 存储资源上都存在系统属性。 其中一些属性是可以读取或设置的，而另一些属性是只读的。 部分系统属性在“幕后”是与某些标准 HTTP 标头对应的。 适用于 Go 的 Azure 存储客户端库将为你维护这些属性。

  • 用户定义的元数据：用户定义元数据包含一个或多个你为 Blob 存储资源指定的名称/值对对。 可以使用元数据存储资源的其他值。 元数据值仅用于你自己的目的，不会影响资源的行为方式。

    元数据名称/值对是有效的 HTTP 标头，因此应当遵循所有控制 HTTP 标头的限制。 有关元数据命名要求的详细信息，请参阅元数据名称。

检索容器属性

若要检索容器属性，请从容器客户端对象调用以下方法：

以下代码示例提取容器的系统属性并将一些属性值写入控制台窗口：

func getContainerProperties(client *azblob.Client, containerName string) {
    // Reference the container as a client object
    containerClient := client.ServiceClient().NewContainerClient(containerName)

    // Get the container properties
    resp, err := containerClient.GetProperties(context.TODO(), nil)
    handleError(err)

    // Print the container properties
    fmt.Printf("Blob public access: %v\n", *resp.BlobPublicAccess)
    fmt.Printf("Lease status: %v\n", *resp.LeaseStatus)
    fmt.Printf("Lease state: %v\n", *resp.LeaseState)
    fmt.Printf("Has immutability policy: %v\n", *resp.HasImmutabilityPolicy)
}

设置和检索元数据

可将元数据指定为 Blob 或容器资源上的一个或多个名称/值对。 若要设置元数据，请从容器客户端对象调用以下方法：

设置容器元数据将覆盖与容器关联的所有现有元数据。 无法修改单个名称-值对。

以下代码示例设置容器上的元数据：

func setContainerMetadata(client *azblob.Client, containerName string) {
    // Reference the container as a client object
    containerClient := client.ServiceClient().NewContainerClient(containerName)

    // Set the container metadata
    var metadata = make(map[string]*string)
    metadata["key1"] = to.Ptr("value1")
    metadata["key2"] = to.Ptr("value2")

    _, err := containerClient.SetMetadata(context.TODO(), nil)
    handleError(err)
}

若要检索元数据，请从容器客户端对象调用以下方法：

元数据包含在 GetProperties 的响应中。 以下示例读取元数据值并将其写入控制台窗口：

func getContainerMetadata(client *azblob.Client, containerName string) {
    // Reference the container as a client object
    containerClient := client.ServiceClient().NewContainerClient(containerName)

    // Get the container properties, which includes metadata
    resp, err := containerClient.GetProperties(context.TODO(), nil)
    handleError(err)

    // Print the container metadata
    for k, v := range resp.Metadata {
        fmt.Printf("%v: %v\n", k, *v)
    }
}

注意

本指南中的代码示例旨在帮助你开始使用 Azure Blob 存储和 Go。 你应该修改错误处理和 Context 值以满足应用程序的需求。

资源

若要详细了解如何使用适用于 Go 的 Azure Blob 存储客户端模块设置和检索容器属性与元数据，请参阅以下资源。

代码示例

REST API 操作

Azure SDK for Go 包含基于 Azure REST API 而生成的库，允许你通过熟悉的 Go 范式来与 REST API 操作进行交互。 用于设置和检索属性和元数据的客户端库方法使用以下 REST API 操作：

get_container_properties 方法通过调用获取容器属性操作和获取容器元数据操作来检索容器属性和元数据。

客户端模块资源

相关内容

  • 本文是适用于 Go 的 Blob 存储开发人员指南的一部分。 若要了解详细信息，请参阅构建 Go 应用中的完整开发人员指南文章列表。