Hantera containeregenskaper och metadata med Go

Artikel
06/13/2024

Blobcontainrar stöder systemegenskaper och användardefinierade metadata, utöver de data som de innehåller. Den här artikeln visar hur du hanterar systemegenskaper och användardefinierade metadata med Azure Storage-klientmodulen för Go.

Förutsättningar

Azure-prenumeration – skapa en kostnadsfritt
Azure Storage-konto – skapa ett lagringskonto
Gå 1.18+

Konfigurera din miljö

Om du inte har ett befintligt projekt visar det här avsnittet hur du konfigurerar ett projekt så att det fungerar med Azure Blob Storage-klientmodulen för Go. Stegen omfattar modulinstallation, tillägg av import sökvägar och skapande av ett auktoriserat klientobjekt. Mer information finns i Komma igång med Azure Blob Storage och Go.

Installera moduler

Installera azblob-modulen med följande kommando:

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

Om du vill autentisera med Microsoft Entra-ID (rekommenderas) installerar du modulen azidentity med följande kommando:

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

Lägga till importsökvägar

Lägg till följande importsökvägar i kodfilen:

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

Vissa kodexempel i den här artikeln kan kräva ytterligare importsökvägar. Specifik information och exempelanvändning finns i Kodexempel.

Skapa ett klientobjekt

Om du vill ansluta en app till Blob Storage skapar du ett klientobjekt med azblob . NewClient. I följande exempel visas hur du skapar ett klientobjekt med hjälp av DefaultAzureCredential för auktorisering:

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
}

Auktorisering

Auktoriseringsmekanismen måste ha de behörigheter som krävs för att fungera med containeregenskaper eller metadata. För auktorisering med Microsoft Entra-ID (rekommenderas) behöver du den inbyggda Rollen Storage Blob Data Reader eller senare för get-åtgärderna och Storage Blob Data Contributor eller senare för de angivna åtgärderna. Mer information finns i auktoriseringsvägledningen för Get Container Properties (REST API), Set Container Metadata (REST API) eller Get Container Metadata (REST API).

Om egenskaper och metadata

Systemegenskaper: Systemegenskaper finns på varje Blob Storage-resurs. Vissa av dem kan läsas eller ställas in, medan andra är skrivskyddade. I bakgrunden motsvarar vissa systemegenskaper vissa STANDARD HTTP-huvuden. Azure Storage-klientbiblioteket för Go underhåller dessa egenskaper åt dig.
Användardefinierade metadata: Användardefinierade metadata består av ett eller flera namn/värde-par som du anger för en Blob Storage-resurs. Du kan använda metadata för att lagra ytterligare värden med resursen. Metadatavärden är endast för dina egna syften och påverkar inte hur resursen beter sig.

Metadatanamn/värdepar är giltiga HTTP-huvuden och bör följa alla begränsningar som styr HTTP-huvuden. Mer information om namngivningskrav för metadata finns i Metadatanamn.

Hämta containeregenskaper

Om du vill hämta containeregenskaper anropar du följande metod från ett containerklientobjekt:

GetProperties

I följande kodexempel hämtas en containers systemegenskaper och några av egenskapsvärdena skrivs till ett konsolfönster:

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)
}

Ange och hämta metadata

Du kan ange metadata som ett eller flera namn/värde-par på en blob- eller containerresurs. Om du vill ange metadata anropar du följande metod från ett containerklientobjekt:

SetMetadata

Om du anger containermetadata skrivs alla befintliga metadata som är associerade med containern över. Det går inte att ändra ett enskilt namn/värde-par.

I följande kodexempel anges metadata på en container:

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)
}

Om du vill hämta metadata anropar du följande metod från ett containerklientobjekt:

GetProperties

Metadata ingår i svaret från GetProperties. Följande exempel läser i metadatavärden och skriver dem till ett konsolfönster:

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)
    }
}

Kommentar

Kodexemplen i den här guiden är avsedda att hjälpa dig att komma igång med Azure Blob Storage och Go. Du bör ändra felhantering och Context värden för att uppfylla programmets behov.

Resurser

Mer information om hur du ställer in och hämtar containeregenskaper och metadata med hjälp av Azure Blob Storage-klientmodulen för Go finns i följande resurser.

Kodexempel

Visa kodexempel från den här artikeln (GitHub)

REST API-åtgärder

Azure SDK för Go innehåller bibliotek som bygger på Azure REST API så att du kan interagera med REST API-åtgärder via välbekanta Go-paradigm. Klientbiblioteksmetoderna för att ange och hämta egenskaper och metadata använder följande REST API-åtgärder:

Metoden get_container_properties hämtar containeregenskaper och metadata genom att anropa både åtgärden Hämta containeregenskaper och åtgärden Hämta containermetadata .

Dela via