# README
Azure Storage SDK for Go (Preview)
:exclamation: IMPORTANT: This package is in maintenance only and will be deprecated in the future. Please use one of the following packages instead.
| Service | Import Path/Repo |
|---|---|
| Storage - Blobs | github.com/Azure/azure-sdk-for-go/sdk/storage/azblob |
| Storage - Files | github.com/Azure/azure-storage-file-go |
| Storage - Queues | github.com/Azure/azure-storage-queue-go |
| Storage - Tables | github.com/Azure/azure-sdk-for-go/sdk/data/aztables |
The github.com/Azure/azure-sdk-for-go/storage package is used to manage
Azure Storage data plane
resources: containers, blobs, tables, and queues.
To manage storage accounts use Azure Resource Manager (ARM) via the packages at github.com/Azure/azure-sdk-for-go/services/storage.
This package also supports the Azure Storage Emulator (Windows only).
# Functions
GetContainerReferenceFromSASURI returns a Container object for the specified container SASURI.
IsValidCosmosAccount checks if the Cosmos account name is valid.
IsValidStorageAccount checks if the storage account name is valid.
NewAccountSASClient contructs a client that uses accountSAS authorization for its operations.
NewAccountSASClientFromEndpointToken constructs a client that uses accountSAS authorization for its operations using the specified endpoint and SAS token.
NewBasicClient constructs a Client with given storage service name and key.
NewBasicClientOnSovereignCloud constructs a Client with given storage service name and key in the referenced cloud.
NewClient constructs a Client.
NewClientFromConnectionString creates a Client from the connection string.
NewCosmosClient constructs a Client for Azure CosmosDB.
NewEmulatorClient contructs a Client intended to only work with AzureStorage Emulator.
# Constants
Types of page blobs.
Types of page blobs.
Types of page blobs.
Filters for listing blocks in block blobs.
Filters for listing blocks in block blobs.
Filters for listing blocks in block blobs.
List of statuses that can be used to refer to a block in a block list.
List of statuses that can be used to refer to a block in a block list.
List of statuses that can be used to refer to a block in a block list.
ContainerAccessHeader references header used when setting/getting container ACL.
Access options for containers.
Access options for containers.
Access options for containers.
DefaultAPIVersion is the Azure Storage API version string used when a basic client is created.
DefaultBaseURL is the domain name used for storage requests in the public cloud when a default client is created.
consts for batch operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
consts for batch operations.
consts for batch operations.
consts for batch operations.
Maximum sizes (per REST API) for various concepts.
Maximum sizes (per REST API) for various concepts.
MaxFileSize defines the maximum size in bytes for a file.
MaxRangeSize defines the maximum size in bytes for a file range.
consts for batch operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
This consts are meant to help with Odata supported operations.
consts for batch operations.
Options for sequence number action.
Options for sequence number action.
Options for sequence number action.
StorageEmulatorAccountKey is the the fixed storage account used by Azure Storage Emulator.
StorageEmulatorAccountName is the fixed storage account used by Azure Storage Emulator.
# Structs
AbortCopyOptions includes the options for an abort blob operation.
AccessPolicy is the response type from the GetPermissions call.
AccessPolicyDetailsXML has specifics about an access policy annotated with XML details.
AccountSASTokenOptions includes options for constructing an account SAS token.
AppendBlockOptions includes the options for an append block operation.
AzureStorageServiceError contains fields of the error response from Azure Storage Service REST API.
AzureTablesServiceError contains fields of the error response from Azure Table Storage Service REST API in Atom format.
BatchEntity used for tracking Entities to operate on and whether operations (replace/merge etc) should be forced.
A Blob is an entry in BlobListResponse.
BlobListResponse contains the response fields from ListBlobs call.
BlobProperties contains various properties of a blob returned in various endpoints like ListBlobs or GetBlobProperties.
BlobRange represents the bytes range to be get.
BlobSASOptions are options to construct a blob SAS URI.
BlobServiceSASPermissions includes the available permissions for blob service SAS URI.
BlobStorageClient contains operations for Microsoft Azure Blob Storage Service.
Block is used to create Block entities for Put Block List call.
BlockListResponse contains the response fields from Get Block List call.
BlockResponse contains the block information returned in the GetBlockListCall.
Client is the object that needs to be constructed to perform operations on the storage account.
Container represents an Azure container.
ContainerAccessPolicy represents each access policy in the container ACL.
ContainerListResponse contains the response fields from ListContainers call.
ContainerMetadataOptions includes options for container metadata operations.
ContainerPermissions represents the container ACLs.
ContainerProperties contains various properties of a container returned from various endpoints like ListContainers.
ContainerSASOptions are options to construct a container SAS URI.
ContainerSASPermissions includes the available permissions for a container SAS URI.
CopyOptions includes the options for a copy blob operation.
CopyOptionsConditions includes some conditional options in a copy blob operation.
Cors includes all the CORS rules.
CorsRule includes all settings for a Cors rule.
CreateContainerOptions includes the options for a create container operation.
DefaultSender is the default sender for the client.
DeleteBlobOptions includes the options for a delete blob operation.
DeleteContainerOptions includes options for a delete container operation.
Directory represents a directory on a share.
DirectoryProperties contains various properties of a directory.
DirsAndFilesListResponse contains the response fields from a List Files and Directories call.
Entity represents an entity inside an Azure table.
EntityOptions includes options for entity operations.
EntityQueryResult contains the response from ExecuteQuery and ExecuteQueryNextResults functions.
File represents a file on a share.
FileCopyState contains various properties of a file copy operation.
FileProperties contains various properties of a file.
FileRange contains range information for a file.
FileRanges contains a list of file range information for a file.
FileRequestOptions will be passed to misc file operations.
FileServiceClient contains operations for Microsoft Azure File Service.
FileStream contains file data returned from a call to GetFile.
GetBlobMetadataOptions includes the options for a get blob metadata operation.
GetBlobOptions includes the options for a get blob operation.
GetBlobPropertiesOptions includes the options for a get blob properties operation.
GetBlobRangeOptions includes the options for a get blob range operation.
GetBlockListOptions includes the options for a get block list operation.
GetContainerPermissionOptions includes options for a get container permissions operation.
GetEntityOptions includes options for a get entity operation.
GetFileOptions includes options for a get file operation.
GetMessagesOptions is the set of options can be specified for Get Messsages operation.
GetPageRangesOptions includes the options for a get page ranges operation.
GetPageRangesResponse contains the response fields from Get Page Ranges call.
GetQueuePermissionOptions includes options for a get queue permissions operation.
IncludeBlobDataset has options to include in a list blobs operation.
IncrementalCopyOptions includes the options for an incremental copy blob operation.
IncrementalCopyOptionsConditions includes some conditional options in a copy blob operation.
LeaseOptions includes options for all operations regarding leasing blobs.
ListBlobsParameters defines the set of customizable parameters to make a List Blobs call.
ListContainersParameters defines the set of customizable parameters to make a List Containers call.
ListDirsAndFilesParameters defines the set of customizable parameters to make a List Files and Directories call.
ListRangesOptions includes options for a list file ranges operation.
ListSharesParameters defines the set of customizable parameters to make a List Shares call.
Logging represents the Azure Analytics Logging settings.
Message represents an Azure message.
Metrics provide request statistics.
OverrideHeaders defines overridable response heaedrs in a request using a SAS URI.
PageRange contains information about a page of a page blob from Get Pages Range call.
PeekMessagesOptions is the set of options can be specified for Peek Messsage operation.
Permissions specifies permissions for an accountSAS.
PutBlobOptions includes the options any put blob operation (page, block, append).
PutBlockFromURLOptions includes the options for a put block from URL operation.
PutBlockListOptions includes the options for a put block list operation.
PutBlockOptions includes the options for a put block operation.
PutMessageOptions is the set of options can be specified for Put Messsage operation.
PutPageOptions includes the options for a put page operation.
QueryNextLink includes information for getting the next page of results in query operations.
QueryOptions includes options for a query entities operation.
QueryTablesOptions includes options for some table operations.
Queue represents an Azure queue.
QueueAccessPolicy represents each access policy in the queue ACL.
QueuePermissions represents the queue ACLs.
QueueSASOptions are options to construct a blob SAS URI.
QueueSASPermissions includes the available permissions for a queue SAS URI.
QueueServiceClient contains operations for Microsoft Azure Queue Storage Service.
QueueServiceOptions includes options for some queue service operations.
ResourceTypes specify the resources accesible with an account SAS.
RetentionPolicy indicates if retention is enabled and for how many days.
SASOptions includes options used by SAS URIs for different services and resources.
ServiceProperties represents the storage account service properties.
Services specify services accessible with an account SAS.
SetBlobMetadataOptions includes the options for a set blob metadata operation.
SetBlobPropertiesOptions contains various properties of a blob and is an entry in SetProperties.
SetContainerPermissionOptions includes options for a set container permissions operation.
SetQueuePermissionOptions includes options for a set queue permissions operation.
Share represents an Azure file share.
ShareListResponse contains the response fields from ListShares call.
ShareProperties contains various properties of a share.
SignedIdentifier is a wrapper for a specific policy.
SignedIdentifiers part of the response from GetPermissions call.
SnapshotOptions includes the options for a snapshot blob operation.
StaticWebsite - The properties that enable an account to host a static website.
Table represents an Azure table.
TableAccessPolicy are used for SETTING table policies.
TableBatch stores all the entities that will be operated on during a batch process.
TableOptions includes options for some table operations.
TableQueryResult contains the response from QueryTables and QueryTablesNextResults functions.
TableServiceClient contains operations for Microsoft Azure Table Storage Service.
UnexpectedStatusCodeError is returned when a storage service responds with neither an error nor with an HTTP status code indicating success.
UpdateMessageOptions is the set of options can be specified for Update Messsage operation.
WriteRangeOptions includes options for a write file range operation.
# Interfaces
Sender sends a request.
# Type aliases
BlobMetadata is a set of custom name/value pairs.
BlobType defines the type of the Azure Blob.
BlockListType is used to filter out types of blocks in a Get Blocks List call for a block blob.
BlockStatus defines states a block for a block blob can be in.
ContainerAccessType defines the access level to the container from a public request.
MetadataLevel determines if operations should return a paylod, and it level of detail.
Operation type.
SequenceNumberAction defines how the blob's sequence number should be modified.
TimeRFC1123 is an alias for time.Time needed for custom Unmarshalling.