azure

Documentation

Overview

Package azure implements Azure Blob Storage.

Index

• func New(ctx context.Context, opt *Options, isCreate bool) (blob.Storage, error)
• type Options

Functions

func New

func New(ctx context.Context, opt *Options, isCreate bool) (blob.Storage, error)

New creates new Azure Blob Storage-backed storage with specified options:

- the 'Container', 'StorageAccount' and 'StorageKey' fields are required and all other parameters are optional.

Types

type Options

type Options struct {
	// Container is the name of the azure storage container where data is stored.
	Container string `json:"container"`

	// Prefix specifies additional string to prepend to all objects.
	Prefix string `json:"prefix,omitempty"`

	// Storage account name
	StorageAccount string `json:"storageAccount,omitempty"`

	// Storage account access key
	StorageKey string `json:"storageKey,omitempty" kopia:"sensitive"`

	// Alternatively provide SAS Token
	SASToken string `json:"sasToken,omitempty" kopia:"sensitive"`

	// the tenant-ID/client-ID/client-Secret of the service principal
	TenantID     string `json:",omitempty"`
	ClientID     string `json:",omitempty"`
	ClientSecret string `json:",omitempty" kopia:"sensitive"`

	// ClientCertificate are used for creating ClientCertificateCredentials
	ClientCertificate string `json:"clientCertificate,omitempty" kopia:"sensitive"`

	// AzureFederatedTokenFile is the path to a file containing an Azure Federated Token.
	AzureFederatedTokenFile string `json:"azureFederatedTokenFile,omitempty"`

	StorageDomain string `json:"storageDomain,omitempty"`

	throttling.Limits

	// PointInTime specifies a view of the (versioned) store at that time
	PointInTime *time.Time `json:"pointInTime,omitempty"`
}

Options defines options for Azure blob storage storage.